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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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,29 +2,27 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
- <title>AtkValue</title>
6
- <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
5
+ <title>ATK - Accessibility Toolkit: AtkValue</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="AtkUtil.html" title="AtkUtil">
8
+ <link rel="up" href="interfaces.html" title="ATK Interfaces">
9
+ <link rel="prev" href="AtkText.html" title="AtkText">
10
10
  <link rel="next" href="AtkWindow.html" title="AtkWindow">
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="#AtkValue.description" class="shortcut">Description</a>
20
-  | 
21
- <a href="#AtkValue.object-hierarchy" class="shortcut">Object Hierarchy</a>
22
-  | 
23
- <a href="#AtkValue.implementations" class="shortcut">Known Implementations</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="#AtkValue.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19
+ <a href="#AtkValue.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations">  <span class="dim">|</span> 
20
+ <a href="#AtkValue.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals">  <span class="dim">|</span> 
21
+ <a href="#AtkValue.signals" class="shortcut">Signals</a></span>
24
22
  </td>
25
23
  <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
26
- <td><a accesskey="u" href="atk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
27
- <td><a accesskey="p" href="AtkUtil.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24
+ <td><a accesskey="u" href="interfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25
+ <td><a accesskey="p" href="AtkText.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
28
26
  <td><a accesskey="n" href="AtkWindow.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
29
27
  </tr></table>
30
28
  <div class="refentry">
@@ -36,28 +34,131 @@
36
34
  components which display or select a value from a bounded range of
37
35
  values.</p>
38
36
  </td>
39
- <td valign="top" align="right"></td>
37
+ <td class="gallery_image" valign="top" align="right"></td>
40
38
  </tr></table></div>
41
- <div class="refsynopsisdiv">
42
- <a name="AtkValue.synopsis"></a><h2>Synopsis</h2>
43
- <pre class="synopsis"> <a class="link" href="AtkValue.html#AtkValue-struct" title="AtkValue">AtkValue</a>;
44
- <span class="returnvalue">void</span> <a class="link" href="AtkValue.html#atk-value-get-current-value" title="atk_value_get_current_value ()">atk_value_get_current_value</a> (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
45
- <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
46
- <span class="returnvalue">void</span> <a class="link" href="AtkValue.html#atk-value-get-maximum-value" title="atk_value_get_maximum_value ()">atk_value_get_maximum_value</a> (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
47
- <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
48
- <span class="returnvalue">void</span> <a class="link" href="AtkValue.html#atk-value-get-minimum-value" title="atk_value_get_minimum_value ()">atk_value_get_minimum_value</a> (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
49
- <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
50
- <span class="returnvalue">gboolean</span> <a class="link" href="AtkValue.html#atk-value-set-current-value" title="atk_value_set_current_value ()">atk_value_set_current_value</a> (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
51
- <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);
52
- <span class="returnvalue">void</span> <a class="link" href="AtkValue.html#atk-value-get-minimum-increment" title="atk_value_get_minimum_increment ()">atk_value_get_minimum_increment</a> (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
53
- <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);
54
- </pre>
39
+ <div class="refsect1">
40
+ <a name="AtkValue.functions"></a><h2>Functions</h2>
41
+ <div class="informaltable"><table width="100%" border="0">
42
+ <colgroup>
43
+ <col width="150px" class="functions_return">
44
+ <col class="functions_name">
45
+ </colgroup>
46
+ <tbody>
47
+ <tr>
48
+ <td class="function_type">
49
+ <span class="returnvalue">void</span>
50
+ </td>
51
+ <td class="function_name">
52
+ <a class="link" href="AtkValue.html#atk-value-get-current-value" title="atk_value_get_current_value ()">atk_value_get_current_value</a> <span class="c_punctuation">()</span>
53
+ </td>
54
+ </tr>
55
+ <tr>
56
+ <td class="function_type">
57
+ <span class="returnvalue">void</span>
58
+ </td>
59
+ <td class="function_name">
60
+ <a class="link" href="AtkValue.html#atk-value-get-maximum-value" title="atk_value_get_maximum_value ()">atk_value_get_maximum_value</a> <span class="c_punctuation">()</span>
61
+ </td>
62
+ </tr>
63
+ <tr>
64
+ <td class="function_type">
65
+ <span class="returnvalue">void</span>
66
+ </td>
67
+ <td class="function_name">
68
+ <a class="link" href="AtkValue.html#atk-value-get-minimum-value" title="atk_value_get_minimum_value ()">atk_value_get_minimum_value</a> <span class="c_punctuation">()</span>
69
+ </td>
70
+ </tr>
71
+ <tr>
72
+ <td class="function_type">
73
+ <span class="returnvalue">gboolean</span>
74
+ </td>
75
+ <td class="function_name">
76
+ <a class="link" href="AtkValue.html#atk-value-set-current-value" title="atk_value_set_current_value ()">atk_value_set_current_value</a> <span class="c_punctuation">()</span>
77
+ </td>
78
+ </tr>
79
+ <tr>
80
+ <td class="function_type">
81
+ <span class="returnvalue">void</span>
82
+ </td>
83
+ <td class="function_name">
84
+ <a class="link" href="AtkValue.html#atk-value-get-minimum-increment" title="atk_value_get_minimum_increment ()">atk_value_get_minimum_increment</a> <span class="c_punctuation">()</span>
85
+ </td>
86
+ </tr>
87
+ <tr>
88
+ <td class="function_type">
89
+ <span class="returnvalue">void</span>
90
+ </td>
91
+ <td class="function_name">
92
+ <a class="link" href="AtkValue.html#atk-value-get-value-and-text" title="atk_value_get_value_and_text ()">atk_value_get_value_and_text</a> <span class="c_punctuation">()</span>
93
+ </td>
94
+ </tr>
95
+ <tr>
96
+ <td class="function_type">
97
+ <span class="returnvalue">AtkRange</span> *
98
+ </td>
99
+ <td class="function_name">
100
+ <a class="link" href="AtkValue.html#atk-value-get-range" title="atk_value_get_range ()">atk_value_get_range</a> <span class="c_punctuation">()</span>
101
+ </td>
102
+ </tr>
103
+ <tr>
104
+ <td class="function_type">
105
+ <span class="returnvalue">gdouble</span>
106
+ </td>
107
+ <td class="function_name">
108
+ <a class="link" href="AtkValue.html#atk-value-get-increment" title="atk_value_get_increment ()">atk_value_get_increment</a> <span class="c_punctuation">()</span>
109
+ </td>
110
+ </tr>
111
+ <tr>
112
+ <td class="function_type">
113
+ <span class="returnvalue">GSList</span> *
114
+ </td>
115
+ <td class="function_name">
116
+ <a class="link" href="AtkValue.html#atk-value-get-sub-ranges" title="atk_value_get_sub_ranges ()">atk_value_get_sub_ranges</a> <span class="c_punctuation">()</span>
117
+ </td>
118
+ </tr>
119
+ <tr>
120
+ <td class="function_type">
121
+ <span class="returnvalue">void</span>
122
+ </td>
123
+ <td class="function_name">
124
+ <a class="link" href="AtkValue.html#atk-value-set-value" title="atk_value_set_value ()">atk_value_set_value</a> <span class="c_punctuation">()</span>
125
+ </td>
126
+ </tr>
127
+ </tbody>
128
+ </table></div>
129
+ </div>
130
+ <div class="refsect1">
131
+ <a name="AtkValue.signals"></a><h2>Signals</h2>
132
+ <div class="informaltable"><table border="0">
133
+ <colgroup>
134
+ <col width="150px" class="signals_return">
135
+ <col width="300px" class="signals_name">
136
+ <col width="200px" class="signals_flags">
137
+ </colgroup>
138
+ <tbody><tr>
139
+ <td class="signal_type"><span class="returnvalue">void</span></td>
140
+ <td class="signal_name"><a class="link" href="AtkValue.html#AtkValue-value-changed" title="The “value-changed” signal">value-changed</a></td>
141
+ <td class="signal_flags">Run Last</td>
142
+ </tr></tbody>
143
+ </table></div>
144
+ </div>
145
+ <div class="refsect1">
146
+ <a name="AtkValue.other"></a><h2>Types and Values</h2>
147
+ <div class="informaltable"><table width="100%" border="0">
148
+ <colgroup>
149
+ <col width="150px" class="name">
150
+ <col class="description">
151
+ </colgroup>
152
+ <tbody><tr>
153
+ <td class="datatype_keyword"> </td>
154
+ <td class="function_name"><a class="link" href="AtkValue.html#AtkValue-struct" title="AtkValue">AtkValue</a></td>
155
+ </tr></tbody>
156
+ </table></div>
55
157
  </div>
56
158
  <div class="refsect1">
57
159
  <a name="AtkValue.object-hierarchy"></a><h2>Object Hierarchy</h2>
58
- <pre class="synopsis">
59
- GInterface
60
- +----AtkValue
160
+ <pre class="screen"> GInterface
161
+ <span class="lineart">╰──</span> AtkValue
61
162
  </pre>
62
163
  </div>
63
164
  <div class="refsect1">
@@ -68,146 +169,575 @@ AtkValue is implemented by
68
169
  </div>
69
170
  <div class="refsect1">
70
171
  <a name="AtkValue.description"></a><h2>Description</h2>
71
- <p>
72
- <a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> should be implemented for components which either display
172
+ <p><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> should be implemented for components which either display
73
173
  a value from a bounded range, or which allow the user to specify a
74
- value from a bounded range, or both. For instance, most sliders
75
- and range controls, as well as dials, should have <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
174
+ value from a bounded range, or both. For instance, most sliders and
175
+ range controls, as well as dials, should have <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
76
176
  representations which implement <a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> on the component's
77
- behalf. <span class="type">AtKValues</span> may be read-only, in which case attempts to
78
- alter the value return FALSE to indicate failure.
177
+ behalf. <span class="type">AtKValues</span> may be read-only, in which case attempts to
178
+ alter the value return would fail.</p>
179
+ <div class="refsect1">
180
+ <a name="current-value-text"></a><h2>On the subject of current value text</h2>
181
+ <p>
182
+ In addition to providing the current value, implementors can
183
+ optionally provide an end-user-consumable textual description
184
+ associated with this value. This description should be included
185
+ when the numeric value fails to convey the full, on-screen
186
+ representation seen by users.
79
187
  </p>
188
+ <div class="example">
189
+ <a name="id-1.5.14.8.3.3"></a><p class="title"><b>Example 1. Password strength</b></p>
190
+ <div class="example-contents">
191
+ A password strength meter whose value changes as the user types
192
+ their new password. Red is used for values less than 4.0, yellow
193
+ for values between 4.0 and 7.0, and green for values greater than
194
+ 7.0. In this instance, value text should be provided by the
195
+ implementor. Appropriate value text would be "weak", "acceptable,"
196
+ and "strong" respectively.
80
197
  </div>
81
- <div class="refsect1">
82
- <a name="AtkValue.details"></a><h2>Details</h2>
198
+ </div>
199
+ <br class="example-break">
200
+
201
+ A level bar whose value changes to reflect the battery charge. The
202
+ color remains the same regardless of the charge and there is no
203
+ on-screen text reflecting the fullness of the battery. In this
204
+ case, because the position within the bar is the only indication
205
+ the user has of the current charge, value text should not be
206
+ provided by the implementor.
207
+
83
208
  <div class="refsect2">
84
- <a name="AtkValue-struct"></a><h3>AtkValue</h3>
85
- <pre class="programlisting">typedef struct _AtkValue AtkValue;</pre>
209
+ <a name="implementor-notes"></a><h3>Implementor Notes</h3>
86
210
  <p>
211
+ Implementors should bear in mind that assistive technologies will
212
+ likely prefer the value text provided over the numeric value when
213
+ presenting a widget's value. As a result, strings not intended for
214
+ end users should not be exposed in the value text, and strings
215
+ which are exposed should be localized. In the case of widgets which
216
+ display value text on screen, for instance through a separate label
217
+ in close proximity to the value-displaying widget, it is still
218
+ expected that implementors will expose the value text using the
219
+ above API.
220
+ </p>
221
+ <p>
222
+ <a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> should NOT be implemented for widgets whose displayed
223
+ value is not reflective of a meaningful amount. For instance, a
224
+ progress pulse indicator whose value alternates between 0.0 and 1.0
225
+ to indicate that some process is still taking place should not
226
+ implement <a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> because the current value does not reflect
227
+ progress towards completion.
87
228
  </p>
88
229
  </div>
89
- <hr>
230
+ </div>
231
+ <div class="refsect1">
232
+ <a name="ranges"></a><h2>On the subject of ranges</h2>
233
+ <p>
234
+ In addition to providing the minimum and maximum values,
235
+ implementors can optionally provide details about subranges
236
+ associated with the widget. These details should be provided by the
237
+ implementor when both of the following are communicated visually to
238
+ the end user:
239
+ </p>
240
+ <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
241
+ <li class="listitem">The existence of distinct ranges such as "weak",
242
+ "acceptable", and "strong" indicated by color, bar tick marks,
243
+ and/or on-screen text.</li>
244
+ <li class="listitem">Where the current value stands within a given subrange,
245
+ for instance illustrating progression from very "weak" towards
246
+ nearly "acceptable" through changes in shade and/or position on
247
+ the bar within the "weak" subrange.</li>
248
+ </ul></div>
249
+ <p>
250
+ If both of the above do not apply to the widget, it should be
251
+ sufficient to expose the numeric value, along with the value text
252
+ if appropriate, to make the widget accessible.
253
+ </p>
90
254
  <div class="refsect2">
91
- <a name="atk-value-get-current-value"></a><h3>atk_value_get_current_value ()</h3>
92
- <pre class="programlisting"><span class="returnvalue">void</span> atk_value_get_current_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
93
- <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
255
+ <a name="ranges-implementor-notes"></a><h3>Implementor Notes</h3>
256
+ <p>
257
+ If providing subrange details is deemed necessary, all possible
258
+ values of the widget are expected to fall within one of the
259
+ subranges defined by the implementor.
260
+ </p>
261
+ </div>
262
+ </div>
263
+ <div class="refsect1">
264
+ <a name="localization"></a><h2>On the subject of localization of end-user-consumable text
265
+ values</h2>
266
+ <p>
267
+ Because value text and subrange descriptors are human-consumable,
268
+ implementors are expected to provide localized strings which can be
269
+ directly presented to end users via their assistive technology. In
270
+ order to simplify this for implementors, implementors can use
271
+ <code class="function">atk_value_type_get_localized_name()</code> with the following
272
+ already-localized constants for commonly-needed values can be used:
273
+ </p>
274
+ <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
275
+ <li class="listitem">ATK_VALUE_VERY_WEAK</li>
276
+ <li class="listitem">ATK_VALUE_WEAK</li>
277
+ <li class="listitem">ATK_VALUE_ACCEPTABLE</li>
278
+ <li class="listitem">ATK_VALUE_STRONG</li>
279
+ <li class="listitem">ATK_VALUE_VERY_STRONG</li>
280
+ <li class="listitem">ATK_VALUE_VERY_LOW</li>
281
+ <li class="listitem">ATK_VALUE_LOW</li>
282
+ <li class="listitem">ATK_VALUE_MEDIUM</li>
283
+ <li class="listitem">ATK_VALUE_HIGH</li>
284
+ <li class="listitem">ATK_VALUE_VERY_HIGH</li>
285
+ <li class="listitem">ATK_VALUE_VERY_BAD</li>
286
+ <li class="listitem">ATK_VALUE_BAD</li>
287
+ <li class="listitem">ATK_VALUE_GOOD</li>
288
+ <li class="listitem">ATK_VALUE_VERY_GOOD</li>
289
+ <li class="listitem">ATK_VALUE_BEST</li>
290
+ <li class="listitem">ATK_VALUE_SUBSUBOPTIMAL</li>
291
+ <li class="listitem">ATK_VALUE_SUBOPTIMAL</li>
292
+ <li class="listitem">ATK_VALUE_OPTIMAL</li>
293
+ </ul></div>
294
+ <p>
295
+ Proposals for additional constants, along with their use cases,
296
+ should be submitted to the GNOME Accessibility Team.
297
+ </p>
298
+ </div>
299
+ <div class="refsect1">
300
+ <a name="changes"></a><h2>On the subject of changes</h2>
94
301
  <p>
95
- Gets the value of this object.
302
+ Note that if there is a textual description associated with the new
303
+ numeric value, that description should be included regardless of
304
+ whether or not it has also changed.
96
305
  </p>
97
- <div class="variablelist"><table border="0">
98
- <col align="left" valign="top">
306
+ </div>
307
+ </div>
308
+ <div class="refsect1">
309
+ <a name="AtkValue.functions_details"></a><h2>Functions</h2>
310
+ <div class="refsect2">
311
+ <a name="atk-value-get-current-value"></a><h3>atk_value_get_current_value ()</h3>
312
+ <pre class="programlisting"><span class="returnvalue">void</span>
313
+ atk_value_get_current_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
314
+ <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
315
+ <div class="warning">
316
+ <p><code class="literal">atk_value_get_current_value</code> is deprecated and should not be used in newly-written code.</p>
317
+ <p>Since 2.12. Use <a class="link" href="AtkValue.html#atk-value-get-value-and-text" title="atk_value_get_value_and_text ()"><code class="function">atk_value_get_value_and_text()</code></a>
318
+ instead.</p>
319
+ </div>
320
+ <p>Gets the value of this object.</p>
321
+ <div class="refsect3">
322
+ <a name="id-1.5.14.9.2.6"></a><h4>Parameters</h4>
323
+ <div class="informaltable"><table width="100%" border="0">
324
+ <colgroup>
325
+ <col width="150px" class="parameters_name">
326
+ <col class="parameters_description">
327
+ <col width="200px" class="parameters_annotations">
328
+ </colgroup>
99
329
  <tbody>
100
330
  <tr>
101
- <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
102
- <td>a GObject instance that implements AtkValueIface</td>
331
+ <td class="parameter_name"><p>obj</p></td>
332
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
333
+ <td class="parameter_annotations"> </td>
103
334
  </tr>
104
335
  <tr>
105
- <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
106
- <td>a <span class="type">GValue</span> representing the current accessible value</td>
336
+ <td class="parameter_name"><p>value</p></td>
337
+ <td class="parameter_description"><p>a <span class="type">GValue</span> representing the current accessible value</p></td>
338
+ <td class="parameter_annotations"> </td>
107
339
  </tr>
108
340
  </tbody>
109
341
  </table></div>
110
342
  </div>
343
+ </div>
111
344
  <hr>
112
345
  <div class="refsect2">
113
- <a name="atk-value-get-maximum-value"></a><h3>atk_value_get_maximum_value ()</h3>
114
- <pre class="programlisting"><span class="returnvalue">void</span> atk_value_get_maximum_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
115
- <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
116
- <p>
117
- Gets the maximum value of this object.
118
- </p>
119
- <div class="variablelist"><table border="0">
120
- <col align="left" valign="top">
346
+ <a name="atk-value-get-maximum-value"></a><h3>atk_value_get_maximum_value ()</h3>
347
+ <pre class="programlisting"><span class="returnvalue">void</span>
348
+ atk_value_get_maximum_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
349
+ <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
350
+ <div class="warning">
351
+ <p><code class="literal">atk_value_get_maximum_value</code> is deprecated and should not be used in newly-written code.</p>
352
+ <p>Since 2.12. Use <a class="link" href="AtkValue.html#atk-value-get-range" title="atk_value_get_range ()"><code class="function">atk_value_get_range()</code></a> instead.</p>
353
+ </div>
354
+ <p>Gets the maximum value of this object.</p>
355
+ <div class="refsect3">
356
+ <a name="id-1.5.14.9.3.6"></a><h4>Parameters</h4>
357
+ <div class="informaltable"><table width="100%" border="0">
358
+ <colgroup>
359
+ <col width="150px" class="parameters_name">
360
+ <col class="parameters_description">
361
+ <col width="200px" class="parameters_annotations">
362
+ </colgroup>
121
363
  <tbody>
122
364
  <tr>
123
- <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
124
- <td>a GObject instance that implements AtkValueIface</td>
365
+ <td class="parameter_name"><p>obj</p></td>
366
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
367
+ <td class="parameter_annotations"> </td>
125
368
  </tr>
126
369
  <tr>
127
- <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
128
- <td>a <span class="type">GValue</span> representing the maximum accessible value</td>
370
+ <td class="parameter_name"><p>value</p></td>
371
+ <td class="parameter_description"><p>a <span class="type">GValue</span> representing the maximum accessible value</p></td>
372
+ <td class="parameter_annotations"> </td>
129
373
  </tr>
130
374
  </tbody>
131
375
  </table></div>
132
376
  </div>
377
+ </div>
133
378
  <hr>
134
379
  <div class="refsect2">
135
- <a name="atk-value-get-minimum-value"></a><h3>atk_value_get_minimum_value ()</h3>
136
- <pre class="programlisting"><span class="returnvalue">void</span> atk_value_get_minimum_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
137
- <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
138
- <p>
139
- Gets the minimum value of this object.
140
- </p>
141
- <div class="variablelist"><table border="0">
142
- <col align="left" valign="top">
380
+ <a name="atk-value-get-minimum-value"></a><h3>atk_value_get_minimum_value ()</h3>
381
+ <pre class="programlisting"><span class="returnvalue">void</span>
382
+ atk_value_get_minimum_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
383
+ <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
384
+ <div class="warning">
385
+ <p><code class="literal">atk_value_get_minimum_value</code> is deprecated and should not be used in newly-written code.</p>
386
+ <p>Since 2.12. Use <a class="link" href="AtkValue.html#atk-value-get-range" title="atk_value_get_range ()"><code class="function">atk_value_get_range()</code></a> instead.</p>
387
+ </div>
388
+ <p>Gets the minimum value of this object.</p>
389
+ <div class="refsect3">
390
+ <a name="id-1.5.14.9.4.6"></a><h4>Parameters</h4>
391
+ <div class="informaltable"><table width="100%" border="0">
392
+ <colgroup>
393
+ <col width="150px" class="parameters_name">
394
+ <col class="parameters_description">
395
+ <col width="200px" class="parameters_annotations">
396
+ </colgroup>
143
397
  <tbody>
144
398
  <tr>
145
- <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
146
- <td>a GObject instance that implements AtkValueIface</td>
399
+ <td class="parameter_name"><p>obj</p></td>
400
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
401
+ <td class="parameter_annotations"> </td>
147
402
  </tr>
148
403
  <tr>
149
- <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
150
- <td>a <span class="type">GValue</span> representing the minimum accessible value</td>
404
+ <td class="parameter_name"><p>value</p></td>
405
+ <td class="parameter_description"><p>a <span class="type">GValue</span> representing the minimum accessible value</p></td>
406
+ <td class="parameter_annotations"> </td>
151
407
  </tr>
152
408
  </tbody>
153
409
  </table></div>
154
410
  </div>
411
+ </div>
155
412
  <hr>
156
413
  <div class="refsect2">
157
- <a name="atk-value-set-current-value"></a><h3>atk_value_set_current_value ()</h3>
158
- <pre class="programlisting"><span class="returnvalue">gboolean</span> atk_value_set_current_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
159
- <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
160
- <p>
161
- Sets the value of this object.
162
- </p>
163
- <div class="variablelist"><table border="0">
164
- <col align="left" valign="top">
414
+ <a name="atk-value-set-current-value"></a><h3>atk_value_set_current_value ()</h3>
415
+ <pre class="programlisting"><span class="returnvalue">gboolean</span>
416
+ atk_value_set_current_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
417
+ <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
418
+ <div class="warning">
419
+ <p><code class="literal">atk_value_set_current_value</code> is deprecated and should not be used in newly-written code.</p>
420
+ <p>Since 2.12. Use <a class="link" href="AtkValue.html#atk-value-set-value" title="atk_value_set_value ()"><code class="function">atk_value_set_value()</code></a> instead.</p>
421
+ </div>
422
+ <p>Sets the value of this object.</p>
423
+ <div class="refsect3">
424
+ <a name="id-1.5.14.9.5.6"></a><h4>Parameters</h4>
425
+ <div class="informaltable"><table width="100%" border="0">
426
+ <colgroup>
427
+ <col width="150px" class="parameters_name">
428
+ <col class="parameters_description">
429
+ <col width="200px" class="parameters_annotations">
430
+ </colgroup>
165
431
  <tbody>
166
432
  <tr>
167
- <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
168
- <td>a GObject instance that implements AtkValueIface</td>
433
+ <td class="parameter_name"><p>obj</p></td>
434
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
435
+ <td class="parameter_annotations"> </td>
169
436
  </tr>
170
437
  <tr>
171
- <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
172
- <td>a <span class="type">GValue</span> which is the desired new accessible value.</td>
438
+ <td class="parameter_name"><p>value</p></td>
439
+ <td class="parameter_description"><p>a <span class="type">GValue</span> which is the desired new accessible value.</p></td>
440
+ <td class="parameter_annotations"> </td>
441
+ </tr>
442
+ </tbody>
443
+ </table></div>
444
+ </div>
445
+ <div class="refsect3">
446
+ <a name="id-1.5.14.9.5.7"></a><h4>Returns</h4>
447
+ <p> <code class="literal">TRUE</code> if new value is successfully set, <code class="literal">FALSE</code> otherwise.</p>
448
+ <p></p>
449
+ </div>
450
+ </div>
451
+ <hr>
452
+ <div class="refsect2">
453
+ <a name="atk-value-get-minimum-increment"></a><h3>atk_value_get_minimum_increment ()</h3>
454
+ <pre class="programlisting"><span class="returnvalue">void</span>
455
+ atk_value_get_minimum_increment (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
456
+ <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
457
+ <div class="warning">
458
+ <p><code class="literal">atk_value_get_minimum_increment</code> is deprecated and should not be used in newly-written code.</p>
459
+ <p>Since 2.12. Use <a class="link" href="AtkValue.html#atk-value-get-increment" title="atk_value_get_increment ()"><code class="function">atk_value_get_increment()</code></a> instead.</p>
460
+ </div>
461
+ <p>Gets the minimum increment by which the value of this object may be changed. If zero,
462
+ the minimum increment is undefined, which may mean that it is limited only by the
463
+ floating point precision of the platform.</p>
464
+ <div class="refsect3">
465
+ <a name="id-1.5.14.9.6.7"></a><h4>Parameters</h4>
466
+ <div class="informaltable"><table width="100%" border="0">
467
+ <colgroup>
468
+ <col width="150px" class="parameters_name">
469
+ <col class="parameters_description">
470
+ <col width="200px" class="parameters_annotations">
471
+ </colgroup>
472
+ <tbody>
473
+ <tr>
474
+ <td class="parameter_name"><p>obj</p></td>
475
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
476
+ <td class="parameter_annotations"> </td>
477
+ </tr>
478
+ <tr>
479
+ <td class="parameter_name"><p>value</p></td>
480
+ <td class="parameter_description"><p>a <span class="type">GValue</span> representing the minimum increment by which the accessible value may be changed</p></td>
481
+ <td class="parameter_annotations"> </td>
482
+ </tr>
483
+ </tbody>
484
+ </table></div>
485
+ </div>
486
+ <p class="since">Since 1.12</p>
487
+ </div>
488
+ <hr>
489
+ <div class="refsect2">
490
+ <a name="atk-value-get-value-and-text"></a><h3>atk_value_get_value_and_text ()</h3>
491
+ <pre class="programlisting"><span class="returnvalue">void</span>
492
+ atk_value_get_value_and_text (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
493
+ <em class="parameter"><code><span class="type">gdouble</span> *value</code></em>,
494
+ <em class="parameter"><code><span class="type">gchar</span> **text</code></em>);</pre>
495
+ <p>Gets the current value and the human readable text alternative of
496
+ <em class="parameter"><code>obj</code></em>
497
+ . <em class="parameter"><code>text</code></em>
498
+ is a newly created string, that must be freed by the
499
+ caller. Can be NULL if not descriptor is available.</p>
500
+ <div class="refsect3">
501
+ <a name="id-1.5.14.9.7.5"></a><h4>Parameters</h4>
502
+ <div class="informaltable"><table width="100%" border="0">
503
+ <colgroup>
504
+ <col width="150px" class="parameters_name">
505
+ <col class="parameters_description">
506
+ <col width="200px" class="parameters_annotations">
507
+ </colgroup>
508
+ <tbody>
509
+ <tr>
510
+ <td class="parameter_name"><p>obj</p></td>
511
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
512
+ <td class="parameter_annotations"> </td>
173
513
  </tr>
174
514
  <tr>
175
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
176
- <td>
177
- <code class="literal">TRUE</code> if new value is successfully set, <code class="literal">FALSE</code> otherwise.</td>
515
+ <td class="parameter_name"><p>value</p></td>
516
+ <td class="parameter_description"><p> address of <span class="type">gdouble</span> to put the current value of <em class="parameter"><code>obj</code></em>
517
+ . </p></td>
518
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
519
+ </tr>
520
+ <tr>
521
+ <td class="parameter_name"><p>text</p></td>
522
+ <td class="parameter_description"><p> address of <span class="type">gchar</span> to put the human
523
+ readable text alternative for <em class="parameter"><code>value</code></em>
524
+ . </p></td>
525
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
178
526
  </tr>
179
527
  </tbody>
180
528
  </table></div>
181
529
  </div>
530
+ <p class="since">Since 2.12</p>
531
+ </div>
532
+ <hr>
533
+ <div class="refsect2">
534
+ <a name="atk-value-get-range"></a><h3>atk_value_get_range ()</h3>
535
+ <pre class="programlisting"><span class="returnvalue">AtkRange</span> *
536
+ atk_value_get_range (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>);</pre>
537
+ <p>Gets the range of this object.</p>
538
+ <div class="refsect3">
539
+ <a name="id-1.5.14.9.8.5"></a><h4>Parameters</h4>
540
+ <div class="informaltable"><table width="100%" border="0">
541
+ <colgroup>
542
+ <col width="150px" class="parameters_name">
543
+ <col class="parameters_description">
544
+ <col width="200px" class="parameters_annotations">
545
+ </colgroup>
546
+ <tbody><tr>
547
+ <td class="parameter_name"><p>obj</p></td>
548
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
549
+ <td class="parameter_annotations"> </td>
550
+ </tr></tbody>
551
+ </table></div>
552
+ </div>
553
+ <div class="refsect3">
554
+ <a name="id-1.5.14.9.8.6"></a><h4>Returns</h4>
555
+ <p> a newly allocated <span class="type">AtkRange</span>
556
+ that represents the minimum, maximum and descriptor (if available)
557
+ of <em class="parameter"><code>obj</code></em>
558
+ . NULL if that range is not defined. </p>
559
+ <p><span class="annotation">[<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
560
+ </div>
561
+ <p class="since">Since 2.12</p>
562
+ </div>
182
563
  <hr>
183
564
  <div class="refsect2">
184
- <a name="atk-value-get-minimum-increment"></a><h3>atk_value_get_minimum_increment ()</h3>
185
- <pre class="programlisting"><span class="returnvalue">void</span> atk_value_get_minimum_increment (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
186
- <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
565
+ <a name="atk-value-get-increment"></a><h3>atk_value_get_increment ()</h3>
566
+ <pre class="programlisting"><span class="returnvalue">gdouble</span>
567
+ atk_value_get_increment (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>);</pre>
568
+ <p>Gets the minimum increment by which the value of this object may be
569
+ changed. If zero, the minimum increment is undefined, which may
570
+ mean that it is limited only by the floating point precision of the
571
+ platform.</p>
572
+ <div class="refsect3">
573
+ <a name="id-1.5.14.9.9.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>
580
+ <tbody><tr>
581
+ <td class="parameter_name"><p>obj</p></td>
582
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
583
+ <td class="parameter_annotations"> </td>
584
+ </tr></tbody>
585
+ </table></div>
586
+ </div>
587
+ <div class="refsect3">
588
+ <a name="id-1.5.14.9.9.6"></a><h4>Returns</h4>
589
+ <p> the minimum increment by which the value of this
590
+ object may be changed. zero if undefined.</p>
591
+ <p></p>
592
+ </div>
593
+ <p class="since">Since 2.12</p>
594
+ </div>
595
+ <hr>
596
+ <div class="refsect2">
597
+ <a name="atk-value-get-sub-ranges"></a><h3>atk_value_get_sub_ranges ()</h3>
598
+ <pre class="programlisting"><span class="returnvalue">GSList</span> *
599
+ atk_value_get_sub_ranges (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>);</pre>
600
+ <p>Gets the list of subranges defined for this object. See <a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a>
601
+ introduction for examples of subranges and when to expose them.</p>
602
+ <div class="refsect3">
603
+ <a name="id-1.5.14.9.10.5"></a><h4>Parameters</h4>
604
+ <div class="informaltable"><table width="100%" border="0">
605
+ <colgroup>
606
+ <col width="150px" class="parameters_name">
607
+ <col class="parameters_description">
608
+ <col width="200px" class="parameters_annotations">
609
+ </colgroup>
610
+ <tbody><tr>
611
+ <td class="parameter_name"><p>obj</p></td>
612
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
613
+ <td class="parameter_annotations"> </td>
614
+ </tr></tbody>
615
+ </table></div>
616
+ </div>
617
+ <div class="refsect3">
618
+ <a name="id-1.5.14.9.10.6"></a><h4>Returns</h4>
619
+ <p> an <span class="type">GSList</span> of
620
+ <span class="type">AtkRange</span> which each of the subranges defined for this object. Free
621
+ the returns list with <code class="function">g_slist_free()</code>. </p>
622
+ <p><span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> AtkRange][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
623
+ </div>
624
+ <p class="since">Since 2.12</p>
625
+ </div>
626
+ <hr>
627
+ <div class="refsect2">
628
+ <a name="atk-value-set-value"></a><h3>atk_value_set_value ()</h3>
629
+ <pre class="programlisting"><span class="returnvalue">void</span>
630
+ atk_value_set_value (<em class="parameter"><code><a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *obj</code></em>,
631
+ <em class="parameter"><code>const <span class="type">gdouble</span> new_value</code></em>);</pre>
632
+ <p>Sets the value of this object.</p>
633
+ <p>This method is intended to provide a way to change the value of the
634
+ object. In any case, it is possible that the value can't be
635
+ modified (ie: a read-only component). If the value changes due this
636
+ call, it is possible that the text could change, and will trigger
637
+ an <a class="link" href="AtkValue.html#AtkValue-value-changed" title="The “value-changed” signal"><span class="type">“value-changed”</span></a> signal emission.</p>
638
+ <p>Note for implementors: the deprecated <a class="link" href="AtkValue.html#atk-value-set-current-value" title="atk_value_set_current_value ()"><code class="function">atk_value_set_current_value()</code></a>
639
+ method returned TRUE or FALSE depending if the value was assigned
640
+ or not. In the practice several implementors were not able to
641
+ decide it, and returned TRUE in any case. For that reason it is not
642
+ required anymore to return if the value was properly assigned or
643
+ not.</p>
644
+ <div class="refsect3">
645
+ <a name="id-1.5.14.9.11.7"></a><h4>Parameters</h4>
646
+ <div class="informaltable"><table width="100%" border="0">
647
+ <colgroup>
648
+ <col width="150px" class="parameters_name">
649
+ <col class="parameters_description">
650
+ <col width="200px" class="parameters_annotations">
651
+ </colgroup>
652
+ <tbody>
653
+ <tr>
654
+ <td class="parameter_name"><p>obj</p></td>
655
+ <td class="parameter_description"><p>a GObject instance that implements AtkValueIface</p></td>
656
+ <td class="parameter_annotations"> </td>
657
+ </tr>
658
+ <tr>
659
+ <td class="parameter_name"><p>new_value</p></td>
660
+ <td class="parameter_description"><p>a double which is the desired new accessible value.</p></td>
661
+ <td class="parameter_annotations"> </td>
662
+ </tr>
663
+ </tbody>
664
+ </table></div>
665
+ </div>
666
+ <p class="since">Since 2.12</p>
667
+ </div>
668
+ </div>
669
+ <div class="refsect1">
670
+ <a name="AtkValue.other_details"></a><h2>Types and Values</h2>
671
+ <div class="refsect2">
672
+ <a name="AtkValue-struct"></a><h3>AtkValue</h3>
673
+ <pre class="programlisting">typedef struct _AtkValue AtkValue;</pre>
187
674
  <p>
188
- Gets the minimum increment by which the value of this object may be changed. If zero,
189
- the minimum increment is undefined, which may mean that it is limited only by the
190
- floating point precision of the platform.
191
675
  </p>
192
- <div class="variablelist"><table border="0">
193
- <col align="left" valign="top">
676
+ </div>
677
+ </div>
678
+ <div class="refsect1">
679
+ <a name="AtkValue.signal-details"></a><h2>Signal Details</h2>
680
+ <div class="refsect2">
681
+ <a name="AtkValue-value-changed"></a><h3>The <code class="literal">“value-changed”</code> signal</h3>
682
+ <pre class="programlisting"><span class="returnvalue">void</span>
683
+ user_function (<a class="link" href="AtkValue.html" title="AtkValue"><span class="type">AtkValue</span></a> *atkvalue,
684
+ <span class="type">gdouble</span> value,
685
+ <span class="type">gchar</span> *text,
686
+ <span class="type">gpointer</span> user_data)</pre>
687
+ <p>The 'value-changed' signal is emitted when the current value
688
+ that represent the object changes. <em class="parameter"><code>value</code></em>
689
+ is the numerical
690
+ representation of this new value. <em class="parameter"><code>text</code></em>
691
+ is the human
692
+ readable text alternative of <em class="parameter"><code>value</code></em>
693
+ , and can be NULL if it is
694
+ not available. Note that if there is a textual description
695
+ associated with the new numeric value, that description
696
+ should be included regardless of whether or not it has also
697
+ changed.</p>
698
+ <p>Example: a password meter whose value changes as the user
699
+ types their new password. Appropiate value text would be
700
+ "weak", "acceptable" and "strong".</p>
701
+ <div class="refsect3">
702
+ <a name="id-1.5.14.11.2.6"></a><h4>Parameters</h4>
703
+ <div class="informaltable"><table width="100%" border="0">
704
+ <colgroup>
705
+ <col width="150px" class="parameters_name">
706
+ <col class="parameters_description">
707
+ <col width="200px" class="parameters_annotations">
708
+ </colgroup>
194
709
  <tbody>
195
710
  <tr>
196
- <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
197
- <td>a GObject instance that implements AtkValueIface</td>
711
+ <td class="parameter_name"><p>atkvalue</p></td>
712
+ <td class="parameter_description"><p>the object on which the signal was emitted.</p></td>
713
+ <td class="parameter_annotations"> </td>
714
+ </tr>
715
+ <tr>
716
+ <td class="parameter_name"><p>value</p></td>
717
+ <td class="parameter_description"><p>the new value in a numerical form.</p></td>
718
+ <td class="parameter_annotations"> </td>
719
+ </tr>
720
+ <tr>
721
+ <td class="parameter_name"><p>text</p></td>
722
+ <td class="parameter_description"><p>human readable text alternative (also called
723
+ description) of this object. NULL if not available.</p></td>
724
+ <td class="parameter_annotations"> </td>
198
725
  </tr>
199
726
  <tr>
200
- <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
201
- <td>a <span class="type">GValue</span> representing the minimum increment by which the accessible value may be changed</td>
727
+ <td class="parameter_name"><p>user_data</p></td>
728
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
729
+ <td class="parameter_annotations"> </td>
202
730
  </tr>
203
731
  </tbody>
204
732
  </table></div>
205
- <p class="since">Since 1.12</p>
733
+ </div>
734
+ <p>Flags: Run Last</p>
735
+ <p class="since">Since 2.12</p>
206
736
  </div>
207
737
  </div>
208
738
  </div>
209
739
  <div class="footer">
210
740
  <hr>
211
- Generated by GTK-Doc V1.19.1</div>
741
+ Generated by GTK-Doc V1.21.1</div>
212
742
  </body>
213
743
  </html>