Update Scottish Gaelic translation

[platform/upstream/atk.git] / atk / atkstreamablecontent.c

diff --git a/atk/atkstreamablecontent.c b/atk/atkstreamablecontent.c
old mode 100755 (executable)
new mode 100644 (file)
index 3d4bca3..571ca2b
--- a/atk/atkstreamablecontent.c
+++ b/atk/atkstreamablecontent.c
@@ -17,10 +17,36 @@
  * 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 ()
+atk_streamable_content_get_type (void)
 {
   static GType type = 0;
 
@@ -52,7 +78,6 @@ atk_streamable_content_get_n_mime_types (AtkStreamableContent *streamable)
 {
   AtkStreamableContentIface *iface;
 
-  g_return_val_if_fail (streamable != NULL, 0);
   g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (streamable), 0);
 
   iface = ATK_STREAMABLE_CONTENT_GET_IFACE (streamable);
@@ -71,16 +96,15 @@ 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)
 {
   AtkStreamableContentIface *iface;
 
-  g_return_val_if_fail (streamable != NULL, NULL);
   g_return_val_if_fail (i >= 0, NULL);
   g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (streamable), NULL);
 
@@ -99,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,
@@ -108,7 +132,6 @@ atk_streamable_content_get_stream (AtkStreamableContent *streamable,
 {
   AtkStreamableContentIface *iface;
 
-  g_return_val_if_fail (streamable != NULL, NULL);
   g_return_val_if_fail (mime_type != NULL, NULL);
   g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (streamable), NULL);
 
@@ -119,3 +142,40 @@ atk_streamable_content_get_stream (AtkStreamableContent *streamable,
   else
     return NULL;
 }
+
+/**
+ * atk_streamable_content_get_uri:
+ * @streamable: a GObject instance that implements AtkStreamableContentIface
+ * @mime_type: a gchar* representing the mime type, or NULL to request a URI 
+ * for the default mime type.
+ *
+ * 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.
+ *
+ * Returns: (nullable): Returns a string representing a URI, or %NULL
+ * if no corresponding URI can be constructed.
+ *
+ * Since: 1.12
+ **/
+const gchar*
+atk_streamable_content_get_uri (AtkStreamableContent *streamable,
+                               const gchar          *mime_type)
+{
+  AtkStreamableContentIface *iface;
+
+  g_return_val_if_fail (mime_type != NULL, NULL);
+  g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (streamable), NULL);
+
+  iface = ATK_STREAMABLE_CONTENT_GET_IFACE (streamable);
+
+  if (iface->get_uri)
+    return (iface->get_uri) (streamable, mime_type);
+  else
+    return NULL;
+}