AtkStreamableContent

Name

AtkStreamableContent -- 

Synopsis



struct      AtkStreamableContent;
struct      AtkStreamableContentIface;
gint        atk_streamable_content_get_n_mime_types
                                            (AtkStreamableContent *streamable);
G_CONST_RETURN gchar* atk_streamable_content_get_mime_type
                                            (AtkStreamableContent *streamable,
                                             gint i);
GIOChannel* atk_streamable_content_get_stream
                                            (AtkStreamableContent *streamable,
                                             const gchar *mime_type);

Description

Details

struct AtkStreamableContent

struct AtkStreamableContent;


struct AtkStreamableContentIface

struct AtkStreamableContentIface
{
  GTypeInterface parent;

  /*
   * Get the number of mime types supported by this object
   */
  gint                      (* get_n_mime_types)  (AtkStreamableContent     *streamable);
  /*
   * Gets the specified mime type supported by this object.
   * The mime types are 0-based so the first mime type is 
   * at index 0, the second at index 1 and so on.
   *
   * This assumes that the strings for the mime types are stored in the
   * AtkStreamableContent. Alternatively the G_CONST_RETURN could be removed
   * and the caller would be responsible for calling g_free() on the
   * returned value.
   */
  G_CONST_RETURN gchar*     (* get_mime_type)     (AtkStreamableContent     *streamable,
                                                   gint                     i);
  /*
   * Is one possible implementation for this method that it constructs the
   * content appropriate for the mime type and then creates a temporary
   * file containing the content, opens the file and then calls
   * g_io_channel_unix_new_fd().
   */
  GIOChannel*               (* get_stream)        (AtkStreamableContent     *streamable,
                                                   const gchar              *mime_type);

  AtkFunction               pad1;
  AtkFunction               pad2;
  AtkFunction               pad3;
  AtkFunction               pad4;
};


atk_streamable_content_get_n_mime_types ()

gint        atk_streamable_content_get_n_mime_types
                                            (AtkStreamableContent *streamable);

Gets the number of mime types supported by this object.

streamable : a GObject instance that implements AtkStreamableContentIface
Returns : a gint which is the number of mime types supported by the object.


atk_streamable_content_get_mime_type ()

G_CONST_RETURN gchar* atk_streamable_content_get_mime_type
                                            (AtkStreamableContent *streamable,
                                             gint i);

Gets the character string of the specified mime type. The first mime type is at position 0, the second at position 1, and so on.

streamable : a GObject instance that implements AtkStreamableContent
i : a gint representing the position of the mime type starting from 0
Returns :: a gchar* representing the specified mime type; the caller should not free the character string.


atk_streamable_content_get_stream ()

GIOChannel* atk_streamable_content_get_stream
                                            (AtkStreamableContent *streamable,
                                             const gchar *mime_type);

Gets the content in the specified mime type.

streamable : a GObject instance that implements AtkStreamableContentIface
mime_type : a gchar* representing the mime type
Returns : A GIOChannel which contains the content in the specified mime type.