michael@0: /* ATK -  Accessibility Toolkit
michael@0:  * Copyright 2001 Sun Microsystems Inc.
michael@0:  *
michael@0:  * This library is free software; you can redistribute it and/or
michael@0:  * modify it under the terms of the GNU Library General Public
michael@0:  * License as published by the Free Software Foundation; either
michael@0:  * version 2 of the License, or (at your option) any later version.
michael@0:  *
michael@0:  * This library is distributed in the hope that it will be useful,
michael@0:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
michael@0:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
michael@0:  * Library General Public License for more details.
michael@0:  *
michael@0:  * You should have received a copy of the GNU Library General Public
michael@0:  * License along with this library; if not, write to the
michael@0:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
michael@0:  * Boston, MA 02111-1307, USA.
michael@0:  */
michael@0: 
michael@0: #ifndef __ATK_STREAMABLE_CONTENT_H__
michael@0: #define __ATK_STREAMABLE_CONTENT_H__
michael@0: 
michael@0: #include <atk/atkobject.h>
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: #define ATK_TYPE_STREAMABLE_CONTENT           (atk_streamable_content_get_type ())
michael@0: #define ATK_IS_STREAMABLE_CONTENT(obj)        G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_STREAMABLE_CONTENT)
michael@0: #define ATK_STREAMABLE_CONTENT(obj)           G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_STREAMABLE_CONTENT, AtkStreamableContent)
michael@0: #define ATK_STREAMABLE_CONTENT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_STREAMABLE_CONTENT, AtkStreamableContentIface))
michael@0: 
michael@0: #ifndef _TYPEDEF_ATK_STREAMABLE_CONTENT
michael@0: #define _TYPEDEF_ATK_STREAMABLE_CONTENT
michael@0: typedef struct _AtkStreamableContent AtkStreamableContent;
michael@0: #endif
michael@0: typedef struct _AtkStreamableContentIface AtkStreamableContentIface;
michael@0: 
michael@0: struct _AtkStreamableContentIface
michael@0: {
michael@0:   GTypeInterface parent;
michael@0: 
michael@0:   /*
michael@0:    * Get the number of mime types supported by this object
michael@0:    */
michael@0:   gint                      (* get_n_mime_types)  (AtkStreamableContent     *streamable);
michael@0:   /*
michael@0:    * Gets the specified mime type supported by this object.
michael@0:    * The mime types are 0-based so the first mime type is 
michael@0:    * at index 0, the second at index 1 and so on.  The mime-type
michael@0:    * at index 0 should be considered the "default" data type for the stream.
michael@0:    *
michael@0:    * This assumes that the strings for the mime types are stored in the
michael@0:    * AtkStreamableContent. Alternatively the G_CONST_RETURN could be removed
michael@0:    * and the caller would be responsible for calling g_free() on the
michael@0:    * returned value.
michael@0:    */
michael@0:   G_CONST_RETURN gchar*     (* get_mime_type)     (AtkStreamableContent     *streamable,
michael@0:                                                    gint                     i);
michael@0:   /*
michael@0:    * One possible implementation for this method is that it constructs the
michael@0:    * content appropriate for the mime type and then creates a temporary
michael@0:    * file containing the content, opens the file and then calls
michael@0:    * g_io_channel_unix_new_fd().
michael@0:    */
michael@0:   GIOChannel*               (* get_stream)        (AtkStreamableContent     *streamable,
michael@0:                                                    const gchar              *mime_type);
michael@0: 
michael@0: /*
michael@0:  * Returns a string representing a URI in IETF standard format
michael@0:  * (see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content
michael@0:  * may be streamed in the specified mime-type.
michael@0:  * If mime_type is NULL, the URI for the default (and possibly only) mime-type is
michael@0:  * returned.
michael@0:  *
michael@0:  * returns NULL if the mime-type is not supported, or if no URI can be 
michael@0:  * constructed.  Note that it is possible for get_uri to return NULL but for
michael@0:  * get_stream to work nonetheless, since not all GIOChannels connect to URIs.
michael@0:  */
michael@0:     G_CONST_RETURN  gchar*  (* get_uri)           (AtkStreamableContent     *streamable,
michael@0:                                                    const gchar              *mime_type);
michael@0: 
michael@0: 
michael@0:   AtkFunction               pad1;
michael@0:   AtkFunction               pad2;
michael@0:   AtkFunction               pad3;
michael@0: };
michael@0: GType                  atk_streamable_content_get_type (void);
michael@0: 
michael@0: gint                   atk_streamable_content_get_n_mime_types (AtkStreamableContent     *streamable);
michael@0:                                                        
michael@0: G_CONST_RETURN gchar*  atk_streamable_content_get_mime_type    (AtkStreamableContent     *streamable,
michael@0:                                                                 gint                     i);
michael@0: GIOChannel*             atk_streamable_content_get_stream       (AtkStreamableContent     *streamable,
michael@0:                                                                  const gchar              *mime_type);
michael@0: 
michael@0: gchar*                  atk_streamable_content_get_uri          (AtkStreamableContent     *streamable,
michael@0:                                                                  const gchar              *mime_type);
michael@0: 
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: }
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: 
michael@0: #endif /* __ATK_STREAMABLE_CONTENT_H__ */