X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=atk%2Fatkstreamablecontent.c;h=571ca2b6a13ed2e5d89e3690c6acbdc4c6d572ea;hb=5bd4797eccfdc9edf03282b41481f296dc80b980;hp=7510245a1b9b0c3b36e10e867ceeac196add8a94;hpb=5b32dfd56cae1358e6382beeb3f99d9a590eef39;p=platform%2Fupstream%2Fatk.git diff --git a/atk/atkstreamablecontent.c b/atk/atkstreamablecontent.c old mode 100755 new mode 100644 index 7510245..571ca2b --- a/atk/atkstreamablecontent.c +++ b/atk/atkstreamablecontent.c @@ -17,8 +17,34 @@ * Boston, MA 02111-1307, USA. */ +#include "config.h" + #include "atkstreamablecontent.h" +/** + * SECTION:atkstreamablecontent + * @Short_description: The ATK interface which provides access to + * streamable content. + * @Title:AtkStreamableContent + * + * 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. + */ + GType atk_streamable_content_get_type (void) { @@ -70,10 +96,10 @@ atk_streamable_content_get_n_mime_types (AtkStreamableContent *streamable) * 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. * - * Returns : a gchar* representing the specified mime type; the caller + * Returns: a gchar* representing the specified mime type; the caller * should not free the character string. **/ -G_CONST_RETURN gchar* +const gchar* atk_streamable_content_get_mime_type (AtkStreamableContent *streamable, gint i) { @@ -97,8 +123,8 @@ atk_streamable_content_get_mime_type (AtkStreamableContent *streamable, * * Gets the content in the specified mime type. * - * Returns: A #GIOChannel which contains the content in the specified mime - * type. + * Returns: (transfer full): A #GIOChannel which contains the content in the + * specified mime type. **/ GIOChannel* atk_streamable_content_get_stream (AtkStreamableContent *streamable, @@ -132,12 +158,12 @@ atk_streamable_content_get_stream (AtkStreamableContent *streamable, * 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. * - * Returns: Returns a string representing a URI, or NULL if no corresponding URI - * can be constructed. + * Returns: (nullable): Returns a string representing a URI, or %NULL + * if no corresponding URI can be constructed. * * Since: 1.12 **/ -gchar* +const gchar* atk_streamable_content_get_uri (AtkStreamableContent *streamable, const gchar *mime_type) {