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 <!-- ##### STRUCT AtkDocument ##### -->
  26 <para>
  27 The AtkDocument structure does not contain any fields.
  28
  29
  30 </para>
  31
  32
  33 <!-- ##### SIGNAL AtkDocument::load-complete ##### -->
  34 <para>
  35 The 'load-complete' signal is emitted when a pending load of a static
  36 document has completed.  This signal is to be expected by ATK clients
  37 if and when AtkDocument implementors expose ATK_STATE_BUSY.  If the state
  38 of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY,
  39 it should be safe for clients to assume that the AtkDocument's static contents
  40 are fully loaded into the container.  (Dynamic document contents should
  41 be exposed via other signals.)
  42 </para>
  43
  44 @atkdocument: the object which received the signal.
  45
  46 <!-- ##### SIGNAL AtkDocument::load-stopped ##### -->
  47 <para>
  48 The 'load-stopped' signal is emitted when a pending load of document contents
  49 is cancelled, paused, or otherwise interrupted by the user or application
  50 logic.  It should not however be
  51 emitted while waiting for a resource (for instance while blocking on a file or
  52 network read) unless a user-significant timeout has occurred.
  53 </para>
  54
  55 @atkdocument: the object which received the signal.
  56
  57 <!-- ##### SIGNAL AtkDocument::reload ##### -->
  58 <para>
  59 The 'reload' signal is emitted when the contents of a document is refreshed
  60 from its source.  Once 'reload' has been emitted, a matching 'load-complete'
  61 or 'load-stopped' signal should follow, which clients may await before
  62 interrogating ATK for the latest document content.
  63 </para>
  64
  65 @atkdocument: the object which received the signal.
  66
  67 <!-- ##### FUNCTION atk_document_get_document_type ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @document:
  73 @Returns:
  74
  75
  76 <!-- ##### FUNCTION atk_document_get_document ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @document:
  82 @Returns:
  83
  84
  85 <!-- ##### FUNCTION atk_document_get_attribute_value ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @document:
  91 @attribute_name:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION atk_document_set_attribute_value ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @document:
 101 @attribute_name:
 102 @attribute_value:
 103 @Returns:
 104
 105
 106 <!-- ##### FUNCTION atk_document_get_attributes ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @document:
 112 @Returns:
 113
 114
 115 <!-- ##### FUNCTION atk_document_get_locale ##### -->
 116 <para>
 117
 118 </para>
 119
 120 @document:
 121 @Returns:
 122
 123