docs/tmpl/atkstreamablecontent.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkStreamableContent
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The ATK interface which provides access to streamable content.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 An interface whereby an object allows its backing content to be streamed to
  10 clients.  Typical implementors would be images or icons, HTML content, or
  11 multimedia display/rendering widgets.
  12 </para>
  13 <para>
  14 Negotiation of content type is allowed. Clients may examine the backing data
  15 and transform, convert, or parse the content in order to present it in an alternate form to end-users.
  16 </para>
  17 <para>
  18 The AtkStreamableContent interface is particularly useful for saving,
  19 printing, or post-processing entire documents, or for persisting alternate
  20 views of a document. If document content itself is being serialized,
  21 stored, or converted, then use of the AtkStreamableContent interface can help
  22 address performance issues. Unlike most ATK interfaces,
  23 this interface is not strongly tied to the current user-agent view of the
  24 a particular document, but may in some cases give access to the underlying model data.
  25 </para>
  26
  27 <!-- ##### SECTION See_Also ##### -->
  28 <para>
  29
  30 </para>
  31
  32 <!-- ##### SECTION Stability_Level ##### -->
  33
  34
  35 <!-- ##### STRUCT AtkStreamableContent ##### -->
  36 <para>
  37 The AtkStreamableContent structure does not contain any fields.
  38
  39 </para>
  40
  41
  42 <!-- ##### FUNCTION atk_streamable_content_get_n_mime_types ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @streamable:
  48 @Returns:
  49
  50
  51 <!-- ##### FUNCTION atk_streamable_content_get_mime_type ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @streamable:
  57 @i:
  58 @Returns:
  59
  60
  61 <!-- ##### FUNCTION atk_streamable_content_get_stream ##### -->
  62 <para>
  63
  64 </para>
  65
  66 @streamable:
  67 @mime_type:
  68 @Returns:
  69
  70
  71 <!-- ##### FUNCTION atk_streamable_content_get_uri ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @streamable:
  77 @mime_type:
  78 @Returns:
  79
  80