<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "../xml/gtkdocentities.ent">
  %gtkdocentities;
]>
<refentry id="AtkStreamableContent">
<refmeta>
<refentrytitle role="top_of_page" id="AtkStreamableContent.top_of_page">AtkStreamableContent</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AtkStreamableContent</refname>
<refpurpose>The ATK interface which provides access to
streamable content.</refpurpose>
</refnamediv>

<refsect1 id="AtkStreamableContent.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="atk-streamable-content-get-n-mime-types">atk_streamable_content_get_n_mime_types</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-streamable-content-get-mime-type">atk_streamable_content_get_mime_type</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GIOChannel"><returnvalue>GIOChannel</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-streamable-content-get-stream">atk_streamable_content_get_stream</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="atk-streamable-content-get-uri">atk_streamable_content_get_uri</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkStreamableContent.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="AtkStreamableContent-struct">AtkStreamableContent</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AtkStreamableContent.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GInterface">GInterface</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> AtkStreamableContent
</screen>
</refsect1>


<refsect1 id="AtkStreamableContent.description" role="desc">
<title role="desc.title">Description</title>
<para>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.</para>
<para>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.</para>
<para>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.</para>

</refsect1>
<refsect1 id="AtkStreamableContent.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="atk-streamable-content-get-n-mime-types" role="function">
<title>atk_streamable_content_get_n_mime_types&#160;()</title>
<indexterm zone="atk-streamable-content-get-n-mime-types"><primary>atk_streamable_content_get_n_mime_types</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
atk_streamable_content_get_n_mime_types
                               (<parameter><link linkend="AtkStreamableContent"><type>AtkStreamableContent</type></link> *streamable</parameter>);</programlisting>
<para>Gets the number of mime types supported by this object.</para>
<refsect3 id="atk-streamable-content-get-n-mime-types.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>streamable</para></entry>
<entry role="parameter_description"><para>a GObject instance that implements AtkStreamableContentIface</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-streamable-content-get-n-mime-types.returns" role="returns">
<title>Returns</title>
<para> a gint which is the number of mime types supported by the object.</para>
</refsect3></refsect2>
<refsect2 id="atk-streamable-content-get-mime-type" role="function">
<title>atk_streamable_content_get_mime_type&#160;()</title>
<indexterm zone="atk-streamable-content-get-mime-type"><primary>atk_streamable_content_get_mime_type</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
atk_streamable_content_get_mime_type (<parameter><link linkend="AtkStreamableContent"><type>AtkStreamableContent</type></link> *streamable</parameter>,
                                      <parameter><link linkend="gint"><type>gint</type></link> i</parameter>);</programlisting>
<para>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.</para>
<refsect3 id="atk-streamable-content-get-mime-type.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>streamable</para></entry>
<entry role="parameter_description"><para>a GObject instance that implements AtkStreamableContent</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>i</para></entry>
<entry role="parameter_description"><para>a gint representing the position of the mime type starting from 0</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-streamable-content-get-mime-type.returns" role="returns">
<title>Returns</title>
<para> a gchar* representing the specified mime type; the caller
should not free the character string.</para>
</refsect3></refsect2>
<refsect2 id="atk-streamable-content-get-stream" role="function">
<title>atk_streamable_content_get_stream&#160;()</title>
<indexterm zone="atk-streamable-content-get-stream"><primary>atk_streamable_content_get_stream</primary></indexterm>
<programlisting language="C"><link linkend="GIOChannel"><returnvalue>GIOChannel</returnvalue></link>&#160;*
atk_streamable_content_get_stream (<parameter><link linkend="AtkStreamableContent"><type>AtkStreamableContent</type></link> *streamable</parameter>,
                                   <parameter>const <link linkend="gchar"><type>gchar</type></link> *mime_type</parameter>);</programlisting>
<para>Gets the content in the specified mime type.</para>
<refsect3 id="atk-streamable-content-get-stream.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>streamable</para></entry>
<entry role="parameter_description"><para>a GObject instance that implements AtkStreamableContentIface</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>mime_type</para></entry>
<entry role="parameter_description"><para>a gchar* representing the mime type</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-streamable-content-get-stream.returns" role="returns">
<title>Returns</title>
<para>A <link linkend="GIOChannel"><type>GIOChannel</type></link> which contains the content in the
specified mime type. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="atk-streamable-content-get-uri" role="function" condition="since:1.12">
<title>atk_streamable_content_get_uri&#160;()</title>
<indexterm zone="atk-streamable-content-get-uri" role="1.12"><primary>atk_streamable_content_get_uri</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
atk_streamable_content_get_uri (<parameter><link linkend="AtkStreamableContent"><type>AtkStreamableContent</type></link> *streamable</parameter>,
                                <parameter>const <link linkend="gchar"><type>gchar</type></link> *mime_type</parameter>);</programlisting>
<para>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. </para>
<para>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.</para>
<refsect3 id="atk-streamable-content-get-uri.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>streamable</para></entry>
<entry role="parameter_description"><para>a GObject instance that implements AtkStreamableContentIface</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>mime_type</para></entry>
<entry role="parameter_description"><para>a gchar* representing the mime type, or NULL to request a URI
for the default mime type.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="atk-streamable-content-get-uri.returns" role="returns">
<title>Returns</title>
<para>Returns a string representing a URI, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if no corresponding URI can be constructed. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.12">1.12</link></para></refsect2>

</refsect1>
<refsect1 id="AtkStreamableContent.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AtkStreamableContent-struct" role="struct">
<title>AtkStreamableContent</title>
<indexterm zone="AtkStreamableContent-struct"><primary>AtkStreamableContent</primary></indexterm>
<programlisting language="C">typedef struct _AtkStreamableContent AtkStreamableContent;</programlisting>
</refsect2>

</refsect1>

</refentry>
