GI.Atk.Interfaces.StreamableContent

The ATK interface which provides access to streamable content.

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.

Exported types

newtype StreamableContent

Memory-managed wrapper type.

Constructors

StreamableContent (ManagedPtr StreamableContent)

Instances

Eq StreamableContent

Defined in GI.Atk.Interfaces.StreamableContent

Methods

(==) :: StreamableContent -> StreamableContent -> Bool

(/=) :: StreamableContent -> StreamableContent -> Bool

BoxedPtr StreamableContent

Defined in GI.Atk.Interfaces.StreamableContent

Methods

boxedPtrCopy :: StreamableContent -> IO StreamableContent

boxedPtrFree :: StreamableContent -> IO ()

ManagedPtrNewtype StreamableContent

Defined in GI.Atk.Interfaces.StreamableContent

Methods

toManagedPtr :: StreamableContent -> ManagedPtr StreamableContent

class (ManagedPtrNewtype o, IsDescendantOf StreamableContent o) => IsStreamableContent o

Type class for types which implement StreamableContent.

Instances

(ManagedPtrNewtype o, IsDescendantOf StreamableContent o) => IsStreamableContent o

Defined in GI.Atk.Interfaces.StreamableContent

Methods

Click to display all available methods, including inherited ones

Methods

None.

Getters

getMimeType, getNMimeTypes, getStream, getUri.

Setters

None.

getMimeType

streamableContentGetMimeType

Arguments

:: (HasCallStack, MonadIO m, IsStreamableContent a)

=> a

streamable: a GObject instance that implements AtkStreamableContent

-> Int32

i: a gint representing the position of the mime type starting from 0

-> m Text

Returns: a gchar* representing the specified mime type; the caller should not free the character string.

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.

getNMimeTypes

streamableContentGetNMimeTypes

Arguments

:: (HasCallStack, MonadIO m, IsStreamableContent a)

=> a

streamable: a GObject instance that implements AtkStreamableContentIface

-> m Int32

Returns: a gint which is the number of mime types supported by the object.

Gets the number of mime types supported by this object.

getStream

streamableContentGetStream

Arguments

:: (HasCallStack, MonadIO m, IsStreamableContent a)

=> a

streamable: a GObject instance that implements AtkStreamableContentIface

-> Text

mimeType: a gchar* representing the mime type

-> m IOChannel

Returns: A IOChannel which contains the content in the specified mime type.

Gets the content in the specified mime type.

getUri

streamableContentGetUri

Arguments

:: (HasCallStack, MonadIO m, IsStreamableContent a)

=> a

streamable: a GObject instance that implements AtkStreamableContentIface

-> Text

mimeType: a gchar* representing the mime type, or NULL to request a URI for the default mime type.

-> m (Maybe Text)

Returns: Returns a string representing a URI, or Nothing if no corresponding URI can be constructed.

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.

Note that it is possible for get_uri to return NULL but for get_stream to work nonetheless, since not all GIOChannels connect to URIs.

Since: 1.12