Interface

AtkStreamableContent

Description [src]

interface Atk.StreamableContent : GObject.Object

An interface whereby an object allows its backing content to be streamed to clients. Typical implementors would be images or icons, HTML content, or multimedia display/rendering widgets.

Negotiation of content type is allowed. Clients may examine the backing data and transform, convert, or parse the content in order to present it in an alternate form to end-users.

The AtkStreamableContent interface is particularly useful for saving, printing, or post-processing entire documents, or for persisting alternate views of a document. If document content itself is being serialized, stored, or converted, then use of the AtkStreamableContent interface can help address performance issues. Unlike most ATK interfaces, this interface is not strongly tied to the current user-agent view of the a particular document, but may in some cases give access to the underlying model data.

Prerequisite

In order to implement StreamableContent, your type must inherit from GObject.

Instance methods

atk_streamable_content_get_mime_type

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.

atk_streamable_content_get_n_mime_types

Gets the number of mime types supported by this object.

atk_streamable_content_get_stream

Gets the content in the specified mime type.

atk_streamable_content_get_uri

Get a string representing a URI in IETF standard format (see http://www.ietf.org/rfc/rfc2396.txt) from which the object’s content may be streamed in the specified mime-type, if one is available. If mime_type is NULL, the URI for the default (and possibly only) mime-type is returned.

Available since: 1.12

Interface structure

struct AtkStreamableContentIface {
  GTypeInterface parent;
  gint (* get_n_mime_types) (
    AtkStreamableContent* streamable
  );
  const gchar* (* get_mime_type) (
    AtkStreamableContent* streamable,
    gint i
  );
  GIOChannel* (* get_stream) (
    AtkStreamableContent* streamable,
    const gchar* mime_type
  );
  const gchar* (* get_uri) (
    AtkStreamableContent* streamable,
    const gchar* mime_type
  );
  AtkFunction pad1;
  AtkFunction pad2;
  AtkFunction pad3;
  
}
Interface members
parent
GTypeInterface
 No description available.
get_n_mime_types
gint (* get_n_mime_types) (
    AtkStreamableContent* streamable
  )
 No description available.
get_mime_type
const gchar* (* get_mime_type) (
    AtkStreamableContent* streamable,
    gint i
  )
 No description available.
get_stream
GIOChannel* (* get_stream) (
    AtkStreamableContent* streamable,
    const gchar* mime_type
  )
 No description available.
get_uri
const gchar* (* get_uri) (
    AtkStreamableContent* streamable,
    const gchar* mime_type
  )
 No description available.
pad1
AtkFunction
 No description available.
pad2
AtkFunction
 No description available.
pad3
AtkFunction
 No description available.

Virtual methods

Atk.StreamableContent.get_mime_type

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.

Atk.StreamableContent.get_n_mime_types

Gets the number of mime types supported by this object.

Atk.StreamableContent.get_stream

Gets the content in the specified mime type.

Atk.StreamableContent.get_uri

Get a string representing a URI in IETF standard format (see http://www.ietf.org/rfc/rfc2396.txt) from which the object’s content may be streamed in the specified mime-type, if one is available. If mime_type is NULL, the URI for the default (and possibly only) mime-type is returned.