StreamableContentProtocol

public protocol StreamableContentProtocol

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.

The StreamableContentProtocol protocol exposes the methods and properties of an underlying AtkStreamableContent instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see StreamableContent. Alternatively, use StreamableContentRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying AtkStreamableContent instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • streamable_content_ptr Default implementation

    Typed pointer to the underlying AtkStreamableContent instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the AtkStreamableContent instance.

    Declaration

    Swift

    var streamable_content_ptr: UnsafeMutablePointer<AtkStreamableContent>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to StreamableContentProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

StreamableContent Interface: StreamableContentProtocol extension (methods and fields)

  • getMimeType(i:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func getMimeType(i: Int) -> String!
    Show on GitHub
  • getNMimeTypes() Extension method

    Gets the number of mime types supported by this object.

    Declaration

    Swift

    @inlinable
func getNMimeTypes() -> Int
    Show on GitHub
  • getStream(mimeType:) Extension method

    Gets the content in the specified mime type.

    Declaration

    Swift

    @inlinable
func getStream(mimeType: UnsafePointer<gchar>!) -> GLib.IOChannelRef!
    Show on GitHub
  • getUri(mimeType:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func getUri(mimeType: UnsafePointer<gchar>!) -> String!
    Show on GitHub
  • nMimeTypes Extension method

    Gets the number of mime types supported by this object.

    Declaration

    Swift

    @inlinable
var nMimeTypes: Int { get }
    Show on GitHub