atk 2.2.0-x86-mingw32 → 2.2.1-x86-mingw32

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/Rakefile +1 -1
  3. data/lib/2.0/atk.so +0 -0
  4. data/vendor/local/bin/libatk-1.0-0.dll +0 -0
  5. data/vendor/local/include/atk-1.0/atk/atk-enum-types.h +16 -0
  6. data/vendor/local/include/atk-1.0/atk/atk.h +3 -0
  7. data/vendor/local/include/atk-1.0/atk/atkaction.h +8 -1
  8. data/vendor/local/include/atk-1.0/atk/atkcomponent.h +20 -2
  9. data/vendor/local/include/atk-1.0/atk/atkdocument.h +29 -2
  10. data/vendor/local/include/atk-1.0/atk/atkeditabletext.h +8 -0
  11. data/vendor/local/include/atk-1.0/atk/atkgobjectaccessible.h +3 -0
  12. data/vendor/local/include/atk-1.0/atk/atkhyperlink.h +9 -1
  13. data/vendor/local/include/atk-1.0/atk/atkhyperlinkimpl.h +2 -0
  14. data/vendor/local/include/atk-1.0/atk/atkhypertext.h +4 -0
  15. data/vendor/local/include/atk-1.0/atk/atkimage.h +6 -0
  16. data/vendor/local/include/atk-1.0/atk/atkmisc.h +19 -19
  17. data/vendor/local/include/atk-1.0/atk/atknoopobject.h +4 -0
  18. data/vendor/local/include/atk-1.0/atk/atknoopobjectfactory.h +2 -0
  19. data/vendor/local/include/atk-1.0/atk/atkobject.h +133 -26
  20. data/vendor/local/include/atk-1.0/atk/atkobjectfactory.h +5 -0
  21. data/vendor/local/include/atk-1.0/atk/atkplug.h +5 -0
  22. data/vendor/local/include/atk-1.0/atk/atkrange.h +59 -0
  23. data/vendor/local/include/atk-1.0/atk/atkregistry.h +5 -15
  24. data/vendor/local/include/atk-1.0/atk/atkrelation.h +10 -0
  25. data/vendor/local/include/atk-1.0/atk/atkrelationset.h +10 -0
  26. data/vendor/local/include/atk-1.0/atk/atkselection.h +8 -0
  27. data/vendor/local/include/atk-1.0/atk/atksocket.h +6 -0
  28. data/vendor/local/include/atk-1.0/atk/atkstate.h +14 -2
  29. data/vendor/local/include/atk-1.0/atk/atkstateset.h +12 -0
  30. data/vendor/local/include/atk-1.0/atk/atkstreamablecontent.h +6 -1
  31. data/vendor/local/include/atk-1.0/atk/atktable.h +30 -6
  32. data/vendor/local/include/atk-1.0/atk/atktablecell.h +104 -0
  33. data/vendor/local/include/atk-1.0/atk/atktext.h +30 -5
  34. data/vendor/local/include/atk-1.0/atk/atkutil.h +35 -4
  35. data/vendor/local/include/atk-1.0/atk/atkvalue.h +88 -17
  36. data/vendor/local/include/atk-1.0/atk/atkversion.h +281 -2
  37. data/vendor/local/include/atk-1.0/atk/atkwindow.h +1 -0
  38. data/vendor/local/lib/girepository-1.0/Atk-1.0.typelib +0 -0
  39. data/vendor/local/lib/libatk-1.0.dll.a +0 -0
  40. data/vendor/local/lib/libatk-1.0.la +3 -3
  41. data/vendor/local/lib/pkgconfig/atk.pc +1 -1
  42. data/vendor/local/share/gir-1.0/Atk-1.0.gir +3410 -899
  43. data/vendor/local/share/gtk-doc/html/atk/AtkAction.html +343 -233
  44. data/vendor/local/share/gtk-doc/html/atk/AtkComponent.html +872 -578
  45. data/vendor/local/share/gtk-doc/html/atk/AtkDocument.html +558 -251
  46. data/vendor/local/share/gtk-doc/html/atk/AtkEditableText.html +298 -192
  47. data/vendor/local/share/gtk-doc/html/atk/AtkGObjectAccessible.html +117 -75
  48. data/vendor/local/share/gtk-doc/html/atk/AtkHyperlink.html +434 -273
  49. data/vendor/local/share/gtk-doc/html/atk/AtkHypertext.html +195 -119
  50. data/vendor/local/share/gtk-doc/html/atk/AtkImage.html +224 -143
  51. data/vendor/local/share/gtk-doc/html/atk/AtkMisc.html +191 -0
  52. data/vendor/local/share/gtk-doc/html/atk/AtkNoOpObject.html +83 -59
  53. data/vendor/local/share/gtk-doc/html/atk/AtkNoOpObjectFactory.html +66 -49
  54. data/vendor/local/share/gtk-doc/html/atk/AtkObject.html +2398 -1337
  55. data/vendor/local/share/gtk-doc/html/atk/AtkObjectFactory.html +154 -96
  56. data/vendor/local/share/gtk-doc/html/atk/AtkRegistry.html +192 -118
  57. data/vendor/local/share/gtk-doc/html/atk/AtkRelation.html +496 -278
  58. data/vendor/local/share/gtk-doc/html/atk/AtkRelationSet.html +294 -193
  59. data/vendor/local/share/gtk-doc/html/atk/AtkSelection.html +333 -201
  60. data/vendor/local/share/gtk-doc/html/atk/AtkStateSet.html +403 -256
  61. data/vendor/local/share/gtk-doc/html/atk/AtkStreamableContent.html +192 -130
  62. data/vendor/local/share/gtk-doc/html/atk/AtkTable.html +1363 -776
  63. data/vendor/local/share/gtk-doc/html/atk/AtkTableCell.html +497 -0
  64. data/vendor/local/share/gtk-doc/html/atk/AtkText.html +1975 -1446
  65. data/vendor/local/share/gtk-doc/html/atk/AtkUtil.html +862 -524
  66. data/vendor/local/share/gtk-doc/html/atk/AtkValue.html +638 -108
  67. data/vendor/local/share/gtk-doc/html/atk/AtkWindow.html +302 -175
  68. data/vendor/local/share/gtk-doc/html/atk/accessibles.html +49 -0
  69. data/vendor/local/share/gtk-doc/html/atk/api-index-1-12.html +18 -18
  70. data/vendor/local/share/gtk-doc/html/atk/api-index-1-13.html +21 -11
  71. data/vendor/local/share/gtk-doc/html/atk/api-index-1-20.html +11 -11
  72. data/vendor/local/share/gtk-doc/html/atk/api-index-1-22.html +10 -10
  73. data/vendor/local/share/gtk-doc/html/atk/api-index-1-3.html +11 -11
  74. data/vendor/local/share/gtk-doc/html/atk/api-index-1-30.html +15 -15
  75. data/vendor/local/share/gtk-doc/html/atk/api-index-1-4.html +9 -9
  76. data/vendor/local/share/gtk-doc/html/atk/api-index-1-6.html +11 -11
  77. data/vendor/local/share/gtk-doc/html/atk/api-index-1-9.html +39 -0
  78. data/vendor/local/share/gtk-doc/html/atk/api-index-2-10.html +35 -0
  79. data/vendor/local/share/gtk-doc/html/atk/api-index-2-12.html +78 -0
  80. data/vendor/local/share/gtk-doc/html/atk/api-index-2-2.html +53 -0
  81. data/vendor/local/share/gtk-doc/html/atk/api-index-2-8.html +47 -0
  82. data/vendor/local/share/gtk-doc/html/atk/api-index-deprecated.html +75 -25
  83. data/vendor/local/share/gtk-doc/html/atk/api-index-full.html +358 -288
  84. data/vendor/local/share/gtk-doc/html/atk/atk-AtkHyperlinkImpl.html +82 -60
  85. data/vendor/local/share/gtk-doc/html/atk/atk-AtkPlug.html +99 -52
  86. data/vendor/local/share/gtk-doc/html/atk/atk-AtkRange.html +328 -0
  87. data/vendor/local/share/gtk-doc/html/atk/atk-AtkSocket.html +139 -91
  88. data/vendor/local/share/gtk-doc/html/atk/atk-AtkState.html +355 -226
  89. data/vendor/local/share/gtk-doc/html/atk/atk-Versioning-Utilities.html +203 -142
  90. data/vendor/local/share/gtk-doc/html/atk/atk.devhelp2 +378 -547
  91. data/vendor/local/share/gtk-doc/html/atk/atkobject.html +33 -0
  92. data/vendor/local/share/gtk-doc/html/atk/data.html +49 -0
  93. data/vendor/local/share/gtk-doc/html/atk/deprecated.html +33 -0
  94. data/vendor/local/share/gtk-doc/html/atk/index.html +70 -46
  95. data/vendor/local/share/gtk-doc/html/atk/index.sgml +419 -519
  96. data/vendor/local/share/gtk-doc/html/atk/{atk.html → interfaces.html} +17 -60
  97. data/vendor/local/share/gtk-doc/html/atk/overview.html +47 -0
  98. data/vendor/local/share/gtk-doc/html/atk/style.css +260 -105
  99. data/vendor/local/share/gtk-doc/html/atk/toolkit.html +33 -0
  100. data/vendor/local/share/gtk-doc/html/atk/utilities.html +28 -14
  101. data/vendor/local/share/license/atk/AUTHORS +18 -5
  102. data/vendor/local/share/locale/an/LC_MESSAGES/atk10.mo +0 -0
  103. data/vendor/local/share/locale/as/LC_MESSAGES/atk10.mo +0 -0
  104. data/vendor/local/share/locale/ca/LC_MESSAGES/atk10.mo +0 -0
  105. data/vendor/local/share/locale/ca@valencia/LC_MESSAGES/atk10.mo +0 -0
  106. data/vendor/local/share/locale/cs/LC_MESSAGES/atk10.mo +0 -0
  107. data/vendor/local/share/locale/da/LC_MESSAGES/atk10.mo +0 -0
  108. data/vendor/local/share/locale/de/LC_MESSAGES/atk10.mo +0 -0
  109. data/vendor/local/share/locale/el/LC_MESSAGES/atk10.mo +0 -0
  110. data/vendor/local/share/locale/es/LC_MESSAGES/atk10.mo +0 -0
  111. data/vendor/local/share/locale/eu/LC_MESSAGES/atk10.mo +0 -0
  112. data/vendor/local/share/locale/fi/LC_MESSAGES/atk10.mo +0 -0
  113. data/vendor/local/share/locale/fr/LC_MESSAGES/atk10.mo +0 -0
  114. data/vendor/local/share/locale/gl/LC_MESSAGES/atk10.mo +0 -0
  115. data/vendor/local/share/locale/he/LC_MESSAGES/atk10.mo +0 -0
  116. data/vendor/local/share/locale/hu/LC_MESSAGES/atk10.mo +0 -0
  117. data/vendor/local/share/locale/id/LC_MESSAGES/atk10.mo +0 -0
  118. data/vendor/local/share/locale/it/LC_MESSAGES/atk10.mo +0 -0
  119. data/vendor/local/share/locale/ko/LC_MESSAGES/atk10.mo +0 -0
  120. data/vendor/local/share/locale/lt/LC_MESSAGES/atk10.mo +0 -0
  121. data/vendor/local/share/locale/lv/LC_MESSAGES/atk10.mo +0 -0
  122. data/vendor/local/share/locale/nb/LC_MESSAGES/atk10.mo +0 -0
  123. data/vendor/local/share/locale/pa/LC_MESSAGES/atk10.mo +0 -0
  124. data/vendor/local/share/locale/pl/LC_MESSAGES/atk10.mo +0 -0
  125. data/vendor/local/share/locale/pt/LC_MESSAGES/atk10.mo +0 -0
  126. data/vendor/local/share/locale/pt_BR/LC_MESSAGES/atk10.mo +0 -0
  127. data/vendor/local/share/locale/ru/LC_MESSAGES/atk10.mo +0 -0
  128. data/vendor/local/share/locale/sk/LC_MESSAGES/atk10.mo +0 -0
  129. data/vendor/local/share/locale/sl/LC_MESSAGES/atk10.mo +0 -0
  130. data/vendor/local/share/locale/sr/LC_MESSAGES/atk10.mo +0 -0
  131. data/vendor/local/share/locale/sr@latin/LC_MESSAGES/atk10.mo +0 -0
  132. data/vendor/local/share/locale/zh_CN/LC_MESSAGES/atk10.mo +0 -0
  133. data/vendor/local/share/locale/zh_HK/LC_MESSAGES/atk10.mo +0 -0
  134. data/vendor/local/share/locale/zh_TW/LC_MESSAGES/atk10.mo +0 -0
  135. metadata +27 -19
  136. data/lib/1.9/atk.so +0 -0
  137. data/lib/2.1/atk.so +0 -0
  138. data/vendor/local/lib/atk-1.0.def +0 -248
  139. data/vendor/local/share/gtk-doc/html/atk/api-index-1-18.html +0 -31
  140. data/vendor/local/share/gtk-doc/html/atk/api-index-1-24.html +0 -31
  141. data/vendor/local/share/gtk-doc/html/atk/api-index-1-26.html +0 -31
  142. data/vendor/local/share/gtk-doc/html/atk/api-index-1-28.html +0 -31
  143. data/vendor/local/share/gtk-doc/html/atk/api-index-1-32.html +0 -30
data/vendor/local/share/gtk-doc/html/atk/AtkDocument.html CHANGED
@@ -2,30 +2,26 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
- <title>AtkDocument</title>
6
- <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
5
+ <title>ATK - Accessibility Toolkit: AtkDocument</title>
6
+ <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
  <link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
8
- <link rel="up" href="atk.html" title="ATK Library">
8
+ <link rel="up" href="interfaces.html" title="ATK Interfaces">
9
9
  <link rel="prev" href="AtkComponent.html" title="AtkComponent">
10
10
  <link rel="next" href="AtkEditableText.html" title="AtkEditableText">
11
- <meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
11
+ <meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
12
12
  <link rel="stylesheet" href="style.css" type="text/css">
13
13
  </head>
14
14
  <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
- <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
- <td width="100%" align="left">
17
- <a href="#" class="shortcut">Top</a>
18
-  | 
19
- <a href="#AtkDocument.description" class="shortcut">Description</a>
20
-  | 
21
- <a href="#AtkDocument.object-hierarchy" class="shortcut">Object Hierarchy</a>
22
-  | 
23
- <a href="#AtkDocument.implementations" class="shortcut">Known Implementations</a>
24
-  | 
25
- <a href="#AtkDocument.signals" class="shortcut">Signals</a>
15
+ <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
+ <td width="100%" align="left" class="shortcuts">
17
+ <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18
+ <a href="#AtkDocument.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19
+ <a href="#AtkDocument.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations">  <span class="dim">|</span> 
20
+ <a href="#AtkDocument.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals">  <span class="dim">|</span> 
21
+ <a href="#AtkDocument.signals" class="shortcut">Signals</a></span>
26
22
  </td>
27
23
  <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
28
- <td><a accesskey="u" href="atk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24
+ <td><a accesskey="u" href="interfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
29
25
  <td><a accesskey="p" href="AtkComponent.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
30
26
  <td><a accesskey="n" href="AtkEditableText.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
31
27
  </tr></table>
@@ -37,291 +33,534 @@
37
33
  <p>AtkDocument — The ATK interface which represents the toplevel
38
34
  container for document content.</p>
39
35
  </td>
40
- <td valign="top" align="right"></td>
36
+ <td class="gallery_image" valign="top" align="right"></td>
41
37
  </tr></table></div>
42
- <div class="refsynopsisdiv">
43
- <a name="AtkDocument.synopsis"></a><h2>Synopsis</h2>
44
- <pre class="synopsis"> <a class="link" href="AtkDocument.html#AtkDocument-struct" title="AtkDocument">AtkDocument</a>;
45
- struct <a class="link" href="AtkDocument.html#AtkDocumentIface" title="struct AtkDocumentIface">AtkDocumentIface</a>;
46
- const <span class="returnvalue">gchar</span> * <a class="link" href="AtkDocument.html#atk-document-get-document-type" title="atk_document_get_document_type ()">atk_document_get_document_type</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
47
- <span class="returnvalue">gpointer</span> <a class="link" href="AtkDocument.html#atk-document-get-document" title="atk_document_get_document ()">atk_document_get_document</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
48
- const <span class="returnvalue">gchar</span> * <a class="link" href="AtkDocument.html#atk-document-get-attribute-value" title="atk_document_get_attribute_value ()">atk_document_get_attribute_value</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
49
- <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>);
50
- <span class="returnvalue">gboolean</span> <a class="link" href="AtkDocument.html#atk-document-set-attribute-value" title="atk_document_set_attribute_value ()">atk_document_set_attribute_value</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
51
- <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>,
52
- <em class="parameter"><code>const <span class="type">gchar</span> *attribute_value</code></em>);
53
- <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> * <a class="link" href="AtkDocument.html#atk-document-get-attributes" title="atk_document_get_attributes ()">atk_document_get_attributes</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
54
- const <span class="returnvalue">gchar</span> * <a class="link" href="AtkDocument.html#atk-document-get-locale" title="atk_document_get_locale ()">atk_document_get_locale</a> (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);
55
- </pre>
56
- </div>
57
- <div class="refsect1">
58
- <a name="AtkDocument.object-hierarchy"></a><h2>Object Hierarchy</h2>
59
- <pre class="synopsis">
60
- GInterface
61
- +----AtkDocument
62
- </pre>
63
- </div>
64
- <div class="refsect1">
65
- <a name="AtkDocument.implementations"></a><h2>Known Implementations</h2>
66
- <p>
67
- AtkDocument is implemented by
68
- <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
69
- </div>
70
- <div class="refsect1">
71
- <a name="AtkDocument.signals"></a><h2>Signals</h2>
72
- <pre class="synopsis">
73
- "<a class="link" href="AtkDocument.html#AtkDocument-load-complete" title='The "load-complete" signal'>load-complete</a>" : <code class="literal">Run Last</code>
74
- "<a class="link" href="AtkDocument.html#AtkDocument-load-stopped" title='The "load-stopped" signal'>load-stopped</a>" : <code class="literal">Run Last</code>
75
- "<a class="link" href="AtkDocument.html#AtkDocument-reload" title='The "reload" signal'>reload</a>" : <code class="literal">Run Last</code>
76
- </pre>
77
- </div>
78
- <div class="refsect1">
79
- <a name="AtkDocument.description"></a><h2>Description</h2>
80
- <p>
81
- The AtkDocument interface should be supported by any object whose
82
- content is a representation or view of a document. The AtkDocument
83
- interface should appear on the toplevel container for the document
84
- content; however AtkDocument instances may be nested (i.e. an
85
- AtkDocument may be a descendant of another AtkDocument) in those
86
- cases where one document contains "embedded content" which can
87
- reasonably be considered a document in its own right.
88
- </p>
89
- </div>
90
38
  <div class="refsect1">
91
- <a name="AtkDocument.details"></a><h2>Details</h2>
92
- <div class="refsect2">
93
- <a name="AtkDocument-struct"></a><h3>AtkDocument</h3>
94
- <pre class="programlisting">typedef struct _AtkDocument AtkDocument;</pre>
95
- <p>
96
- </p>
97
- </div>
98
- <hr>
99
- <div class="refsect2">
100
- <a name="AtkDocumentIface"></a><h3>struct AtkDocumentIface</h3>
101
- <pre class="programlisting">struct AtkDocumentIface {
102
- GTypeInterface parent;
103
- const gchar* ( *get_document_type) (AtkDocument *document);
104
- gpointer ( *get_document) (AtkDocument *document);
105
-
106
- const gchar* ( *get_document_locale) (AtkDocument *document);
107
- AtkAttributeSet * ( *get_document_attributes) (AtkDocument *document);
108
- const gchar* ( *get_document_attribute_value) (AtkDocument *document,
109
- const gchar *attribute_name);
110
- gboolean ( *set_document_attribute) (AtkDocument *document,
111
- const gchar *attribute_name,
112
- const gchar *attribute_value);
113
- };
114
- </pre>
115
- <div class="variablelist"><table border="0">
116
- <col align="left" valign="top">
39
+ <a name="AtkDocument.functions"></a><h2>Functions</h2>
40
+ <div class="informaltable"><table width="100%" border="0">
41
+ <colgroup>
42
+ <col width="150px" class="functions_return">
43
+ <col class="functions_name">
44
+ </colgroup>
117
45
  <tbody>
118
46
  <tr>
119
- <td><p><span class="term"><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="AtkDocumentIface.parent"></a>parent</code></em>;</span></p></td>
120
- <td></td>
47
+ <td class="function_type">const <span class="returnvalue">gchar</span> *
48
+ </td>
49
+ <td class="function_name">
50
+ <a class="link" href="AtkDocument.html#atk-document-get-document-type" title="atk_document_get_document_type ()">atk_document_get_document_type</a> <span class="c_punctuation">()</span>
51
+ </td>
121
52
  </tr>
122
53
  <tr>
123
- <td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document-type"></a>get_document_type</code></em> ()</span></p></td>
124
- <td></td>
54
+ <td class="function_type">
55
+ <span class="returnvalue">gpointer</span>
56
+ </td>
57
+ <td class="function_name">
58
+ <a class="link" href="AtkDocument.html#atk-document-get-document" title="atk_document_get_document ()">atk_document_get_document</a> <span class="c_punctuation">()</span>
59
+ </td>
125
60
  </tr>
126
61
  <tr>
127
- <td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document"></a>get_document</code></em> ()</span></p></td>
128
- <td></td>
62
+ <td class="function_type">const <span class="returnvalue">gchar</span> *
63
+ </td>
64
+ <td class="function_name">
65
+ <a class="link" href="AtkDocument.html#atk-document-get-attribute-value" title="atk_document_get_attribute_value ()">atk_document_get_attribute_value</a> <span class="c_punctuation">()</span>
66
+ </td>
129
67
  </tr>
130
68
  <tr>
131
- <td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document-locale"></a>get_document_locale</code></em> ()</span></p></td>
132
- <td>gets locale. This virtual function is
133
- deprecated since 2.7.90 and it should not be overriden.</td>
69
+ <td class="function_type">
70
+ <span class="returnvalue">gboolean</span>
71
+ </td>
72
+ <td class="function_name">
73
+ <a class="link" href="AtkDocument.html#atk-document-set-attribute-value" title="atk_document_set_attribute_value ()">atk_document_set_attribute_value</a> <span class="c_punctuation">()</span>
74
+ </td>
134
75
  </tr>
135
76
  <tr>
136
- <td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document-attributes"></a>get_document_attributes</code></em> ()</span></p></td>
137
- <td></td>
77
+ <td class="function_type">
78
+ <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
79
+ </td>
80
+ <td class="function_name">
81
+ <a class="link" href="AtkDocument.html#atk-document-get-attributes" title="atk_document_get_attributes ()">atk_document_get_attributes</a> <span class="c_punctuation">()</span>
82
+ </td>
83
+ </tr>
84
+ <tr>
85
+ <td class="function_type">const <span class="returnvalue">gchar</span> *
86
+ </td>
87
+ <td class="function_name">
88
+ <a class="link" href="AtkDocument.html#atk-document-get-locale" title="atk_document_get_locale ()">atk_document_get_locale</a> <span class="c_punctuation">()</span>
89
+ </td>
138
90
  </tr>
139
91
  <tr>
140
- <td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.get-document-attribute-value"></a>get_document_attribute_value</code></em> ()</span></p></td>
141
- <td></td>
92
+ <td class="function_type">
93
+ <span class="returnvalue">gint</span>
94
+ </td>
95
+ <td class="function_name">
96
+ <a class="link" href="AtkDocument.html#atk-document-get-current-page-number" title="atk_document_get_current_page_number ()">atk_document_get_current_page_number</a> <span class="c_punctuation">()</span>
97
+ </td>
142
98
  </tr>
143
99
  <tr>
144
- <td><p><span class="term"><em class="structfield"><code><a name="AtkDocumentIface.set-document-attribute"></a>set_document_attribute</code></em> ()</span></p></td>
145
- <td></td>
100
+ <td class="function_type">
101
+ <span class="returnvalue">gint</span>
102
+ </td>
103
+ <td class="function_name">
104
+ <a class="link" href="AtkDocument.html#atk-document-get-page-count" title="atk_document_get_page_count ()">atk_document_get_page_count</a> <span class="c_punctuation">()</span>
105
+ </td>
146
106
  </tr>
147
107
  </tbody>
148
108
  </table></div>
149
109
  </div>
150
- <hr>
151
- <div class="refsect2">
152
- <a name="atk-document-get-document-type"></a><h3>atk_document_get_document_type ()</h3>
153
- <pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_document_get_document_type (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
154
- <p>
155
- Gets a string indicating the document type.
156
- </p>
157
- <div class="variablelist"><table border="0">
158
- <col align="left" valign="top">
110
+ <div class="refsect1">
111
+ <a name="AtkDocument.signals"></a><h2>Signals</h2>
112
+ <div class="informaltable"><table border="0">
113
+ <colgroup>
114
+ <col width="150px" class="signals_return">
115
+ <col width="300px" class="signals_name">
116
+ <col width="200px" class="signals_flags">
117
+ </colgroup>
159
118
  <tbody>
160
119
  <tr>
161
- <td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
162
- <td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
120
+ <td class="signal_type"><span class="returnvalue">void</span></td>
121
+ <td class="signal_name"><a class="link" href="AtkDocument.html#AtkDocument-load-complete" title="The “load-complete” signal">load-complete</a></td>
122
+ <td class="signal_flags">Run Last</td>
123
+ </tr>
124
+ <tr>
125
+ <td class="signal_type"><span class="returnvalue">void</span></td>
126
+ <td class="signal_name"><a class="link" href="AtkDocument.html#AtkDocument-load-stopped" title="The “load-stopped” signal">load-stopped</a></td>
127
+ <td class="signal_flags">Run Last</td>
128
+ </tr>
129
+ <tr>
130
+ <td class="signal_type"><span class="returnvalue">void</span></td>
131
+ <td class="signal_name"><a class="link" href="AtkDocument.html#AtkDocument-page-changed" title="The “page-changed” signal">page-changed</a></td>
132
+ <td class="signal_flags">Run Last</td>
163
133
  </tr>
164
134
  <tr>
165
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
166
- <td>a string indicating the document type</td>
135
+ <td class="signal_type"><span class="returnvalue">void</span></td>
136
+ <td class="signal_name"><a class="link" href="AtkDocument.html#AtkDocument-reload" title="The “reload” signal">reload</a></td>
137
+ <td class="signal_flags">Run Last</td>
167
138
  </tr>
168
139
  </tbody>
169
140
  </table></div>
170
141
  </div>
171
- <hr>
172
- <div class="refsect2">
173
- <a name="atk-document-get-document"></a><h3>atk_document_get_document ()</h3>
174
- <pre class="programlisting"><span class="returnvalue">gpointer</span> atk_document_get_document (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
175
- <p>
176
- Gets a <code class="literal">gpointer</code> that points to an instance of the DOM. It is
177
- up to the caller to check atk_document_get_type to determine
178
- how to cast this pointer.
179
- </p>
180
- <div class="variablelist"><table border="0">
181
- <col align="left" valign="top">
142
+ <div class="refsect1">
143
+ <a name="AtkDocument.other"></a><h2>Types and Values</h2>
144
+ <div class="informaltable"><table width="100%" border="0">
145
+ <colgroup>
146
+ <col width="150px" class="name">
147
+ <col class="description">
148
+ </colgroup>
182
149
  <tbody>
183
150
  <tr>
184
- <td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
185
- <td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
151
+ <td class="datatype_keyword"> </td>
152
+ <td class="function_name"><a class="link" href="AtkDocument.html#AtkDocument-struct" title="AtkDocument">AtkDocument</a></td>
186
153
  </tr>
187
154
  <tr>
188
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
189
- <td>a <code class="literal">gpointer</code> that points to an instance of the DOM. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
190
- </td>
155
+ <td class="datatype_keyword">struct</td>
156
+ <td class="function_name"><a class="link" href="AtkDocument.html#AtkDocumentIface" title="struct AtkDocumentIface">AtkDocumentIface</a></td>
191
157
  </tr>
192
158
  </tbody>
193
159
  </table></div>
194
160
  </div>
161
+ <div class="refsect1">
162
+ <a name="AtkDocument.object-hierarchy"></a><h2>Object Hierarchy</h2>
163
+ <pre class="screen"> GInterface
164
+ <span class="lineart">╰──</span> AtkDocument
165
+ </pre>
166
+ </div>
167
+ <div class="refsect1">
168
+ <a name="AtkDocument.implementations"></a><h2>Known Implementations</h2>
169
+ <p>
170
+ AtkDocument is implemented by
171
+ <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
172
+ </div>
173
+ <div class="refsect1">
174
+ <a name="AtkDocument.description"></a><h2>Description</h2>
175
+ <p>The AtkDocument interface should be supported by any object whose
176
+ content is a representation or view of a document. The AtkDocument
177
+ interface should appear on the toplevel container for the document
178
+ content; however AtkDocument instances may be nested (i.e. an
179
+ AtkDocument may be a descendant of another AtkDocument) in those
180
+ cases where one document contains "embedded content" which can
181
+ reasonably be considered a document in its own right.</p>
182
+ </div>
183
+ <div class="refsect1">
184
+ <a name="AtkDocument.functions_details"></a><h2>Functions</h2>
185
+ <div class="refsect2">
186
+ <a name="atk-document-get-document-type"></a><h3>atk_document_get_document_type ()</h3>
187
+ <pre class="programlisting">const <span class="returnvalue">gchar</span> *
188
+ atk_document_get_document_type (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
189
+ <div class="warning">
190
+ <p><code class="literal">atk_document_get_document_type</code> is deprecated and should not be used in newly-written code.</p>
191
+ <p>Since 2.12. Please use <a class="link" href="AtkDocument.html#atk-document-get-attributes" title="atk_document_get_attributes ()"><code class="function">atk_document_get_attributes()</code></a> to
192
+ ask for the document type if it applies.</p>
193
+ </div>
194
+ <p>Gets a string indicating the document type.</p>
195
+ <div class="refsect3">
196
+ <a name="id-1.5.4.9.2.6"></a><h4>Parameters</h4>
197
+ <div class="informaltable"><table width="100%" border="0">
198
+ <colgroup>
199
+ <col width="150px" class="parameters_name">
200
+ <col class="parameters_description">
201
+ <col width="200px" class="parameters_annotations">
202
+ </colgroup>
203
+ <tbody><tr>
204
+ <td class="parameter_name"><p>document</p></td>
205
+ <td class="parameter_description"><p>a <span class="type">GObject</span> instance that implements AtkDocumentIface</p></td>
206
+ <td class="parameter_annotations"> </td>
207
+ </tr></tbody>
208
+ </table></div>
209
+ </div>
210
+ <div class="refsect3">
211
+ <a name="id-1.5.4.9.2.7"></a><h4>Returns</h4>
212
+ <p> a string indicating the document type</p>
213
+ <p></p>
214
+ </div>
215
+ </div>
216
+ <hr>
217
+ <div class="refsect2">
218
+ <a name="atk-document-get-document"></a><h3>atk_document_get_document ()</h3>
219
+ <pre class="programlisting"><span class="returnvalue">gpointer</span>
220
+ atk_document_get_document (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
221
+ <div class="warning">
222
+ <p><code class="literal">atk_document_get_document</code> is deprecated and should not be used in newly-written code.</p>
223
+ <p>Since 2.12. <em class="parameter"><code>document</code></em>
224
+ is already a representation of
225
+ the document. Use it directly, or one of his children, as an
226
+ instance of the DOM.</p>
227
+ </div>
228
+ <p>Gets a <code class="literal">gpointer</code> that points to an instance of the DOM. It is
229
+ up to the caller to check atk_document_get_type to determine
230
+ how to cast this pointer.</p>
231
+ <div class="refsect3">
232
+ <a name="id-1.5.4.9.3.6"></a><h4>Parameters</h4>
233
+ <div class="informaltable"><table width="100%" border="0">
234
+ <colgroup>
235
+ <col width="150px" class="parameters_name">
236
+ <col class="parameters_description">
237
+ <col width="200px" class="parameters_annotations">
238
+ </colgroup>
239
+ <tbody><tr>
240
+ <td class="parameter_name"><p>document</p></td>
241
+ <td class="parameter_description"><p>a <span class="type">GObject</span> instance that implements AtkDocumentIface</p></td>
242
+ <td class="parameter_annotations"> </td>
243
+ </tr></tbody>
244
+ </table></div>
245
+ </div>
246
+ <div class="refsect3">
247
+ <a name="id-1.5.4.9.3.7"></a><h4>Returns</h4>
248
+ <p> a <code class="literal">gpointer</code> that points to an instance of the DOM. </p>
249
+ <p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
250
+ </div>
251
+ </div>
195
252
  <hr>
196
253
  <div class="refsect2">
197
- <a name="atk-document-get-attribute-value"></a><h3>atk_document_get_attribute_value ()</h3>
198
- <pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_document_get_attribute_value (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
199
- <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>);</pre>
200
- <div class="variablelist"><table border="0">
201
- <col align="left" valign="top">
254
+ <a name="atk-document-get-attribute-value"></a><h3>atk_document_get_attribute_value ()</h3>
255
+ <pre class="programlisting">const <span class="returnvalue">gchar</span> *
256
+ atk_document_get_attribute_value (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
257
+ <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>);</pre>
258
+ <div class="refsect3">
259
+ <a name="id-1.5.4.9.4.4"></a><h4>Parameters</h4>
260
+ <div class="informaltable"><table width="100%" border="0">
261
+ <colgroup>
262
+ <col width="150px" class="parameters_name">
263
+ <col class="parameters_description">
264
+ <col width="200px" class="parameters_annotations">
265
+ </colgroup>
202
266
  <tbody>
203
267
  <tr>
204
- <td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
205
- <td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
206
- </tr>
207
- <tr>
208
- <td><p><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></p></td>
209
- <td>a character string representing the name of the attribute
210
- whose value is being queried.</td>
268
+ <td class="parameter_name"><p>document</p></td>
269
+ <td class="parameter_description"><p>a <span class="type">GObject</span> instance that implements AtkDocumentIface</p></td>
270
+ <td class="parameter_annotations"> </td>
211
271
  </tr>
212
272
  <tr>
213
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
214
- <td>a string value associated with the named attribute for this
215
- document, or NULL if a value for <span class="type">attribute_name</span> has not been specified
216
- for this document.
217
- Virtual: get_document_attribute_value</td>
273
+ <td class="parameter_name"><p>attribute_name</p></td>
274
+ <td class="parameter_description"><p>a character string representing the name of the attribute
275
+ whose value is being queried.</p></td>
276
+ <td class="parameter_annotations"> </td>
218
277
  </tr>
219
278
  </tbody>
220
279
  </table></div>
280
+ </div>
281
+ <div class="refsect3">
282
+ <a name="id-1.5.4.9.4.5"></a><h4>Returns</h4>
283
+ <p> a string value associated with the named
284
+ attribute for this document, or NULL if a value for
285
+ <span class="type">attribute_name</span> has not been specified for this document. </p>
286
+ <p><span class="annotation">[<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>]</span></p>
287
+ </div>
221
288
  <p class="since">Since 1.12</p>
222
289
  </div>
223
290
  <hr>
224
291
  <div class="refsect2">
225
- <a name="atk-document-set-attribute-value"></a><h3>atk_document_set_attribute_value ()</h3>
226
- <pre class="programlisting"><span class="returnvalue">gboolean</span> atk_document_set_attribute_value (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
227
- <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>,
228
- <em class="parameter"><code>const <span class="type">gchar</span> *attribute_value</code></em>);</pre>
229
- <div class="variablelist"><table border="0">
230
- <col align="left" valign="top">
292
+ <a name="atk-document-set-attribute-value"></a><h3>atk_document_set_attribute_value ()</h3>
293
+ <pre class="programlisting"><span class="returnvalue">gboolean</span>
294
+ atk_document_set_attribute_value (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>,
295
+ <em class="parameter"><code>const <span class="type">gchar</span> *attribute_name</code></em>,
296
+ <em class="parameter"><code>const <span class="type">gchar</span> *attribute_value</code></em>);</pre>
297
+ <div class="refsect3">
298
+ <a name="id-1.5.4.9.5.4"></a><h4>Parameters</h4>
299
+ <div class="informaltable"><table width="100%" border="0">
300
+ <colgroup>
301
+ <col width="150px" class="parameters_name">
302
+ <col class="parameters_description">
303
+ <col width="200px" class="parameters_annotations">
304
+ </colgroup>
231
305
  <tbody>
232
306
  <tr>
233
- <td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
234
- <td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
235
- </tr>
236
- <tr>
237
- <td><p><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></p></td>
238
- <td>a character string representing the name of the attribute
239
- whose value is being set.</td>
307
+ <td class="parameter_name"><p>document</p></td>
308
+ <td class="parameter_description"><p>a <span class="type">GObject</span> instance that implements AtkDocumentIface</p></td>
309
+ <td class="parameter_annotations"> </td>
240
310
  </tr>
241
311
  <tr>
242
- <td><p><span class="term"><em class="parameter"><code>attribute_value</code></em> :</span></p></td>
243
- <td>a string value to be associated with <span class="type">attribute_name</span>.</td>
312
+ <td class="parameter_name"><p>attribute_name</p></td>
313
+ <td class="parameter_description"><p>a character string representing the name of the attribute
314
+ whose value is being set.</p></td>
315
+ <td class="parameter_annotations"> </td>
244
316
  </tr>
245
317
  <tr>
246
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
247
- <td>TRUE if <span class="type">value</span> is successfully associated with <span class="type">attribute_name</span>
248
- for this document, FALSE otherwise (e.g. if the document does not
249
- allow the attribute to be modified).
250
- Virtual: set_document_attribute</td>
318
+ <td class="parameter_name"><p>attribute_value</p></td>
319
+ <td class="parameter_description"><p>a string value to be associated with <span class="type">attribute_name</span>.</p></td>
320
+ <td class="parameter_annotations"> </td>
251
321
  </tr>
252
322
  </tbody>
253
323
  </table></div>
324
+ </div>
325
+ <div class="refsect3">
326
+ <a name="id-1.5.4.9.5.5"></a><h4>Returns</h4>
327
+ <p> TRUE if <span class="type">value</span> is successfully associated with <span class="type">attribute_name</span>
328
+ for this document, FALSE otherwise (e.g. if the document does not
329
+ allow the attribute to be modified).</p>
330
+ <p></p>
331
+ </div>
254
332
  <p class="since">Since 1.12</p>
255
333
  </div>
256
334
  <hr>
257
335
  <div class="refsect2">
258
- <a name="atk-document-get-attributes"></a><h3>atk_document_get_attributes ()</h3>
259
- <pre class="programlisting"><a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> * atk_document_get_attributes (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
260
- <p>
261
- Gets an AtkAttributeSet which describes document-wide
262
- attributes as name-value pairs.
263
- </p>
264
- <div class="variablelist"><table border="0">
265
- <col align="left" valign="top">
266
- <tbody>
267
- <tr>
268
- <td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
269
- <td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
270
- </tr>
271
- <tr>
272
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
273
- <td>An AtkAttributeSet containing the explicitly
274
- set name-value-pair attributes associated with this document
275
- as a whole.
276
- Virtual: get_document_attributes. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
277
- </td>
278
- </tr>
279
- </tbody>
336
+ <a name="atk-document-get-attributes"></a><h3>atk_document_get_attributes ()</h3>
337
+ <pre class="programlisting"><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
338
+ atk_document_get_attributes (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
339
+ <p>Gets an AtkAttributeSet which describes document-wide
340
+ attributes as name-value pairs.</p>
341
+ <div class="refsect3">
342
+ <a name="id-1.5.4.9.6.5"></a><h4>Parameters</h4>
343
+ <div class="informaltable"><table width="100%" border="0">
344
+ <colgroup>
345
+ <col width="150px" class="parameters_name">
346
+ <col class="parameters_description">
347
+ <col width="200px" class="parameters_annotations">
348
+ </colgroup>
349
+ <tbody><tr>
350
+ <td class="parameter_name"><p>document</p></td>
351
+ <td class="parameter_description"><p>a <span class="type">GObject</span> instance that implements AtkDocumentIface</p></td>
352
+ <td class="parameter_annotations"> </td>
353
+ </tr></tbody>
280
354
  </table></div>
355
+ </div>
356
+ <div class="refsect3">
357
+ <a name="id-1.5.4.9.6.6"></a><h4>Returns</h4>
358
+ <p> An AtkAttributeSet containing the explicitly
359
+ set name-value-pair attributes associated with this document
360
+ as a whole. </p>
361
+ <p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
362
+ </div>
281
363
  <p class="since">Since 1.12</p>
282
364
  </div>
283
365
  <hr>
284
366
  <div class="refsect2">
285
- <a name="atk-document-get-locale"></a><h3>atk_document_get_locale ()</h3>
286
- <pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_document_get_locale (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
367
+ <a name="atk-document-get-locale"></a><h3>atk_document_get_locale ()</h3>
368
+ <pre class="programlisting">const <span class="returnvalue">gchar</span> *
369
+ atk_document_get_locale (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
287
370
  <div class="warning">
288
- <h3 class="title">Warning</h3>
289
- <p><code class="literal">atk_document_get_locale</code> is deprecated and should not be used in newly-written code. This method is deprecated since ATK version
290
- 2.7.90. Please use <a class="link" href="AtkObject.html#atk-object-get-object-locale" title="atk_object_get_object_locale ()"><code class="function">atk_object_get_object_locale()</code></a> instead.</p>
371
+ <p><code class="literal">atk_document_get_locale</code> is deprecated and should not be used in newly-written code.</p>
372
+ <p>This method is deprecated since ATK version
373
+ 2.7.90. Please use <a class="link" href="AtkObject.html#atk-object-get-object-locale" title="atk_object_get_object_locale ()"><code class="function">atk_object_get_object_locale()</code></a> instead.</p>
291
374
  </div>
292
- <p>
293
- Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
375
+ <p>Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
294
376
  of the content of this document instance. Individual
295
377
  text substrings or images within this document may have
296
378
  a different locale, see atk_text_get_attributes and
297
- atk_image_get_image_locale.
379
+ atk_image_get_image_locale.</p>
380
+ <div class="refsect3">
381
+ <a name="id-1.5.4.9.7.6"></a><h4>Parameters</h4>
382
+ <div class="informaltable"><table width="100%" border="0">
383
+ <colgroup>
384
+ <col width="150px" class="parameters_name">
385
+ <col class="parameters_description">
386
+ <col width="200px" class="parameters_annotations">
387
+ </colgroup>
388
+ <tbody><tr>
389
+ <td class="parameter_name"><p>document</p></td>
390
+ <td class="parameter_description"><p>a <span class="type">GObject</span> instance that implements AtkDocumentIface</p></td>
391
+ <td class="parameter_annotations"> </td>
392
+ </tr></tbody>
393
+ </table></div>
394
+ </div>
395
+ <div class="refsect3">
396
+ <a name="id-1.5.4.9.7.7"></a><h4>Returns</h4>
397
+ <p> a UTF-8 string indicating the POSIX-style LC_MESSAGES
398
+ locale of the document content as a whole, or NULL if
399
+ the document content does not specify a locale.</p>
400
+ <p></p>
401
+ </div>
402
+ </div>
403
+ <hr>
404
+ <div class="refsect2">
405
+ <a name="atk-document-get-current-page-number"></a><h3>atk_document_get_current_page_number ()</h3>
406
+ <pre class="programlisting"><span class="returnvalue">gint</span>
407
+ atk_document_get_current_page_number (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
408
+ <div class="refsect3">
409
+ <a name="id-1.5.4.9.8.4"></a><h4>Parameters</h4>
410
+ <div class="informaltable"><table width="100%" border="0">
411
+ <colgroup>
412
+ <col width="150px" class="parameters_name">
413
+ <col class="parameters_description">
414
+ <col width="200px" class="parameters_annotations">
415
+ </colgroup>
416
+ <tbody><tr>
417
+ <td class="parameter_name"><p>document</p></td>
418
+ <td class="parameter_description"><p>the <a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a></p></td>
419
+ <td class="parameter_annotations"> </td>
420
+ </tr></tbody>
421
+ </table></div>
422
+ </div>
423
+ <div class="refsect3">
424
+ <a name="id-1.5.4.9.8.5"></a><h4>Returns</h4>
425
+ <p> current page number inside <em class="parameter"><code>document</code></em>
426
+ . -1 if not
427
+ implemented, not know by the implementor or irrelevant.</p>
428
+ <p></p>
429
+ </div>
430
+ <p class="since">Since 2.12</p>
431
+ </div>
432
+ <hr>
433
+ <div class="refsect2">
434
+ <a name="atk-document-get-page-count"></a><h3>atk_document_get_page_count ()</h3>
435
+ <pre class="programlisting"><span class="returnvalue">gint</span>
436
+ atk_document_get_page_count (<em class="parameter"><code><a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *document</code></em>);</pre>
437
+ <div class="refsect3">
438
+ <a name="id-1.5.4.9.9.4"></a><h4>Parameters</h4>
439
+ <div class="informaltable"><table width="100%" border="0">
440
+ <colgroup>
441
+ <col width="150px" class="parameters_name">
442
+ <col class="parameters_description">
443
+ <col width="200px" class="parameters_annotations">
444
+ </colgroup>
445
+ <tbody><tr>
446
+ <td class="parameter_name"><p>document</p></td>
447
+ <td class="parameter_description"><p>the <a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a></p></td>
448
+ <td class="parameter_annotations"> </td>
449
+ </tr></tbody>
450
+ </table></div>
451
+ </div>
452
+ <div class="refsect3">
453
+ <a name="id-1.5.4.9.9.5"></a><h4>Returns</h4>
454
+ <p> total page count of <em class="parameter"><code>document</code></em>
455
+ . -1 if not implemented, not
456
+ know by the implementor or irrelevant.</p>
457
+ <p></p>
458
+ </div>
459
+ <p class="since">Since 2.12</p>
460
+ </div>
461
+ </div>
462
+ <div class="refsect1">
463
+ <a name="AtkDocument.other_details"></a><h2>Types and Values</h2>
464
+ <div class="refsect2">
465
+ <a name="AtkDocument-struct"></a><h3>AtkDocument</h3>
466
+ <pre class="programlisting">typedef struct _AtkDocument AtkDocument;</pre>
467
+ <p>
298
468
  </p>
299
- <div class="variablelist"><table border="0">
300
- <col align="left" valign="top">
469
+ </div>
470
+ <hr>
471
+ <div class="refsect2">
472
+ <a name="AtkDocumentIface"></a><h3>struct AtkDocumentIface</h3>
473
+ <pre class="programlisting">struct AtkDocumentIface {
474
+ GTypeInterface parent;
475
+ const gchar* ( *get_document_type) (AtkDocument *document);
476
+ gpointer ( *get_document) (AtkDocument *document);
477
+
478
+ const gchar* ( *get_document_locale) (AtkDocument *document);
479
+ AtkAttributeSet * ( *get_document_attributes) (AtkDocument *document);
480
+ const gchar* ( *get_document_attribute_value) (AtkDocument *document,
481
+ const gchar *attribute_name);
482
+ gboolean ( *set_document_attribute) (AtkDocument *document,
483
+ const gchar *attribute_name,
484
+ const gchar *attribute_value);
485
+ gint ( *get_current_page_number) (AtkDocument *document);
486
+ gint ( *get_page_count) (AtkDocument *document);
487
+ };
488
+ </pre>
489
+ <div class="refsect3">
490
+ <a name="id-1.5.4.10.3.4"></a><h4>Members</h4>
491
+ <div class="informaltable"><table width="100%" border="0">
492
+ <colgroup>
493
+ <col width="300px" class="struct_members_name">
494
+ <col class="struct_members_description">
495
+ <col width="200px" class="struct_members_annotations">
496
+ </colgroup>
301
497
  <tbody>
302
498
  <tr>
303
- <td><p><span class="term"><em class="parameter"><code>document</code></em> :</span></p></td>
304
- <td>a <span class="type">GObject</span> instance that implements AtkDocumentIface</td>
499
+ <td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="AtkDocumentIface.parent"></a>parent</code></em>;</p></td>
500
+ <td class="struct_member_description"> </td>
501
+ <td class="struct_member_annotations"> </td>
305
502
  </tr>
306
503
  <tr>
307
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
308
- <td>a UTF-8 string indicating the POSIX-style LC_MESSAGES
309
- locale of the document content as a whole, or NULL if
310
- the document content does not specify a locale.
311
- Virtual: get_document_locale</td>
504
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkDocumentIface.get-document-type"></a>get_document_type</code></em> ()</p></td>
505
+ <td class="struct_member_description"><p>gets a string indicating the document
506
+ type. This virtual function is deprecated since 2.12 and it
507
+ should not be overriden.</p></td>
508
+ <td class="struct_member_annotations"> </td>
509
+ </tr>
510
+ <tr>
511
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkDocumentIface.get-document"></a>get_document</code></em> ()</p></td>
512
+ <td class="struct_member_description"><p>a <span class="type">GObject</span> instance that implements
513
+ AtkDocumentIface. This virtual method is deprecated since 2.12
514
+ and it should not be overriden.</p></td>
515
+ <td class="struct_member_annotations"> </td>
516
+ </tr>
517
+ <tr>
518
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkDocumentIface.get-document-locale"></a>get_document_locale</code></em> ()</p></td>
519
+ <td class="struct_member_description"><p>gets locale. This virtual function is
520
+ deprecated since 2.7.90 and it should not be overriden.</p></td>
521
+ <td class="struct_member_annotations"> </td>
522
+ </tr>
523
+ <tr>
524
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkDocumentIface.get-document-attributes"></a>get_document_attributes</code></em> ()</p></td>
525
+ <td class="struct_member_description"><p>gets an AtkAttributeSet which describes
526
+ document-wide attributes as name-value pairs.</p></td>
527
+ <td class="struct_member_annotations"> </td>
528
+ </tr>
529
+ <tr>
530
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkDocumentIface.get-document-attribute-value"></a>get_document_attribute_value</code></em> ()</p></td>
531
+ <td class="struct_member_description"><p>returns a string value assocciated
532
+ with the named attribute for this document, or NULL</p></td>
533
+ <td class="struct_member_annotations"> </td>
534
+ </tr>
535
+ <tr>
536
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkDocumentIface.set-document-attribute"></a>set_document_attribute</code></em> ()</p></td>
537
+ <td class="struct_member_description"><p>sets the value of an attribute. Returns
538
+ TRUE on success, FALSE otherwise</p></td>
539
+ <td class="struct_member_annotations"> </td>
540
+ </tr>
541
+ <tr>
542
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkDocumentIface.get-current-page-number"></a>get_current_page_number</code></em> ()</p></td>
543
+ <td class="struct_member_description"><p>gets the current page number. Since 2.12</p></td>
544
+ <td class="struct_member_annotations"> </td>
545
+ </tr>
546
+ <tr>
547
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkDocumentIface.get-page-count"></a>get_page_count</code></em> ()</p></td>
548
+ <td class="struct_member_description"><p>gets the page count of the document. Since 2.12</p></td>
549
+ <td class="struct_member_annotations"> </td>
312
550
  </tr>
313
551
  </tbody>
314
552
  </table></div>
315
553
  </div>
316
554
  </div>
555
+ </div>
317
556
  <div class="refsect1">
318
557
  <a name="AtkDocument.signal-details"></a><h2>Signal Details</h2>
319
558
  <div class="refsect2">
320
- <a name="AtkDocument-load-complete"></a><h3>The <code class="literal">"load-complete"</code> signal</h3>
321
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
322
- <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
323
- <p>
324
- The 'load-complete' signal is emitted when a pending load of
559
+ <a name="AtkDocument-load-complete"></a><h3>The <code class="literal">“load-complete”</code> signal</h3>
560
+ <pre class="programlisting"><span class="returnvalue">void</span>
561
+ user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
562
+ <span class="type">gpointer</span> user_data)</pre>
563
+ <p>The 'load-complete' signal is emitted when a pending load of
325
564
  a static document has completed. This signal is to be
326
565
  expected by ATK clients if and when AtkDocument implementors
327
566
  expose ATK_STATE_BUSY. If the state of an AtkObject which
@@ -329,79 +568,147 @@ implements AtkDocument does not include ATK_STATE_BUSY, it
329
568
  should be safe for clients to assume that the AtkDocument's
330
569
  static contents are fully loaded into the container.
331
570
  (Dynamic document contents should be exposed via other
332
- signals.)
333
- </p>
334
- <div class="variablelist"><table border="0">
335
- <col align="left" valign="top">
571
+ signals.)</p>
572
+ <div class="refsect3">
573
+ <a name="id-1.5.4.11.2.5"></a><h4>Parameters</h4>
574
+ <div class="informaltable"><table width="100%" border="0">
575
+ <colgroup>
576
+ <col width="150px" class="parameters_name">
577
+ <col class="parameters_description">
578
+ <col width="200px" class="parameters_annotations">
579
+ </colgroup>
336
580
  <tbody>
337
581
  <tr>
338
- <td><p><span class="term"><em class="parameter"><code>atkdocument</code></em> :</span></p></td>
339
- <td>the object which received the signal.</td>
582
+ <td class="parameter_name"><p>atkdocument</p></td>
583
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
584
+ <td class="parameter_annotations"> </td>
340
585
  </tr>
341
586
  <tr>
342
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
343
- <td>user data set when the signal handler was connected.</td>
587
+ <td class="parameter_name"><p>user_data</p></td>
588
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
589
+ <td class="parameter_annotations"> </td>
344
590
  </tr>
345
591
  </tbody>
346
592
  </table></div>
347
593
  </div>
594
+ <p>Flags: Run Last</p>
595
+ </div>
348
596
  <hr>
349
597
  <div class="refsect2">
350
- <a name="AtkDocument-load-stopped"></a><h3>The <code class="literal">"load-stopped"</code> signal</h3>
351
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
352
- <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
353
- <p>
354
- The 'load-stopped' signal is emitted when a pending load of
598
+ <a name="AtkDocument-load-stopped"></a><h3>The <code class="literal">“load-stopped”</code> signal</h3>
599
+ <pre class="programlisting"><span class="returnvalue">void</span>
600
+ user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
601
+ <span class="type">gpointer</span> user_data)</pre>
602
+ <p>The 'load-stopped' signal is emitted when a pending load of
355
603
  document contents is cancelled, paused, or otherwise
356
604
  interrupted by the user or application logic. It should not
357
605
  however be emitted while waiting for a resource (for instance
358
606
  while blocking on a file or network read) unless a
359
- user-significant timeout has occurred.
360
- </p>
361
- <div class="variablelist"><table border="0">
362
- <col align="left" valign="top">
607
+ user-significant timeout has occurred.</p>
608
+ <div class="refsect3">
609
+ <a name="id-1.5.4.11.3.5"></a><h4>Parameters</h4>
610
+ <div class="informaltable"><table width="100%" border="0">
611
+ <colgroup>
612
+ <col width="150px" class="parameters_name">
613
+ <col class="parameters_description">
614
+ <col width="200px" class="parameters_annotations">
615
+ </colgroup>
363
616
  <tbody>
364
617
  <tr>
365
- <td><p><span class="term"><em class="parameter"><code>atkdocument</code></em> :</span></p></td>
366
- <td>the object which received the signal.</td>
618
+ <td class="parameter_name"><p>atkdocument</p></td>
619
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
620
+ <td class="parameter_annotations"> </td>
367
621
  </tr>
368
622
  <tr>
369
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
370
- <td>user data set when the signal handler was connected.</td>
623
+ <td class="parameter_name"><p>user_data</p></td>
624
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
625
+ <td class="parameter_annotations"> </td>
371
626
  </tr>
372
627
  </tbody>
373
628
  </table></div>
374
629
  </div>
630
+ <p>Flags: Run Last</p>
631
+ </div>
375
632
  <hr>
376
633
  <div class="refsect2">
377
- <a name="AtkDocument-reload"></a><h3>The <code class="literal">"reload"</code> signal</h3>
378
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
379
- <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
380
- <p>
381
- The 'reload' signal is emitted when the contents of a
634
+ <a name="AtkDocument-page-changed"></a><h3>The <code class="literal">“page-changed”</code> signal</h3>
635
+ <pre class="programlisting"><span class="returnvalue">void</span>
636
+ user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
637
+ <span class="type">gint</span> page_number,
638
+ <span class="type">gpointer</span> user_data)</pre>
639
+ <p>The 'page-changed' signal is emitted when the current page of
640
+ a document changes, e.g. pressing page up/down in a document
641
+ viewer.</p>
642
+ <div class="refsect3">
643
+ <a name="id-1.5.4.11.4.5"></a><h4>Parameters</h4>
644
+ <div class="informaltable"><table width="100%" border="0">
645
+ <colgroup>
646
+ <col width="150px" class="parameters_name">
647
+ <col class="parameters_description">
648
+ <col width="200px" class="parameters_annotations">
649
+ </colgroup>
650
+ <tbody>
651
+ <tr>
652
+ <td class="parameter_name"><p>atkdocument</p></td>
653
+ <td class="parameter_description"><p>the object on which the signal was emitted</p></td>
654
+ <td class="parameter_annotations"> </td>
655
+ </tr>
656
+ <tr>
657
+ <td class="parameter_name"><p>page_number</p></td>
658
+ <td class="parameter_description"><p>the new page number. If this value is unknown
659
+ or not applicable, -1 should be provided.</p></td>
660
+ <td class="parameter_annotations"> </td>
661
+ </tr>
662
+ <tr>
663
+ <td class="parameter_name"><p>user_data</p></td>
664
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
665
+ <td class="parameter_annotations"> </td>
666
+ </tr>
667
+ </tbody>
668
+ </table></div>
669
+ </div>
670
+ <p>Flags: Run Last</p>
671
+ <p class="since">Since 2.12</p>
672
+ </div>
673
+ <hr>
674
+ <div class="refsect2">
675
+ <a name="AtkDocument-reload"></a><h3>The <code class="literal">“reload”</code> signal</h3>
676
+ <pre class="programlisting"><span class="returnvalue">void</span>
677
+ user_function (<a class="link" href="AtkDocument.html" title="AtkDocument"><span class="type">AtkDocument</span></a> *atkdocument,
678
+ <span class="type">gpointer</span> user_data)</pre>
679
+ <p>The 'reload' signal is emitted when the contents of a
382
680
  document is refreshed from its source. Once 'reload' has
383
681
  been emitted, a matching 'load-complete' or 'load-stopped'
384
682
  signal should follow, which clients may await before
385
- interrogating ATK for the latest document content.
386
- </p>
387
- <div class="variablelist"><table border="0">
388
- <col align="left" valign="top">
683
+ interrogating ATK for the latest document content.</p>
684
+ <div class="refsect3">
685
+ <a name="id-1.5.4.11.5.5"></a><h4>Parameters</h4>
686
+ <div class="informaltable"><table width="100%" border="0">
687
+ <colgroup>
688
+ <col width="150px" class="parameters_name">
689
+ <col class="parameters_description">
690
+ <col width="200px" class="parameters_annotations">
691
+ </colgroup>
389
692
  <tbody>
390
693
  <tr>
391
- <td><p><span class="term"><em class="parameter"><code>atkdocument</code></em> :</span></p></td>
392
- <td>the object which received the signal.</td>
694
+ <td class="parameter_name"><p>atkdocument</p></td>
695
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
696
+ <td class="parameter_annotations"> </td>
393
697
  </tr>
394
698
  <tr>
395
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
396
- <td>user data set when the signal handler was connected.</td>
699
+ <td class="parameter_name"><p>user_data</p></td>
700
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
701
+ <td class="parameter_annotations"> </td>
397
702
  </tr>
398
703
  </tbody>
399
704
  </table></div>
400
705
  </div>
706
+ <p>Flags: Run Last</p>
707
+ </div>
401
708
  </div>
402
709
  </div>
403
710
  <div class="footer">
404
711
  <hr>
405
- Generated by GTK-Doc V1.19.1</div>
712
+ Generated by GTK-Doc V1.21.1</div>
406
713
  </body>
407
714
  </html>