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
@@ -2,26 +2,25 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
- <title>AtkSocket</title>
6
- <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
5
+ <title>ATK - Accessibility Toolkit: AtkSocket</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">
9
- <link rel="prev" href="AtkSelection.html" title="AtkSelection">
10
- <link rel="next" href="atk-AtkState.html" title="AtkState">
11
- <meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
8
+ <link rel="up" href="accessibles.html" title="Custom accessible objects">
9
+ <link rel="prev" href="atk-AtkPlug.html" title="AtkPlug">
10
+ <link rel="next" href="utilities.html" title="Utilities">
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="#atk-AtkSocket.description" class="shortcut">Description</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="#atk-AtkSocket.description" class="shortcut">Description</a></span>
20
19
  </td>
21
20
  <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22
- <td><a accesskey="u" href="atk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23
- <td><a accesskey="p" href="AtkSelection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24
- <td><a accesskey="n" href="atk-AtkState.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
21
+ <td><a accesskey="u" href="accessibles.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22
+ <td><a accesskey="p" href="atk-AtkPlug.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23
+ <td><a accesskey="n" href="utilities.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25
24
  </tr></table>
26
25
  <div class="refentry">
27
26
  <a name="atk-AtkSocket"></a><div class="titlepage"></div>
@@ -30,130 +29,179 @@
30
29
  <h2><span class="refentrytitle"><a name="atk-AtkSocket.top_of_page"></a>AtkSocket</span></h2>
31
30
  <p>AtkSocket — Container for AtkPlug objects from other processes</p>
32
31
  </td>
33
- <td valign="top" align="right"></td>
32
+ <td class="gallery_image" valign="top" align="right"></td>
34
33
  </tr></table></div>
35
- <div class="refsynopsisdiv">
36
- <a name="atk-AtkSocket.synopsis"></a><h2>Synopsis</h2>
37
- <pre class="synopsis">struct <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket">AtkSocket</a>;
38
- <a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> * <a class="link" href="atk-AtkSocket.html#atk-socket-new" title="atk_socket_new ()">atk_socket_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
39
- <span class="returnvalue">void</span> <a class="link" href="atk-AtkSocket.html#atk-socket-embed" title="atk_socket_embed ()">atk_socket_embed</a> (<em class="parameter"><code><a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> *obj</code></em>,
40
- <em class="parameter"><code><span class="type">gchar</span> *plug_id</code></em>);
41
- <span class="returnvalue">gboolean</span> <a class="link" href="atk-AtkSocket.html#atk-socket-is-occupied" title="atk_socket_is_occupied ()">atk_socket_is_occupied</a> (<em class="parameter"><code><a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> *obj</code></em>);
42
- </pre>
34
+ <div class="refsect1">
35
+ <a name="atk-AtkSocket.functions"></a><h2>Functions</h2>
36
+ <div class="informaltable"><table width="100%" border="0">
37
+ <colgroup>
38
+ <col width="150px" class="functions_return">
39
+ <col class="functions_name">
40
+ </colgroup>
41
+ <tbody>
42
+ <tr>
43
+ <td class="function_type">
44
+ <a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
45
+ </td>
46
+ <td class="function_name">
47
+ <a class="link" href="atk-AtkSocket.html#atk-socket-new" title="atk_socket_new ()">atk_socket_new</a> <span class="c_punctuation">()</span>
48
+ </td>
49
+ </tr>
50
+ <tr>
51
+ <td class="function_type">
52
+ <span class="returnvalue">void</span>
53
+ </td>
54
+ <td class="function_name">
55
+ <a class="link" href="atk-AtkSocket.html#atk-socket-embed" title="atk_socket_embed ()">atk_socket_embed</a> <span class="c_punctuation">()</span>
56
+ </td>
57
+ </tr>
58
+ <tr>
59
+ <td class="function_type">
60
+ <span class="returnvalue">gboolean</span>
61
+ </td>
62
+ <td class="function_name">
63
+ <a class="link" href="atk-AtkSocket.html#atk-socket-is-occupied" title="atk_socket_is_occupied ()">atk_socket_is_occupied</a> <span class="c_punctuation">()</span>
64
+ </td>
65
+ </tr>
66
+ </tbody>
67
+ </table></div>
68
+ </div>
69
+ <div class="refsect1">
70
+ <a name="atk-AtkSocket.other"></a><h2>Types and Values</h2>
71
+ <div class="informaltable"><table width="100%" border="0">
72
+ <colgroup>
73
+ <col width="150px" class="name">
74
+ <col class="description">
75
+ </colgroup>
76
+ <tbody><tr>
77
+ <td class="datatype_keyword">struct</td>
78
+ <td class="function_name"><a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket">AtkSocket</a></td>
79
+ </tr></tbody>
80
+ </table></div>
43
81
  </div>
44
82
  <div class="refsect1">
45
83
  <a name="atk-AtkSocket.description"></a><h2>Description</h2>
46
- <p>
47
- Together with <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a>, <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> provides the ability to embed
84
+ <p>Together with <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a>, <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> provides the ability to embed
48
85
  accessibles from one process into another in a fashion that is
49
86
  transparent to assistive technologies. <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> works as the
50
87
  container of <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a>, embedding it using the method
51
- <a class="link" href="atk-AtkSocket.html#atk-socket-embed" title="atk_socket_embed ()"><code class="function">atk_socket_embed()</code></a>. Any accessible contained in the <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a> will
88
+ <a class="link" href="atk-AtkSocket.html#atk-socket-embed" title="atk_socket_embed ()"><code class="function">atk_socket_embed()</code></a>. Any accessible contained in the <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a> will
52
89
  appear to the assistive technologies as being inside the
53
- application that created the <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a>.
54
- </p>
55
- <p>
56
- The communication between a <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> and a <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a> is done by
90
+ application that created the <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a>.</p>
91
+ <p>The communication between a <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> and a <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a> is done by
57
92
  the IPC layer of the accessibility framework, normally implemented
58
93
  by the D-Bus based implementation of AT-SPI (at-spi2). If that is
59
94
  the case, at-spi-atk2 is the responsible to implement the abstract
60
- methods <a class="link" href="atk-AtkPlug.html#atk-plug-get-id" title="atk_plug_get_id ()"><code class="function">atk_plug_get_id()</code></a> and <a class="link" href="atk-AtkSocket.html#atk-socket-embed" title="atk_socket_embed ()"><code class="function">atk_socket_embed()</code></a>, so an ATK
95
+ methods <a class="link" href="atk-AtkPlug.html#atk-plug-get-id" title="atk_plug_get_id ()"><code class="function">atk_plug_get_id()</code></a> and <a class="link" href="atk-AtkSocket.html#atk-socket-embed" title="atk_socket_embed ()"><code class="function">atk_socket_embed()</code></a>, so an ATK
61
96
  implementor shouldn't reimplement them. The process that contains
62
97
  the <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a> is responsible to send the ID returned by
63
98
  <code class="function">atk_plug_id()</code> to the process that contains the <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a>, so it
64
- could call the method <a class="link" href="atk-AtkSocket.html#atk-socket-embed" title="atk_socket_embed ()"><code class="function">atk_socket_embed()</code></a> in order to embed it.
65
- </p>
66
- <p>
67
- For the same reasons, an implementor doesn't need to implement
68
- <a class="link" href="AtkObject.html#atk-object-get-n-accessible-children" title="atk_object_get_n_accessible_children ()"><code class="function">atk_object_get_n_accessible_children()</code></a> and
69
- <a class="link" href="AtkObject.html#atk-object-ref-accessible-child" title="atk_object_ref_accessible_child ()"><code class="function">atk_object_ref_accessible_child()</code></a>. All the logic related to those
70
- functions will be implemented by the IPC layer.
71
- </p>
99
+ could call the method <a class="link" href="atk-AtkSocket.html#atk-socket-embed" title="atk_socket_embed ()"><code class="function">atk_socket_embed()</code></a> in order to embed it.</p>
100
+ <p>For the same reasons, an implementor doesn't need to implement
101
+ <a class="link" href="AtkObject.html#atk-object-get-n-accessible-children" title="atk_object_get_n_accessible_children ()"><code class="function">atk_object_get_n_accessible_children()</code></a> and
102
+ <a class="link" href="AtkObject.html#atk-object-ref-accessible-child" title="atk_object_ref_accessible_child ()"><code class="function">atk_object_ref_accessible_child()</code></a>. All the logic related to those
103
+ functions will be implemented by the IPC layer.</p>
72
104
  </div>
73
105
  <div class="refsect1">
74
- <a name="atk-AtkSocket.details"></a><h2>Details</h2>
106
+ <a name="atk-AtkSocket.functions_details"></a><h2>Functions</h2>
75
107
  <div class="refsect2">
76
- <a name="AtkSocket"></a><h3>struct AtkSocket</h3>
77
- <pre class="programlisting">struct AtkSocket {
78
- AtkObject parent;
79
- };
80
- </pre>
108
+ <a name="atk-socket-new"></a><h3>atk_socket_new ()</h3>
109
+ <pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> *
110
+ atk_socket_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
81
111
  <p>
82
112
  </p>
113
+ <div class="refsect3">
114
+ <a name="id-1.7.6.6.2.5"></a><h4>Returns</h4>
115
+ <p></p>
83
116
  </div>
84
- <hr>
85
- <div class="refsect2">
86
- <a name="atk-socket-new"></a><h3>atk_socket_new ()</h3>
87
- <pre class="programlisting"><a class="link" href="AtkObject.html" title="AtkObject"><span class="returnvalue">AtkObject</span></a> * atk_socket_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
88
- <p>
89
- </p>
90
117
  </div>
91
118
  <hr>
92
119
  <div class="refsect2">
93
- <a name="atk-socket-embed"></a><h3>atk_socket_embed ()</h3>
94
- <pre class="programlisting"><span class="returnvalue">void</span> atk_socket_embed (<em class="parameter"><code><a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> *obj</code></em>,
95
- <em class="parameter"><code><span class="type">gchar</span> *plug_id</code></em>);</pre>
96
- <p>
97
- Embeds the children of an <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a> as the children of the
120
+ <a name="atk-socket-embed"></a><h3>atk_socket_embed ()</h3>
121
+ <pre class="programlisting"><span class="returnvalue">void</span>
122
+ atk_socket_embed (<em class="parameter"><code><a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> *obj</code></em>,
123
+ <em class="parameter"><code><span class="type">gchar</span> *plug_id</code></em>);</pre>
124
+ <p>Embeds the children of an <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a> as the children of the
98
125
  <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a>. The plug may be in the same process or in a different
99
- process.
100
- </p>
101
- <p>
102
- The class item used by this function should be filled in by the IPC
126
+ process.</p>
127
+ <p>The class item used by this function should be filled in by the IPC
103
128
  layer (usually at-spi2-atk). The implementor of the AtkSocket
104
129
  should call this function and pass the id for the plug as returned
105
- by <a class="link" href="atk-AtkPlug.html#atk-plug-get-id" title="atk_plug_get_id ()"><code class="function">atk_plug_get_id()</code></a>. It is the responsibility of the application
130
+ by <a class="link" href="atk-AtkPlug.html#atk-plug-get-id" title="atk_plug_get_id ()"><code class="function">atk_plug_get_id()</code></a>. It is the responsibility of the application
106
131
  to pass the plug id on to the process implementing the <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a>
107
- as needed.
108
- </p>
109
- <div class="variablelist"><table border="0">
110
- <col align="left" valign="top">
132
+ as needed.</p>
133
+ <div class="refsect3">
134
+ <a name="id-1.7.6.6.3.6"></a><h4>Parameters</h4>
135
+ <div class="informaltable"><table width="100%" border="0">
136
+ <colgroup>
137
+ <col width="150px" class="parameters_name">
138
+ <col class="parameters_description">
139
+ <col width="200px" class="parameters_annotations">
140
+ </colgroup>
111
141
  <tbody>
112
142
  <tr>
113
- <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
114
- <td>an <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a>
115
- </td>
143
+ <td class="parameter_name"><p>obj</p></td>
144
+ <td class="parameter_description"><p>an <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a></p></td>
145
+ <td class="parameter_annotations"> </td>
116
146
  </tr>
117
147
  <tr>
118
- <td><p><span class="term"><em class="parameter"><code>plug_id</code></em> :</span></p></td>
119
- <td>the ID of an <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a>
120
- </td>
148
+ <td class="parameter_name"><p>plug_id</p></td>
149
+ <td class="parameter_description"><p>the ID of an <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a></p></td>
150
+ <td class="parameter_annotations"> </td>
121
151
  </tr>
122
152
  </tbody>
123
153
  </table></div>
154
+ </div>
124
155
  <p class="since">Since 1.30</p>
125
156
  </div>
126
157
  <hr>
127
158
  <div class="refsect2">
128
- <a name="atk-socket-is-occupied"></a><h3>atk_socket_is_occupied ()</h3>
129
- <pre class="programlisting"><span class="returnvalue">gboolean</span> atk_socket_is_occupied (<em class="parameter"><code><a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> *obj</code></em>);</pre>
130
- <p>
131
- Determines whether or not the socket has an embedded plug.
132
- </p>
133
- <div class="variablelist"><table border="0">
134
- <col align="left" valign="top">
135
- <tbody>
136
- <tr>
137
- <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
138
- <td>an <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a>
139
- </td>
140
- </tr>
141
- <tr>
142
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
143
- <td>TRUE if a plug is embedded in the socket</td>
144
- </tr>
145
- </tbody>
159
+ <a name="atk-socket-is-occupied"></a><h3>atk_socket_is_occupied ()</h3>
160
+ <pre class="programlisting"><span class="returnvalue">gboolean</span>
161
+ atk_socket_is_occupied (<em class="parameter"><code><a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a> *obj</code></em>);</pre>
162
+ <p>Determines whether or not the socket has an embedded plug.</p>
163
+ <div class="refsect3">
164
+ <a name="id-1.7.6.6.4.5"></a><h4>Parameters</h4>
165
+ <div class="informaltable"><table width="100%" border="0">
166
+ <colgroup>
167
+ <col width="150px" class="parameters_name">
168
+ <col class="parameters_description">
169
+ <col width="200px" class="parameters_annotations">
170
+ </colgroup>
171
+ <tbody><tr>
172
+ <td class="parameter_name"><p>obj</p></td>
173
+ <td class="parameter_description"><p>an <a class="link" href="atk-AtkSocket.html#AtkSocket" title="struct AtkSocket"><span class="type">AtkSocket</span></a></p></td>
174
+ <td class="parameter_annotations"> </td>
175
+ </tr></tbody>
146
176
  </table></div>
177
+ </div>
178
+ <div class="refsect3">
179
+ <a name="id-1.7.6.6.4.6"></a><h4>Returns</h4>
180
+ <p> TRUE if a plug is embedded in the socket</p>
181
+ <p></p>
182
+ </div>
147
183
  <p class="since">Since 1.30</p>
148
184
  </div>
149
185
  </div>
150
186
  <div class="refsect1">
187
+ <a name="atk-AtkSocket.other_details"></a><h2>Types and Values</h2>
188
+ <div class="refsect2">
189
+ <a name="AtkSocket"></a><h3>struct AtkSocket</h3>
190
+ <pre class="programlisting">struct AtkSocket {
191
+ AtkObject parent;
192
+ };
193
+ </pre>
194
+ <p>
195
+ </p>
196
+ </div>
197
+ </div>
198
+ <div class="refsect1">
151
199
  <a name="atk-AtkSocket.see-also"></a><h2>See Also</h2>
152
- <a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a>
200
+ <p><a class="link" href="atk-AtkPlug.html#AtkPlug" title="struct AtkPlug"><span class="type">AtkPlug</span></a></p>
153
201
  </div>
154
202
  </div>
155
203
  <div class="footer">
156
204
  <hr>
157
- Generated by GTK-Doc V1.19.1</div>
205
+ Generated by GTK-Doc V1.21.1</div>
158
206
  </body>
159
207
  </html>
@@ -2,25 +2,24 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
- <title>AtkState</title>
6
- <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
5
+ <title>ATK - Accessibility Toolkit: AtkState</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">
9
- <link rel="prev" href="atk-AtkSocket.html" title="AtkSocket">
8
+ <link rel="up" href="data.html" title="Basic accessible data types">
9
+ <link rel="prev" href="AtkRelationSet.html" title="AtkRelationSet">
10
10
  <link rel="next" href="AtkStateSet.html" title="AtkStateSet">
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="#atk-AtkState.description" class="shortcut">Description</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="#atk-AtkState.description" class="shortcut">Description</a></span>
20
19
  </td>
21
20
  <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22
- <td><a accesskey="u" href="atk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23
- <td><a accesskey="p" href="atk-AtkSocket.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
21
+ <td><a accesskey="u" href="data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22
+ <td><a accesskey="p" href="AtkRelationSet.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24
23
  <td><a accesskey="n" href="AtkStateSet.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25
24
  </tr></table>
26
25
  <div class="refentry">
@@ -30,241 +29,389 @@
30
29
  <h2><span class="refentrytitle"><a name="atk-AtkState.top_of_page"></a>AtkState</span></h2>
31
30
  <p>AtkState — An AtkState describes a component's particular state.</p>
32
31
  </td>
33
- <td valign="top" align="right"></td>
32
+ <td class="gallery_image" valign="top" align="right"></td>
34
33
  </tr></table></div>
35
- <div class="refsynopsisdiv">
36
- <a name="atk-AtkState.synopsis"></a><h2>Synopsis</h2>
37
- <pre class="synopsis">enum <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a>;
38
- typedef <a class="link" href="atk-AtkState.html#AtkState" title="AtkState">AtkState</a>;
39
- <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a> <a class="link" href="atk-AtkState.html#atk-state-type-register" title="atk_state_type_register ()">atk_state_type_register</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
40
- const <span class="returnvalue">gchar</span> * <a class="link" href="atk-AtkState.html#atk-state-type-get-name" title="atk_state_type_get_name ()">atk_state_type_get_name</a> (<em class="parameter"><code><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> type</code></em>);
41
- <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a> <a class="link" href="atk-AtkState.html#atk-state-type-for-name" title="atk_state_type_for_name ()">atk_state_type_for_name</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
42
- </pre>
34
+ <div class="refsect1">
35
+ <a name="atk-AtkState.functions"></a><h2>Functions</h2>
36
+ <div class="informaltable"><table width="100%" border="0">
37
+ <colgroup>
38
+ <col width="150px" class="functions_return">
39
+ <col class="functions_name">
40
+ </colgroup>
41
+ <tbody>
42
+ <tr>
43
+ <td class="function_type">
44
+ <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a>
45
+ </td>
46
+ <td class="function_name">
47
+ <a class="link" href="atk-AtkState.html#atk-state-type-register" title="atk_state_type_register ()">atk_state_type_register</a> <span class="c_punctuation">()</span>
48
+ </td>
49
+ </tr>
50
+ <tr>
51
+ <td class="function_type">const <span class="returnvalue">gchar</span> *
52
+ </td>
53
+ <td class="function_name">
54
+ <a class="link" href="atk-AtkState.html#atk-state-type-get-name" title="atk_state_type_get_name ()">atk_state_type_get_name</a> <span class="c_punctuation">()</span>
55
+ </td>
56
+ </tr>
57
+ <tr>
58
+ <td class="function_type">
59
+ <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a>
60
+ </td>
61
+ <td class="function_name">
62
+ <a class="link" href="atk-AtkState.html#atk-state-type-for-name" title="atk_state_type_for_name ()">atk_state_type_for_name</a> <span class="c_punctuation">()</span>
63
+ </td>
64
+ </tr>
65
+ </tbody>
66
+ </table></div>
67
+ </div>
68
+ <div class="refsect1">
69
+ <a name="atk-AtkState.other"></a><h2>Types and Values</h2>
70
+ <div class="informaltable"><table width="100%" border="0">
71
+ <colgroup>
72
+ <col width="150px" class="name">
73
+ <col class="description">
74
+ </colgroup>
75
+ <tbody>
76
+ <tr>
77
+ <td class="datatype_keyword">enum</td>
78
+ <td class="function_name"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType">AtkStateType</a></td>
79
+ </tr>
80
+ <tr>
81
+ <td class="typedef_keyword">typedef</td>
82
+ <td class="function_name"><a class="link" href="atk-AtkState.html#AtkState" title="AtkState">AtkState</a></td>
83
+ </tr>
84
+ </tbody>
85
+ </table></div>
43
86
  </div>
44
87
  <div class="refsect1">
45
88
  <a name="atk-AtkState.description"></a><h2>Description</h2>
46
- <p>
47
- An AtkState describes a component's particular state. The actual
89
+ <p>An AtkState describes a component's particular state. The actual
48
90
  state of an component is described by its AtkStateSet, which is a
49
- set of AtkStates.
91
+ set of AtkStates.</p>
92
+ </div>
93
+ <div class="refsect1">
94
+ <a name="atk-AtkState.functions_details"></a><h2>Functions</h2>
95
+ <div class="refsect2">
96
+ <a name="atk-state-type-register"></a><h3>atk_state_type_register ()</h3>
97
+ <pre class="programlisting"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a>
98
+ atk_state_type_register (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
99
+ <p>Register a new object state.</p>
100
+ <div class="refsect3">
101
+ <a name="id-1.6.5.6.2.5"></a><h4>Parameters</h4>
102
+ <div class="informaltable"><table width="100%" border="0">
103
+ <colgroup>
104
+ <col width="150px" class="parameters_name">
105
+ <col class="parameters_description">
106
+ <col width="200px" class="parameters_annotations">
107
+ </colgroup>
108
+ <tbody><tr>
109
+ <td class="parameter_name"><p>name</p></td>
110
+ <td class="parameter_description"><p>a character string describing the new state.</p></td>
111
+ <td class="parameter_annotations"> </td>
112
+ </tr></tbody>
113
+ </table></div>
114
+ </div>
115
+ <div class="refsect3">
116
+ <a name="id-1.6.5.6.2.6"></a><h4>Returns</h4>
117
+ <p> an <a class="link" href="atk-AtkState.html#AtkState" title="AtkState"><span class="type">AtkState</span></a> value for the new state.</p>
118
+ <p></p>
119
+ </div>
120
+ </div>
121
+ <hr>
122
+ <div class="refsect2">
123
+ <a name="atk-state-type-get-name"></a><h3>atk_state_type_get_name ()</h3>
124
+ <pre class="programlisting">const <span class="returnvalue">gchar</span> *
125
+ atk_state_type_get_name (<em class="parameter"><code><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> type</code></em>);</pre>
126
+ <p>Gets the description string describing the <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> <em class="parameter"><code>type</code></em>
127
+ .</p>
128
+ <div class="refsect3">
129
+ <a name="id-1.6.5.6.3.5"></a><h4>Parameters</h4>
130
+ <div class="informaltable"><table width="100%" border="0">
131
+ <colgroup>
132
+ <col width="150px" class="parameters_name">
133
+ <col class="parameters_description">
134
+ <col width="200px" class="parameters_annotations">
135
+ </colgroup>
136
+ <tbody><tr>
137
+ <td class="parameter_name"><p>type</p></td>
138
+ <td class="parameter_description"><p>The <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> whose name is required</p></td>
139
+ <td class="parameter_annotations"> </td>
140
+ </tr></tbody>
141
+ </table></div>
142
+ </div>
143
+ <div class="refsect3">
144
+ <a name="id-1.6.5.6.3.6"></a><h4>Returns</h4>
145
+ <p> the string describing the AtkStateType</p>
146
+ <p></p>
147
+ </div>
148
+ </div>
149
+ <hr>
150
+ <div class="refsect2">
151
+ <a name="atk-state-type-for-name"></a><h3>atk_state_type_for_name ()</h3>
152
+ <pre class="programlisting"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a>
153
+ atk_state_type_for_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
154
+ <p>Gets the <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> corresponding to the description string <em class="parameter"><code>name</code></em>
155
+ .</p>
156
+ <div class="refsect3">
157
+ <a name="id-1.6.5.6.4.5"></a><h4>Parameters</h4>
158
+ <div class="informaltable"><table width="100%" border="0">
159
+ <colgroup>
160
+ <col width="150px" class="parameters_name">
161
+ <col class="parameters_description">
162
+ <col width="200px" class="parameters_annotations">
163
+ </colgroup>
164
+ <tbody><tr>
165
+ <td class="parameter_name"><p>name</p></td>
166
+ <td class="parameter_description"><p>a character string state name</p></td>
167
+ <td class="parameter_annotations"> </td>
168
+ </tr></tbody>
169
+ </table></div>
170
+ </div>
171
+ <div class="refsect3">
172
+ <a name="id-1.6.5.6.4.6"></a><h4>Returns</h4>
173
+ <p> an <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> corresponding to <em class="parameter"><code>name</code></em>
50
174
  </p>
175
+ <p></p>
176
+ </div>
177
+ </div>
51
178
  </div>
52
179
  <div class="refsect1">
53
- <a name="atk-AtkState.details"></a><h2>Details</h2>
180
+ <a name="atk-AtkState.other_details"></a><h2>Types and Values</h2>
54
181
  <div class="refsect2">
55
182
  <a name="AtkStateType"></a><h3>enum AtkStateType</h3>
56
- <pre class="programlisting">typedef enum {
57
- ATK_STATE_INVALID,
58
- ATK_STATE_ACTIVE,
59
- ATK_STATE_ARMED,
60
- ATK_STATE_BUSY,
61
- ATK_STATE_CHECKED,
62
- ATK_STATE_DEFUNCT,
63
- ATK_STATE_EDITABLE,
64
- ATK_STATE_ENABLED,
65
- ATK_STATE_EXPANDABLE,
66
- ATK_STATE_EXPANDED,
67
- ATK_STATE_FOCUSABLE,
68
- ATK_STATE_FOCUSED,
69
- ATK_STATE_HORIZONTAL,
70
- ATK_STATE_ICONIFIED,
71
- ATK_STATE_MODAL,
72
- ATK_STATE_MULTI_LINE,
73
- ATK_STATE_MULTISELECTABLE,
74
- ATK_STATE_OPAQUE,
75
- ATK_STATE_PRESSED,
76
- ATK_STATE_RESIZABLE,
77
- ATK_STATE_SELECTABLE,
78
- ATK_STATE_SELECTED,
79
- ATK_STATE_SENSITIVE,
80
- ATK_STATE_SHOWING,
81
- ATK_STATE_SINGLE_LINE,
82
- ATK_STATE_STALE,
83
- ATK_STATE_TRANSIENT,
84
- ATK_STATE_VERTICAL,
85
- ATK_STATE_VISIBLE,
86
- ATK_STATE_MANAGES_DESCENDANTS,
87
- ATK_STATE_INDETERMINATE,
88
- ATK_STATE_TRUNCATED,
89
- ATK_STATE_REQUIRED,
90
- ATK_STATE_INVALID_ENTRY,
91
- ATK_STATE_SUPPORTS_AUTOCOMPLETION,
92
- ATK_STATE_SELECTABLE_TEXT,
93
- ATK_STATE_DEFAULT,
94
- ATK_STATE_ANIMATED,
95
- ATK_STATE_VISITED,
96
-
97
- ATK_STATE_LAST_DEFINED
98
- } AtkStateType;
99
- </pre>
100
- <p>
101
- The possible types of states of an object
102
- </p>
103
- <div class="variablelist"><table border="0">
104
- <col align="left" valign="top">
183
+ <p>The possible types of states of an object</p>
184
+ <div class="refsect3">
185
+ <a name="id-1.6.5.7.2.4"></a><h4>Members</h4>
186
+ <div class="informaltable"><table width="100%" border="0">
187
+ <colgroup>
188
+ <col width="300px" class="enum_members_name">
189
+ <col class="enum_members_description">
190
+ <col width="200px" class="enum_members_annotations">
191
+ </colgroup>
105
192
  <tbody>
106
193
  <tr>
107
- <td><p><a name="ATK-STATE-INVALID:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INVALID</code></span></p></td>
108
- <td>Indicates an invalid state - probably an error condition.
194
+ <td class="enum_member_name"><p><a name="ATK-STATE-INVALID:CAPS"></a>ATK_STATE_INVALID</p></td>
195
+ <td class="enum_member_description">
196
+ <p>Indicates an invalid state - probably an error condition.</p>
109
197
  </td>
198
+ <td class="enum_member_annotations"> </td>
110
199
  </tr>
111
200
  <tr>
112
- <td><p><a name="ATK-STATE-ACTIVE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ACTIVE</code></span></p></td>
113
- <td>Indicates a window is currently the active window, or is an active subelement within a container or table
201
+ <td class="enum_member_name"><p><a name="ATK-STATE-ACTIVE:CAPS"></a>ATK_STATE_ACTIVE</p></td>
202
+ <td class="enum_member_description">
203
+ <p>Indicates a window is currently the active window, or is an active subelement within a container or table</p>
114
204
  </td>
205
+ <td class="enum_member_annotations"> </td>
115
206
  </tr>
116
207
  <tr>
117
- <td><p><a name="ATK-STATE-ARMED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ARMED</code></span></p></td>
118
- <td>Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation.
208
+ <td class="enum_member_name"><p><a name="ATK-STATE-ARMED:CAPS"></a>ATK_STATE_ARMED</p></td>
209
+ <td class="enum_member_description">
210
+ <p>Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds. Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation.</p>
119
211
  </td>
212
+ <td class="enum_member_annotations"> </td>
120
213
  </tr>
121
214
  <tr>
122
- <td><p><a name="ATK-STATE-BUSY:CAPS"></a><span class="term"><code class="literal">ATK_STATE_BUSY</code></span></p></td>
123
- <td>Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed.
215
+ <td class="enum_member_name"><p><a name="ATK-STATE-BUSY:CAPS"></a>ATK_STATE_BUSY</p></td>
216
+ <td class="enum_member_description">
217
+ <p>Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. This state may be used by implementors of Document to indicate that content loading is underway. It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed.</p>
124
218
  </td>
219
+ <td class="enum_member_annotations"> </td>
125
220
  </tr>
126
221
  <tr>
127
- <td><p><a name="ATK-STATE-CHECKED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_CHECKED</code></span></p></td>
128
- <td>Indicates this object is currently checked, for instance a checkbox is 'non-empty'.
222
+ <td class="enum_member_name"><p><a name="ATK-STATE-CHECKED:CAPS"></a>ATK_STATE_CHECKED</p></td>
223
+ <td class="enum_member_description">
224
+ <p>Indicates this object is currently checked, for instance a checkbox is 'non-empty'.</p>
129
225
  </td>
226
+ <td class="enum_member_annotations"> </td>
130
227
  </tr>
131
228
  <tr>
132
- <td><p><a name="ATK-STATE-DEFUNCT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_DEFUNCT</code></span></p></td>
133
- <td>Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed)
229
+ <td class="enum_member_name"><p><a name="ATK-STATE-DEFUNCT:CAPS"></a>ATK_STATE_DEFUNCT</p></td>
230
+ <td class="enum_member_description">
231
+ <p>Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed)</p>
134
232
  </td>
233
+ <td class="enum_member_annotations"> </td>
135
234
  </tr>
136
235
  <tr>
137
- <td><p><a name="ATK-STATE-EDITABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EDITABLE</code></span></p></td>
138
- <td>Indicates the user can change the contents of this object
236
+ <td class="enum_member_name"><p><a name="ATK-STATE-EDITABLE:CAPS"></a>ATK_STATE_EDITABLE</p></td>
237
+ <td class="enum_member_description">
238
+ <p>Indicates the user can change the contents of this object</p>
139
239
  </td>
240
+ <td class="enum_member_annotations"> </td>
140
241
  </tr>
141
242
  <tr>
142
- <td><p><a name="ATK-STATE-ENABLED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ENABLED</code></span></p></td>
143
- <td>Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE
243
+ <td class="enum_member_name"><p><a name="ATK-STATE-ENABLED:CAPS"></a>ATK_STATE_ENABLED</p></td>
244
+ <td class="enum_member_description">
245
+ <p>Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE</p>
144
246
  </td>
247
+ <td class="enum_member_annotations"> </td>
145
248
  </tr>
146
249
  <tr>
147
- <td><p><a name="ATK-STATE-EXPANDABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EXPANDABLE</code></span></p></td>
148
- <td>Indicates this object allows progressive disclosure of its children
250
+ <td class="enum_member_name"><p><a name="ATK-STATE-EXPANDABLE:CAPS"></a>ATK_STATE_EXPANDABLE</p></td>
251
+ <td class="enum_member_description">
252
+ <p>Indicates this object allows progressive disclosure of its children</p>
149
253
  </td>
254
+ <td class="enum_member_annotations"> </td>
150
255
  </tr>
151
256
  <tr>
152
- <td><p><a name="ATK-STATE-EXPANDED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_EXPANDED</code></span></p></td>
153
- <td>Indicates this object its expanded - see ATK_STATE_EXPANDABLE above
257
+ <td class="enum_member_name"><p><a name="ATK-STATE-EXPANDED:CAPS"></a>ATK_STATE_EXPANDED</p></td>
258
+ <td class="enum_member_description">
259
+ <p>Indicates this object its expanded - see ATK_STATE_EXPANDABLE above</p>
154
260
  </td>
261
+ <td class="enum_member_annotations"> </td>
155
262
  </tr>
156
263
  <tr>
157
- <td><p><a name="ATK-STATE-FOCUSABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_FOCUSABLE</code></span></p></td>
158
- <td>Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus
264
+ <td class="enum_member_name"><p><a name="ATK-STATE-FOCUSABLE:CAPS"></a>ATK_STATE_FOCUSABLE</p></td>
265
+ <td class="enum_member_description">
266
+ <p>Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus</p>
159
267
  </td>
268
+ <td class="enum_member_annotations"> </td>
160
269
  </tr>
161
270
  <tr>
162
- <td><p><a name="ATK-STATE-FOCUSED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_FOCUSED</code></span></p></td>
163
- <td>Indicates this object currently has the keyboard focus
271
+ <td class="enum_member_name"><p><a name="ATK-STATE-FOCUSED:CAPS"></a>ATK_STATE_FOCUSED</p></td>
272
+ <td class="enum_member_description">
273
+ <p>Indicates this object currently has the keyboard focus</p>
164
274
  </td>
275
+ <td class="enum_member_annotations"> </td>
165
276
  </tr>
166
277
  <tr>
167
- <td><p><a name="ATK-STATE-HORIZONTAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_HORIZONTAL</code></span></p></td>
168
- <td>Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful.
278
+ <td class="enum_member_name"><p><a name="ATK-STATE-HORIZONTAL:CAPS"></a>ATK_STATE_HORIZONTAL</p></td>
279
+ <td class="enum_member_description">
280
+ <p>Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR. For objects where vertical/horizontal orientation is especially meaningful.</p>
169
281
  </td>
282
+ <td class="enum_member_annotations"> </td>
170
283
  </tr>
171
284
  <tr>
172
- <td><p><a name="ATK-STATE-ICONIFIED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ICONIFIED</code></span></p></td>
173
- <td>Indicates this object is minimized and is represented only by an icon
285
+ <td class="enum_member_name"><p><a name="ATK-STATE-ICONIFIED:CAPS"></a>ATK_STATE_ICONIFIED</p></td>
286
+ <td class="enum_member_description">
287
+ <p>Indicates this object is minimized and is represented only by an icon</p>
174
288
  </td>
289
+ <td class="enum_member_annotations"> </td>
175
290
  </tr>
176
291
  <tr>
177
- <td><p><a name="ATK-STATE-MODAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MODAL</code></span></p></td>
178
- <td>Indicates something must be done with this object before the user can interact with an object in a different window
292
+ <td class="enum_member_name"><p><a name="ATK-STATE-MODAL:CAPS"></a>ATK_STATE_MODAL</p></td>
293
+ <td class="enum_member_description">
294
+ <p>Indicates something must be done with this object before the user can interact with an object in a different window</p>
179
295
  </td>
296
+ <td class="enum_member_annotations"> </td>
180
297
  </tr>
181
298
  <tr>
182
- <td><p><a name="ATK-STATE-MULTI-LINE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MULTI_LINE</code></span></p></td>
183
- <td>Indicates this (text) object can contain multiple lines of text
299
+ <td class="enum_member_name"><p><a name="ATK-STATE-MULTI-LINE:CAPS"></a>ATK_STATE_MULTI_LINE</p></td>
300
+ <td class="enum_member_description">
301
+ <p>Indicates this (text) object can contain multiple lines of text</p>
184
302
  </td>
303
+ <td class="enum_member_annotations"> </td>
185
304
  </tr>
186
305
  <tr>
187
- <td><p><a name="ATK-STATE-MULTISELECTABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MULTISELECTABLE</code></span></p></td>
188
- <td>Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections.
306
+ <td class="enum_member_name"><p><a name="ATK-STATE-MULTISELECTABLE:CAPS"></a>ATK_STATE_MULTISELECTABLE</p></td>
307
+ <td class="enum_member_description">
308
+ <p>Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections.</p>
189
309
  </td>
310
+ <td class="enum_member_annotations"> </td>
190
311
  </tr>
191
312
  <tr>
192
- <td><p><a name="ATK-STATE-OPAQUE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_OPAQUE</code></span></p></td>
193
- <td>Indicates this object paints every pixel within its rectangular region.
313
+ <td class="enum_member_name"><p><a name="ATK-STATE-OPAQUE:CAPS"></a>ATK_STATE_OPAQUE</p></td>
314
+ <td class="enum_member_description">
315
+ <p>Indicates this object paints every pixel within its rectangular region.</p>
194
316
  </td>
317
+ <td class="enum_member_annotations"> </td>
195
318
  </tr>
196
319
  <tr>
197
- <td><p><a name="ATK-STATE-PRESSED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_PRESSED</code></span></p></td>
198
- <td>Indicates this object is currently pressed; c.f. ATK_STATE_ARMED
320
+ <td class="enum_member_name"><p><a name="ATK-STATE-PRESSED:CAPS"></a>ATK_STATE_PRESSED</p></td>
321
+ <td class="enum_member_description">
322
+ <p>Indicates this object is currently pressed; c.f. ATK_STATE_ARMED</p>
199
323
  </td>
324
+ <td class="enum_member_annotations"> </td>
200
325
  </tr>
201
326
  <tr>
202
- <td><p><a name="ATK-STATE-RESIZABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_RESIZABLE</code></span></p></td>
203
- <td>Indicates the size of this object is not fixed
327
+ <td class="enum_member_name"><p><a name="ATK-STATE-RESIZABLE:CAPS"></a>ATK_STATE_RESIZABLE</p></td>
328
+ <td class="enum_member_description">
329
+ <p>Indicates the size of this object is not fixed</p>
204
330
  </td>
331
+ <td class="enum_member_annotations"> </td>
205
332
  </tr>
206
333
  <tr>
207
- <td><p><a name="ATK-STATE-SELECTABLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTABLE</code></span></p></td>
208
- <td>Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected
334
+ <td class="enum_member_name"><p><a name="ATK-STATE-SELECTABLE:CAPS"></a>ATK_STATE_SELECTABLE</p></td>
335
+ <td class="enum_member_description">
336
+ <p>Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected</p>
209
337
  </td>
338
+ <td class="enum_member_annotations"> </td>
210
339
  </tr>
211
340
  <tr>
212
- <td><p><a name="ATK-STATE-SELECTED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTED</code></span></p></td>
213
- <td>Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected
341
+ <td class="enum_member_name"><p><a name="ATK-STATE-SELECTED:CAPS"></a>ATK_STATE_SELECTED</p></td>
342
+ <td class="enum_member_description">
343
+ <p>Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected</p>
214
344
  </td>
345
+ <td class="enum_member_annotations"> </td>
215
346
  </tr>
216
347
  <tr>
217
- <td><p><a name="ATK-STATE-SENSITIVE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SENSITIVE</code></span></p></td>
218
- <td>Indicates this object is sensitive, e.g. to user interaction.
348
+ <td class="enum_member_name"><p><a name="ATK-STATE-SENSITIVE:CAPS"></a>ATK_STATE_SENSITIVE</p></td>
349
+ <td class="enum_member_description">
350
+ <p>Indicates this object is sensitive, e.g. to user interaction.
219
351
  STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,
220
352
  but may be found in the absence of STATE_ENABLED if the current visible state of the
221
353
  control is "disconnected" from the application state. In such cases, direct user interaction
222
354
  can often result in the object gaining STATE_SENSITIVE, for instance if a user makes
223
355
  an explicit selection using an object whose current state is ambiguous or undefined.
224
- <em class="parameter"><code>see</code></em> STATE_ENABLED, STATE_INDETERMINATE.
356
+ <em class="parameter"><code>see</code></em>
357
+ STATE_ENABLED, STATE_INDETERMINATE.</p>
225
358
  </td>
359
+ <td class="enum_member_annotations"> </td>
226
360
  </tr>
227
361
  <tr>
228
- <td><p><a name="ATK-STATE-SHOWING:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SHOWING</code></span></p></td>
229
- <td>Indicates this object, the object's parent, the object's parent's parent, and so on,
362
+ <td class="enum_member_name"><p><a name="ATK-STATE-SHOWING:CAPS"></a>ATK_STATE_SHOWING</p></td>
363
+ <td class="enum_member_description">
364
+ <p>Indicates this object, the object's parent, the object's parent's parent, and so on,
230
365
  are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose
231
- between this object and the top of the window stack.
366
+ between this object and the top of the window stack.</p>
232
367
  </td>
368
+ <td class="enum_member_annotations"> </td>
233
369
  </tr>
234
370
  <tr>
235
- <td><p><a name="ATK-STATE-SINGLE-LINE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SINGLE_LINE</code></span></p></td>
236
- <td>Indicates this (text) object can contain only a single line of text
371
+ <td class="enum_member_name"><p><a name="ATK-STATE-SINGLE-LINE:CAPS"></a>ATK_STATE_SINGLE_LINE</p></td>
372
+ <td class="enum_member_description">
373
+ <p>Indicates this (text) object can contain only a single line of text</p>
237
374
  </td>
375
+ <td class="enum_member_annotations"> </td>
238
376
  </tr>
239
377
  <tr>
240
- <td><p><a name="ATK-STATE-STALE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_STALE</code></span></p></td>
241
- <td>Indicates that the information returned for this object may no longer be
378
+ <td class="enum_member_name"><p><a name="ATK-STATE-STALE:CAPS"></a>ATK_STATE_STALE</p></td>
379
+ <td class="enum_member_description">
380
+ <p>Indicates that the information returned for this object may no longer be
242
381
  synchronized with the application state. This is implied if the object has STATE_TRANSIENT,
243
382
  and can also occur towards the end of the object peer's lifecycle. It can also be used to indicate that
244
383
  the index associated with this object has changed since the user accessed the object (in lieu of
245
- "index-in-parent-changed" events).
384
+ "index-in-parent-changed" events).</p>
246
385
  </td>
386
+ <td class="enum_member_annotations"> </td>
247
387
  </tr>
248
388
  <tr>
249
- <td><p><a name="ATK-STATE-TRANSIENT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_TRANSIENT</code></span></p></td>
250
- <td>Indicates this object is transient, i.e. a snapshot which may not emit events when its
389
+ <td class="enum_member_name"><p><a name="ATK-STATE-TRANSIENT:CAPS"></a>ATK_STATE_TRANSIENT</p></td>
390
+ <td class="enum_member_description">
391
+ <p>Indicates this object is transient, i.e. a snapshot which may not emit events when its
251
392
  state changes. Data from objects with ATK_STATE_TRANSIENT should not be cached, since there may be no
252
- notification given when the cached data becomes obsolete.
393
+ notification given when the cached data becomes obsolete.</p>
253
394
  </td>
395
+ <td class="enum_member_annotations"> </td>
254
396
  </tr>
255
397
  <tr>
256
- <td><p><a name="ATK-STATE-VERTICAL:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VERTICAL</code></span></p></td>
257
- <td>Indicates the orientation of this object is vertical
398
+ <td class="enum_member_name"><p><a name="ATK-STATE-VERTICAL:CAPS"></a>ATK_STATE_VERTICAL</p></td>
399
+ <td class="enum_member_description">
400
+ <p>Indicates the orientation of this object is vertical</p>
258
401
  </td>
402
+ <td class="enum_member_annotations"> </td>
259
403
  </tr>
260
404
  <tr>
261
- <td><p><a name="ATK-STATE-VISIBLE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VISIBLE</code></span></p></td>
262
- <td>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
405
+ <td class="enum_member_name"><p><a name="ATK-STATE-VISIBLE:CAPS"></a>ATK_STATE_VISIBLE</p></td>
406
+ <td class="enum_member_description">
407
+ <p>Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.</p>
263
408
  </td>
409
+ <td class="enum_member_annotations"> </td>
264
410
  </tr>
265
411
  <tr>
266
- <td><p><a name="ATK-STATE-MANAGES-DESCENDANTS:CAPS"></a><span class="term"><code class="literal">ATK_STATE_MANAGES_DESCENDANTS</code></span></p></td>
267
- <td>Indicates that "active-descendant-changed" event
412
+ <td class="enum_member_name"><p><a name="ATK-STATE-MANAGES-DESCENDANTS:CAPS"></a>ATK_STATE_MANAGES_DESCENDANTS</p></td>
413
+ <td class="enum_member_description">
414
+ <p>Indicates that "active-descendant-changed" event
268
415
  is sent when children become 'active' (i.e. are selected or navigated to onscreen).
269
416
  Used to prevent need to enumerate all children in very large containers, like tables.
270
417
  The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.
@@ -272,156 +419,138 @@ that the children should not, and need not, be enumerated by the client.
272
419
  Objects implementing this state are expected to provide relevant state
273
420
  notifications to listening clients, for instance notifications of visibility
274
421
  changes and activation of their contained child objects, without the client
275
- having previously requested references to those children.
422
+ having previously requested references to those children.</p>
276
423
  </td>
424
+ <td class="enum_member_annotations"> </td>
277
425
  </tr>
278
426
  <tr>
279
- <td><p><a name="ATK-STATE-INDETERMINATE:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INDETERMINATE</code></span></p></td>
280
- <td>Indicates that a check box is in a state other than checked or not checked.
427
+ <td class="enum_member_name"><p><a name="ATK-STATE-INDETERMINATE:CAPS"></a>ATK_STATE_INDETERMINATE</p></td>
428
+ <td class="enum_member_description">
429
+ <p>Indicates that a check box is in a state other than checked or not checked.
281
430
  This usually means that the boolean value reflected or
282
431
  controlled by the object does not apply consistently to the entire current context.
283
432
  For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE
284
433
  if the currently selected text contains a mixture of weight attributes.
285
434
  In many cases interacting with a STATE_INDETERMINATE object will cause
286
435
  the context's corresponding boolean attribute to be homogenized, whereupon the object
287
- will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired.
436
+ will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired.</p>
288
437
  </td>
438
+ <td class="enum_member_annotations"> </td>
289
439
  </tr>
290
440
  <tr>
291
- <td><p><a name="ATK-STATE-TRUNCATED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_TRUNCATED</code></span></p></td>
292
- <td>Indicates that an object is truncated, e.g. a text value in a speradsheet cell.
441
+ <td class="enum_member_name"><p><a name="ATK-STATE-TRUNCATED:CAPS"></a>ATK_STATE_TRUNCATED</p></td>
442
+ <td class="enum_member_description">
443
+ <p>Indicates that an object is truncated, e.g. a text value in a speradsheet cell.</p>
293
444
  </td>
445
+ <td class="enum_member_annotations"> </td>
294
446
  </tr>
295
447
  <tr>
296
- <td><p><a name="ATK-STATE-REQUIRED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_REQUIRED</code></span></p></td>
297
- <td>Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface.
448
+ <td class="enum_member_name"><p><a name="ATK-STATE-REQUIRED:CAPS"></a>ATK_STATE_REQUIRED</p></td>
449
+ <td class="enum_member_description">
450
+ <p>Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface.</p>
298
451
  </td>
452
+ <td class="enum_member_annotations"> </td>
299
453
  </tr>
300
454
  <tr>
301
- <td><p><a name="ATK-STATE-INVALID-ENTRY:CAPS"></a><span class="term"><code class="literal">ATK_STATE_INVALID_ENTRY</code></span></p></td>
302
- <td>Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input.
455
+ <td class="enum_member_name"><p><a name="ATK-STATE-INVALID-ENTRY:CAPS"></a>ATK_STATE_INVALID_ENTRY</p></td>
456
+ <td class="enum_member_description">
457
+ <p>Indicates that the object has encountered an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input.</p>
303
458
  </td>
459
+ <td class="enum_member_annotations"> </td>
304
460
  </tr>
305
461
  <tr>
306
- <td><p><a name="ATK-STATE-SUPPORTS-AUTOCOMPLETION:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SUPPORTS_AUTOCOMPLETION</code></span></p></td>
307
- <td>Indicates that the object in question implements some form of ¨typeahead¨ or
462
+ <td class="enum_member_name"><p><a name="ATK-STATE-SUPPORTS-AUTOCOMPLETION:CAPS"></a>ATK_STATE_SUPPORTS_AUTOCOMPLETION</p></td>
463
+ <td class="enum_member_description">
464
+ <p>Indicates that the object in question implements some form of ¨typeahead¨ or
308
465
  pre-selection behavior whereby entering the first character of one or more sub-elements
309
466
  causes those elements to scroll into view or become selected. Subsequent character input
310
467
  may narrow the selection further as long as one or more sub-elements match the string.
311
468
  This state is normally only useful and encountered on objects that implement Selection.
312
469
  In some cases the typeahead behavior may result in full or partial ¨completion¨ of
313
470
  the data in the input field, in which case these input events may trigger text-changed
314
- events from the AtkText interface. This state supplants <em class="parameter"><code>ATK_ROLE_AUTOCOMPLETE</code></em>.
471
+ events from the AtkText interface. This state supplants <em class="parameter"><code>ATK_ROLE_AUTOCOMPLETE</code></em>
472
+ .</p>
315
473
  </td>
474
+ <td class="enum_member_annotations"> </td>
316
475
  </tr>
317
476
  <tr>
318
- <td><p><a name="ATK-STATE-SELECTABLE-TEXT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_SELECTABLE_TEXT</code></span></p></td>
319
- <td>Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from <em class="parameter"><code>ATK_STATE_SELECTABLE</code></em>, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations.
477
+ <td class="enum_member_name"><p><a name="ATK-STATE-SELECTABLE-TEXT:CAPS"></a>ATK_STATE_SELECTABLE_TEXT</p></td>
478
+ <td class="enum_member_description">
479
+ <p>Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from <em class="parameter"><code>ATK_STATE_SELECTABLE</code></em>
480
+ , which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations.</p>
320
481
  </td>
482
+ <td class="enum_member_annotations"> </td>
321
483
  </tr>
322
484
  <tr>
323
- <td><p><a name="ATK-STATE-DEFAULT:CAPS"></a><span class="term"><code class="literal">ATK_STATE_DEFAULT</code></span></p></td>
324
- <td>Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button.
485
+ <td class="enum_member_name"><p><a name="ATK-STATE-DEFAULT:CAPS"></a>ATK_STATE_DEFAULT</p></td>
486
+ <td class="enum_member_description">
487
+ <p>Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button.</p>
325
488
  </td>
489
+ <td class="enum_member_annotations"> </td>
326
490
  </tr>
327
491
  <tr>
328
- <td><p><a name="ATK-STATE-ANIMATED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_ANIMATED</code></span></p></td>
329
- <td>Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation.
330
- <em class="parameter"><code>note</code></em> some applications, notably content viewers, may not be able to detect
492
+ <td class="enum_member_name"><p><a name="ATK-STATE-ANIMATED:CAPS"></a>ATK_STATE_ANIMATED</p></td>
493
+ <td class="enum_member_description">
494
+ <p>Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation.
495
+ <em class="parameter"><code>note</code></em>
496
+ some applications, notably content viewers, may not be able to detect
331
497
  all kinds of animated content. Therefore the absence of this state should not
332
498
  be taken as definitive evidence that the object's visual representation is
333
- static; this state is advisory.
499
+ static; this state is advisory.</p>
334
500
  </td>
501
+ <td class="enum_member_annotations"> </td>
335
502
  </tr>
336
503
  <tr>
337
- <td><p><a name="ATK-STATE-VISITED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_VISITED</code></span></p></td>
338
- <td>Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited".
504
+ <td class="enum_member_name"><p><a name="ATK-STATE-VISITED:CAPS"></a>ATK_STATE_VISITED</p></td>
505
+ <td class="enum_member_description">
506
+ <p>Indicates that the object (typically a hyperlink) has already been 'activated', and/or its backing data has already been downloaded, rendered, or otherwise "visited".</p>
339
507
  </td>
508
+ <td class="enum_member_annotations"> </td>
340
509
  </tr>
341
510
  <tr>
342
- <td><p><a name="ATK-STATE-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATK_STATE_LAST_DEFINED</code></span></p></td>
343
- <td>Not a valid state, used for finding end of enumeration
511
+ <td class="enum_member_name"><p><a name="ATK-STATE-CHECKABLE:CAPS"></a>ATK_STATE_CHECKABLE</p></td>
512
+ <td class="enum_member_description">
513
+ <p>Indicates this object has the potential to be
514
+ checked, such as a checkbox or toggle-able table cell. <em class="parameter"><code>Since</code></em>
515
+ :
516
+ ATK-2.12</p>
344
517
  </td>
518
+ <td class="enum_member_annotations"> </td>
345
519
  </tr>
346
- </tbody>
347
- </table></div>
348
- </div>
349
- <hr>
350
- <div class="refsect2">
351
- <a name="AtkState"></a><h3>AtkState</h3>
352
- <pre class="programlisting">typedef guint64 AtkState;
353
- </pre>
354
- <p>
355
- </p>
356
- </div>
357
- <hr>
358
- <div class="refsect2">
359
- <a name="atk-state-type-register"></a><h3>atk_state_type_register ()</h3>
360
- <pre class="programlisting"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a> atk_state_type_register (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
361
- <p>
362
- Register a new object state.
363
- </p>
364
- <div class="variablelist"><table border="0">
365
- <col align="left" valign="top">
366
- <tbody>
367
520
  <tr>
368
- <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
369
- <td>a character string describing the new state.</td>
521
+ <td class="enum_member_name"><p><a name="ATK-STATE-HAS-POPUP:CAPS"></a>ATK_STATE_HAS_POPUP</p></td>
522
+ <td class="enum_member_description">
523
+ <p>Indicates that the object has a popup context
524
+ menu or sub-level menu which may or may not be showing. This means
525
+ that activation renders conditional content. Note that ordinary
526
+ tooltips are not considered popups in this context. <em class="parameter"><code>Since</code></em>
527
+ : ATK-2.12</p>
528
+ </td>
529
+ <td class="enum_member_annotations"> </td>
370
530
  </tr>
371
531
  <tr>
372
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
373
- <td>an <a class="link" href="atk-AtkState.html#AtkState" title="AtkState"><span class="type">AtkState</span></a> value for the new state.</td>
532
+ <td class="enum_member_name"><p><a name="ATK-STATE-LAST-DEFINED:CAPS"></a>ATK_STATE_LAST_DEFINED</p></td>
533
+ <td class="enum_member_description">
534
+ <p>Not a valid state, used for finding end of enumeration</p>
535
+ </td>
536
+ <td class="enum_member_annotations"> </td>
374
537
  </tr>
375
538
  </tbody>
376
539
  </table></div>
377
540
  </div>
378
- <hr>
379
- <div class="refsect2">
380
- <a name="atk-state-type-get-name"></a><h3>atk_state_type_get_name ()</h3>
381
- <pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_state_type_get_name (<em class="parameter"><code><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> type</code></em>);</pre>
382
- <p>
383
- Gets the description string describing the <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> <em class="parameter"><code>type</code></em>.
384
- </p>
385
- <div class="variablelist"><table border="0">
386
- <col align="left" valign="top">
387
- <tbody>
388
- <tr>
389
- <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
390
- <td>The <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> whose name is required</td>
391
- </tr>
392
- <tr>
393
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
394
- <td>the string describing the AtkStateType</td>
395
- </tr>
396
- </tbody>
397
- </table></div>
398
541
  </div>
399
542
  <hr>
400
543
  <div class="refsect2">
401
- <a name="atk-state-type-for-name"></a><h3>atk_state_type_for_name ()</h3>
402
- <pre class="programlisting"><a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="returnvalue">AtkStateType</span></a> atk_state_type_for_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
544
+ <a name="AtkState"></a><h3>AtkState</h3>
545
+ <pre class="programlisting">typedef guint64 AtkState;
546
+ </pre>
403
547
  <p>
404
- Gets the <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> corresponding to the description string <em class="parameter"><code>name</code></em>.
405
548
  </p>
406
- <div class="variablelist"><table border="0">
407
- <col align="left" valign="top">
408
- <tbody>
409
- <tr>
410
- <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
411
- <td>a character string state name</td>
412
- </tr>
413
- <tr>
414
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
415
- <td>an <a class="link" href="atk-AtkState.html#AtkStateType" title="enum AtkStateType"><span class="type">AtkStateType</span></a> corresponding to <em class="parameter"><code>name</code></em>
416
- </td>
417
- </tr>
418
- </tbody>
419
- </table></div>
420
549
  </div>
421
550
  </div>
422
551
  </div>
423
552
  <div class="footer">
424
553
  <hr>
425
- Generated by GTK-Doc V1.19.1</div>
554
+ Generated by GTK-Doc V1.21.1</div>
426
555
  </body>
427
556
  </html>