docs/tmpl/atkdocument.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkDocument
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The ATK interface which represents the toplevel container for document content.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The AtkDocument interface should be supported by any object whose content is a
  10 representation or view of a document.  The AtkDocument interface should appear
  11 on the toplevel container for the document content; however AtkDocument
  12 instances may be nested (i.e. an AtkDocument may be a descendant of another
  13 AtkDocument) in those cases where one document contains "embedded content"
  14 which can reasonably be considered a document in its own right.
  15 </para>
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18 <para>
  19
  20 </para>
  21
  22 <!-- ##### SECTION Stability_Level ##### -->
  23
  24
  25 <!-- ##### SECTION Image ##### -->
  26
  27
  28 <!-- ##### STRUCT AtkDocument ##### -->
  29 <para>
  30 The AtkDocument structure does not contain any fields.
  31
  32
  33 </para>
  34
  35
  36 <!-- ##### SIGNAL AtkDocument::load-complete ##### -->
  37 <para>
  38 The 'load-complete' signal is emitted when a pending load of a static
  39 document has completed.  This signal is to be expected by ATK clients
  40 if and when AtkDocument implementors expose ATK_STATE_BUSY.  If the state
  41 of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY,
  42 it should be safe for clients to assume that the AtkDocument's static contents
  43 are fully loaded into the container.  (Dynamic document contents should
  44 be exposed via other signals.)
  45 </para>
  46
  47 @atkdocument: the object which received the signal.
  48
  49 <!-- ##### SIGNAL AtkDocument::load-stopped ##### -->
  50 <para>
  51 The 'load-stopped' signal is emitted when a pending load of document contents
  52 is cancelled, paused, or otherwise interrupted by the user or application
  53 logic.  It should not however be
  54 emitted while waiting for a resource (for instance while blocking on a file or
  55 network read) unless a user-significant timeout has occurred.
  56 </para>
  57
  58 @atkdocument: the object which received the signal.
  59
  60 <!-- ##### SIGNAL AtkDocument::reload ##### -->
  61 <para>
  62 The 'reload' signal is emitted when the contents of a document is refreshed
  63 from its source.  Once 'reload' has been emitted, a matching 'load-complete'
  64 or 'load-stopped' signal should follow, which clients may await before
  65 interrogating ATK for the latest document content.
  66 </para>
  67
  68 @atkdocument: the object which received the signal.
  69
  70 <!-- ##### FUNCTION atk_document_get_document_type ##### -->
  71 <para>
  72
  73 </para>
  74
  75 @document:
  76 @Returns:
  77
  78
  79 <!-- ##### FUNCTION atk_document_get_document ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @document:
  85 @Returns:
  86
  87
  88 <!-- ##### FUNCTION atk_document_get_attribute_value ##### -->
  89 <para>
  90
  91 </para>
  92
  93 @document:
  94 @attribute_name:
  95 @Returns:
  96
  97
  98 <!-- ##### FUNCTION atk_document_set_attribute_value ##### -->
  99 <para>
 100
 101 </para>
 102
 103 @document:
 104 @attribute_name:
 105 @attribute_value:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION atk_document_get_attributes ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @document:
 115 @Returns:
 116
 117
 118 <!-- ##### FUNCTION atk_document_get_locale ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @document:
 124 @Returns:
 125
 126