atk/atkstreamablecontent.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __ATK_STREAMABLE_CONTENT_H__
  21 #define __ATK_STREAMABLE_CONTENT_H__
  22
  23 #include <atk/atkobject.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 #define ATK_TYPE_STREAMABLE_CONTENT           (atk_streamable_content_get_type ())
  30 #define ATK_IS_STREAMABLE_CONTENT(obj)        G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_STREAMABLE_CONTENT)
  31 #define ATK_STREAMABLE_CONTENT(obj)           G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_STREAMABLE_CONTENT, AtkStreamableContent)
  32 #define ATK_STREAMABLE_CONTENT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_STREAMABLE_CONTENT, AtkStreamableContentIface))
  33
  34 #ifndef _TYPEDEF_ATK_STREAMABLE_CONTENT
  35 #define _TYPEDEF_ATK_STREAMABLE_CONTENT
  36 typedef struct _AtkStreamableContent AtkStreamableContent;
  37 #endif
  38 typedef struct _AtkStreamableContentIface AtkStreamableContentIface;
  39
  40 struct _AtkStreamableContentIface
  41 {
  42   GTypeInterface parent;
  43
  44   /*
  45    * Get the number of mime types supported by this object
  46    */
  47   gint                      (* get_n_mime_types)  (AtkStreamableContent     *streamable);
  48   /*
  49    * Gets the specified mime type supported by this object.
  50    * The mime types are 0-based so the dirst mime type is
  51    * at index 0, the second at index 1 and so on.
  52    *
  53    * This assumes that the strings for the mime types are stored in the
  54    * AtkStreamableContent. Alternatively the G_CONST_RETURN could be removed
  55    * and the caller would be responsible for calling g_free() on the
  56    * returned value.
  57    */
  58   G_CONST_RETURN gchar*     (* get_mime_type)     (AtkStreamableContent     *streamable,
  59                                                    gint                     i);
  60   /*
  61    * Is one possible implementation for this method that it constructs the
  62    * content appropriate for the mime type and then creates a temporary
  63    * file containing the content, opens the file and then calls
  64    * g_io_channel_unix_new_fd().
  65    */
  66   GIOChannel*               (* get_stream)        (AtkStreamableContent     *streamable,
  67                                                    const gchar              *mime_type);
  68
  69 };
  70 GType                  atk_streamable_content_get_type (void);
  71
  72 gint                   atk_streamable_content_get_n_mime_types (AtkStreamableContent     *streamable);
  73
  74 G_CONST_RETURN gchar*  atk_streamable_content_get_mime_type    (AtkStreamableContent     *streamable,
  75                                                                 gint                     i);
  76 GIOChannel*             atk_streamable_content_get_stream       (AtkStreamableContent     *streamable,
  77                                                                  const gchar              *mime_type);
  78
  79
  80 #ifdef __cplusplus
  81 }
  82 #endif /* __cplusplus */
  83
  84
  85 #endif /* __ATK_STREAMABLE_CONTENT_H__ */