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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/Rakefile +1 -1
  3. data/lib/2.0/atk.so +0 -0
  4. data/vendor/local/bin/libatk-1.0-0.dll +0 -0
  5. data/vendor/local/include/atk-1.0/atk/atk-enum-types.h +16 -0
  6. data/vendor/local/include/atk-1.0/atk/atk.h +3 -0
  7. data/vendor/local/include/atk-1.0/atk/atkaction.h +8 -1
  8. data/vendor/local/include/atk-1.0/atk/atkcomponent.h +20 -2
  9. data/vendor/local/include/atk-1.0/atk/atkdocument.h +29 -2
  10. data/vendor/local/include/atk-1.0/atk/atkeditabletext.h +8 -0
  11. data/vendor/local/include/atk-1.0/atk/atkgobjectaccessible.h +3 -0
  12. data/vendor/local/include/atk-1.0/atk/atkhyperlink.h +9 -1
  13. data/vendor/local/include/atk-1.0/atk/atkhyperlinkimpl.h +2 -0
  14. data/vendor/local/include/atk-1.0/atk/atkhypertext.h +4 -0
  15. data/vendor/local/include/atk-1.0/atk/atkimage.h +6 -0
  16. data/vendor/local/include/atk-1.0/atk/atkmisc.h +19 -19
  17. data/vendor/local/include/atk-1.0/atk/atknoopobject.h +4 -0
  18. data/vendor/local/include/atk-1.0/atk/atknoopobjectfactory.h +2 -0
  19. data/vendor/local/include/atk-1.0/atk/atkobject.h +133 -26
  20. data/vendor/local/include/atk-1.0/atk/atkobjectfactory.h +5 -0
  21. data/vendor/local/include/atk-1.0/atk/atkplug.h +5 -0
  22. data/vendor/local/include/atk-1.0/atk/atkrange.h +59 -0
  23. data/vendor/local/include/atk-1.0/atk/atkregistry.h +5 -15
  24. data/vendor/local/include/atk-1.0/atk/atkrelation.h +10 -0
  25. data/vendor/local/include/atk-1.0/atk/atkrelationset.h +10 -0
  26. data/vendor/local/include/atk-1.0/atk/atkselection.h +8 -0
  27. data/vendor/local/include/atk-1.0/atk/atksocket.h +6 -0
  28. data/vendor/local/include/atk-1.0/atk/atkstate.h +14 -2
  29. data/vendor/local/include/atk-1.0/atk/atkstateset.h +12 -0
  30. data/vendor/local/include/atk-1.0/atk/atkstreamablecontent.h +6 -1
  31. data/vendor/local/include/atk-1.0/atk/atktable.h +30 -6
  32. data/vendor/local/include/atk-1.0/atk/atktablecell.h +104 -0
  33. data/vendor/local/include/atk-1.0/atk/atktext.h +30 -5
  34. data/vendor/local/include/atk-1.0/atk/atkutil.h +35 -4
  35. data/vendor/local/include/atk-1.0/atk/atkvalue.h +88 -17
  36. data/vendor/local/include/atk-1.0/atk/atkversion.h +281 -2
  37. data/vendor/local/include/atk-1.0/atk/atkwindow.h +1 -0
  38. data/vendor/local/lib/girepository-1.0/Atk-1.0.typelib +0 -0
  39. data/vendor/local/lib/libatk-1.0.dll.a +0 -0
  40. data/vendor/local/lib/libatk-1.0.la +3 -3
  41. data/vendor/local/lib/pkgconfig/atk.pc +1 -1
  42. data/vendor/local/share/gir-1.0/Atk-1.0.gir +3410 -899
  43. data/vendor/local/share/gtk-doc/html/atk/AtkAction.html +343 -233
  44. data/vendor/local/share/gtk-doc/html/atk/AtkComponent.html +872 -578
  45. data/vendor/local/share/gtk-doc/html/atk/AtkDocument.html +558 -251
  46. data/vendor/local/share/gtk-doc/html/atk/AtkEditableText.html +298 -192
  47. data/vendor/local/share/gtk-doc/html/atk/AtkGObjectAccessible.html +117 -75
  48. data/vendor/local/share/gtk-doc/html/atk/AtkHyperlink.html +434 -273
  49. data/vendor/local/share/gtk-doc/html/atk/AtkHypertext.html +195 -119
  50. data/vendor/local/share/gtk-doc/html/atk/AtkImage.html +224 -143
  51. data/vendor/local/share/gtk-doc/html/atk/AtkMisc.html +191 -0
  52. data/vendor/local/share/gtk-doc/html/atk/AtkNoOpObject.html +83 -59
  53. data/vendor/local/share/gtk-doc/html/atk/AtkNoOpObjectFactory.html +66 -49
  54. data/vendor/local/share/gtk-doc/html/atk/AtkObject.html +2398 -1337
  55. data/vendor/local/share/gtk-doc/html/atk/AtkObjectFactory.html +154 -96
  56. data/vendor/local/share/gtk-doc/html/atk/AtkRegistry.html +192 -118
  57. data/vendor/local/share/gtk-doc/html/atk/AtkRelation.html +496 -278
  58. data/vendor/local/share/gtk-doc/html/atk/AtkRelationSet.html +294 -193
  59. data/vendor/local/share/gtk-doc/html/atk/AtkSelection.html +333 -201
  60. data/vendor/local/share/gtk-doc/html/atk/AtkStateSet.html +403 -256
  61. data/vendor/local/share/gtk-doc/html/atk/AtkStreamableContent.html +192 -130
  62. data/vendor/local/share/gtk-doc/html/atk/AtkTable.html +1363 -776
  63. data/vendor/local/share/gtk-doc/html/atk/AtkTableCell.html +497 -0
  64. data/vendor/local/share/gtk-doc/html/atk/AtkText.html +1975 -1446
  65. data/vendor/local/share/gtk-doc/html/atk/AtkUtil.html +862 -524
  66. data/vendor/local/share/gtk-doc/html/atk/AtkValue.html +638 -108
  67. data/vendor/local/share/gtk-doc/html/atk/AtkWindow.html +302 -175
  68. data/vendor/local/share/gtk-doc/html/atk/accessibles.html +49 -0
  69. data/vendor/local/share/gtk-doc/html/atk/api-index-1-12.html +18 -18
  70. data/vendor/local/share/gtk-doc/html/atk/api-index-1-13.html +21 -11
  71. data/vendor/local/share/gtk-doc/html/atk/api-index-1-20.html +11 -11
  72. data/vendor/local/share/gtk-doc/html/atk/api-index-1-22.html +10 -10
  73. data/vendor/local/share/gtk-doc/html/atk/api-index-1-3.html +11 -11
  74. data/vendor/local/share/gtk-doc/html/atk/api-index-1-30.html +15 -15
  75. data/vendor/local/share/gtk-doc/html/atk/api-index-1-4.html +9 -9
  76. data/vendor/local/share/gtk-doc/html/atk/api-index-1-6.html +11 -11
  77. data/vendor/local/share/gtk-doc/html/atk/api-index-1-9.html +39 -0
  78. data/vendor/local/share/gtk-doc/html/atk/api-index-2-10.html +35 -0
  79. data/vendor/local/share/gtk-doc/html/atk/api-index-2-12.html +78 -0
  80. data/vendor/local/share/gtk-doc/html/atk/api-index-2-2.html +53 -0
  81. data/vendor/local/share/gtk-doc/html/atk/api-index-2-8.html +47 -0
  82. data/vendor/local/share/gtk-doc/html/atk/api-index-deprecated.html +75 -25
  83. data/vendor/local/share/gtk-doc/html/atk/api-index-full.html +358 -288
  84. data/vendor/local/share/gtk-doc/html/atk/atk-AtkHyperlinkImpl.html +82 -60
  85. data/vendor/local/share/gtk-doc/html/atk/atk-AtkPlug.html +99 -52
  86. data/vendor/local/share/gtk-doc/html/atk/atk-AtkRange.html +328 -0
  87. data/vendor/local/share/gtk-doc/html/atk/atk-AtkSocket.html +139 -91
  88. data/vendor/local/share/gtk-doc/html/atk/atk-AtkState.html +355 -226
  89. data/vendor/local/share/gtk-doc/html/atk/atk-Versioning-Utilities.html +203 -142
  90. data/vendor/local/share/gtk-doc/html/atk/atk.devhelp2 +378 -547
  91. data/vendor/local/share/gtk-doc/html/atk/atkobject.html +33 -0
  92. data/vendor/local/share/gtk-doc/html/atk/data.html +49 -0
  93. data/vendor/local/share/gtk-doc/html/atk/deprecated.html +33 -0
  94. data/vendor/local/share/gtk-doc/html/atk/index.html +70 -46
  95. data/vendor/local/share/gtk-doc/html/atk/index.sgml +419 -519
  96. data/vendor/local/share/gtk-doc/html/atk/{atk.html → interfaces.html} +17 -60
  97. data/vendor/local/share/gtk-doc/html/atk/overview.html +47 -0
  98. data/vendor/local/share/gtk-doc/html/atk/style.css +260 -105
  99. data/vendor/local/share/gtk-doc/html/atk/toolkit.html +33 -0
  100. data/vendor/local/share/gtk-doc/html/atk/utilities.html +28 -14
  101. data/vendor/local/share/license/atk/AUTHORS +18 -5
  102. data/vendor/local/share/locale/an/LC_MESSAGES/atk10.mo +0 -0
  103. data/vendor/local/share/locale/as/LC_MESSAGES/atk10.mo +0 -0
  104. data/vendor/local/share/locale/ca/LC_MESSAGES/atk10.mo +0 -0
  105. data/vendor/local/share/locale/ca@valencia/LC_MESSAGES/atk10.mo +0 -0
  106. data/vendor/local/share/locale/cs/LC_MESSAGES/atk10.mo +0 -0
  107. data/vendor/local/share/locale/da/LC_MESSAGES/atk10.mo +0 -0
  108. data/vendor/local/share/locale/de/LC_MESSAGES/atk10.mo +0 -0
  109. data/vendor/local/share/locale/el/LC_MESSAGES/atk10.mo +0 -0
  110. data/vendor/local/share/locale/es/LC_MESSAGES/atk10.mo +0 -0
  111. data/vendor/local/share/locale/eu/LC_MESSAGES/atk10.mo +0 -0
  112. data/vendor/local/share/locale/fi/LC_MESSAGES/atk10.mo +0 -0
  113. data/vendor/local/share/locale/fr/LC_MESSAGES/atk10.mo +0 -0
  114. data/vendor/local/share/locale/gl/LC_MESSAGES/atk10.mo +0 -0
  115. data/vendor/local/share/locale/he/LC_MESSAGES/atk10.mo +0 -0
  116. data/vendor/local/share/locale/hu/LC_MESSAGES/atk10.mo +0 -0
  117. data/vendor/local/share/locale/id/LC_MESSAGES/atk10.mo +0 -0
  118. data/vendor/local/share/locale/it/LC_MESSAGES/atk10.mo +0 -0
  119. data/vendor/local/share/locale/ko/LC_MESSAGES/atk10.mo +0 -0
  120. data/vendor/local/share/locale/lt/LC_MESSAGES/atk10.mo +0 -0
  121. data/vendor/local/share/locale/lv/LC_MESSAGES/atk10.mo +0 -0
  122. data/vendor/local/share/locale/nb/LC_MESSAGES/atk10.mo +0 -0
  123. data/vendor/local/share/locale/pa/LC_MESSAGES/atk10.mo +0 -0
  124. data/vendor/local/share/locale/pl/LC_MESSAGES/atk10.mo +0 -0
  125. data/vendor/local/share/locale/pt/LC_MESSAGES/atk10.mo +0 -0
  126. data/vendor/local/share/locale/pt_BR/LC_MESSAGES/atk10.mo +0 -0
  127. data/vendor/local/share/locale/ru/LC_MESSAGES/atk10.mo +0 -0
  128. data/vendor/local/share/locale/sk/LC_MESSAGES/atk10.mo +0 -0
  129. data/vendor/local/share/locale/sl/LC_MESSAGES/atk10.mo +0 -0
  130. data/vendor/local/share/locale/sr/LC_MESSAGES/atk10.mo +0 -0
  131. data/vendor/local/share/locale/sr@latin/LC_MESSAGES/atk10.mo +0 -0
  132. data/vendor/local/share/locale/zh_CN/LC_MESSAGES/atk10.mo +0 -0
  133. data/vendor/local/share/locale/zh_HK/LC_MESSAGES/atk10.mo +0 -0
  134. data/vendor/local/share/locale/zh_TW/LC_MESSAGES/atk10.mo +0 -0
  135. metadata +27 -19
  136. data/lib/1.9/atk.so +0 -0
  137. data/lib/2.1/atk.so +0 -0
  138. data/vendor/local/lib/atk-1.0.def +0 -248
  139. data/vendor/local/share/gtk-doc/html/atk/api-index-1-18.html +0 -31
  140. data/vendor/local/share/gtk-doc/html/atk/api-index-1-24.html +0 -31
  141. data/vendor/local/share/gtk-doc/html/atk/api-index-1-26.html +0 -31
  142. data/vendor/local/share/gtk-doc/html/atk/api-index-1-28.html +0 -31
  143. data/vendor/local/share/gtk-doc/html/atk/api-index-1-32.html +0 -30
data/vendor/local/share/gtk-doc/html/atk/AtkText.html CHANGED
@@ -2,32 +2,28 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
- <title>AtkText</title>
6
- <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
5
+ <title>ATK - Accessibility Toolkit: AtkText</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="AtkTable.html" title="AtkTable">
10
- <link rel="next" href="AtkUtil.html" title="AtkUtil">
11
- <meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
8
+ <link rel="up" href="interfaces.html" title="ATK Interfaces">
9
+ <link rel="prev" href="AtkTableCell.html" title="AtkTableCell">
10
+ <link rel="next" href="AtkValue.html" title="AtkValue">
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="#AtkText.description" class="shortcut">Description</a>
20
-  | 
21
- <a href="#AtkText.object-hierarchy" class="shortcut">Object Hierarchy</a>
22
-  | 
23
- <a href="#AtkText.implementations" class="shortcut">Known Implementations</a>
24
-  | 
25
- <a href="#AtkText.signals" class="shortcut">Signals</a>
15
+ <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
+ <td width="100%" align="left" class="shortcuts">
17
+ <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18
+ <a href="#AtkText.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19
+ <a href="#AtkText.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations">  <span class="dim">|</span> 
20
+ <a href="#AtkText.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals">  <span class="dim">|</span> 
21
+ <a href="#AtkText.signals" class="shortcut">Signals</a></span>
26
22
  </td>
27
23
  <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
28
- <td><a accesskey="u" href="atk.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
29
- <td><a accesskey="p" href="AtkTable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
30
- <td><a accesskey="n" href="AtkUtil.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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="AtkTableCell.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26
+ <td><a accesskey="n" href="AtkValue.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
31
27
  </tr></table>
32
28
  <div class="refentry">
33
29
  <a name="AtkText"></a><div class="titlepage"></div>
@@ -37,1982 +33,2515 @@
37
33
  <p>AtkText — The ATK interface implemented by components
38
34
  with text content.</p>
39
35
  </td>
40
- <td valign="top" align="right"></td>
36
+ <td class="gallery_image" valign="top" align="right"></td>
41
37
  </tr></table></div>
42
- <div class="refsynopsisdiv">
43
- <a name="AtkText.synopsis"></a><h2>Synopsis</h2>
44
- <pre class="synopsis"> <a class="link" href="AtkText.html#AtkText-struct" title="AtkText">AtkText</a>;
45
- struct <a class="link" href="AtkText.html#AtkTextIface" title="struct AtkTextIface">AtkTextIface</a>;
46
- enum <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary">AtkTextBoundary</a>;
47
- enum <a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity">AtkTextGranularity</a>;
48
- enum <a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType">AtkTextClipType</a>;
49
- struct <a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange">AtkTextRange</a>;
50
- struct <a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle">AtkTextRectangle</a>;
51
- struct <a class="link" href="AtkText.html#AtkAttribute" title="struct AtkAttribute">AtkAttribute</a>;
52
- typedef <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet">AtkAttributeSet</a>;
53
- enum <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute">AtkTextAttribute</a>;
54
- <span class="returnvalue">gchar</span> * <a class="link" href="AtkText.html#atk-text-get-text" title="atk_text_get_text ()">atk_text_get_text</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
55
- <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
56
- <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);
57
- <span class="returnvalue">gunichar</span> <a class="link" href="AtkText.html#atk-text-get-character-at-offset" title="atk_text_get_character_at_offset ()">atk_text_get_character_at_offset</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
58
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>);
59
- <span class="returnvalue">gchar</span> * <a class="link" href="AtkText.html#atk-text-get-text-after-offset" title="atk_text_get_text_after_offset ()">atk_text_get_text_after_offset</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
60
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
61
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
62
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
63
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);
64
- <span class="returnvalue">gchar</span> * <a class="link" href="AtkText.html#atk-text-get-text-at-offset" title="atk_text_get_text_at_offset ()">atk_text_get_text_at_offset</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
65
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
66
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
67
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
68
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);
69
- <span class="returnvalue">gchar</span> * <a class="link" href="AtkText.html#atk-text-get-text-before-offset" title="atk_text_get_text_before_offset ()">atk_text_get_text_before_offset</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
70
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
71
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
72
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
73
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);
74
- <span class="returnvalue">gchar</span> * <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()">atk_text_get_string_at_offset</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
75
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
76
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity"><span class="type">AtkTextGranularity</span></a> granularity</code></em>,
77
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
78
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);
79
- <span class="returnvalue">gint</span> <a class="link" href="AtkText.html#atk-text-get-caret-offset" title="atk_text_get_caret_offset ()">atk_text_get_caret_offset</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);
80
- <span class="returnvalue">void</span> <a class="link" href="AtkText.html#atk-text-get-character-extents" title="atk_text_get_character_extents ()">atk_text_get_character_extents</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
81
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
82
- <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
83
- <em class="parameter"><code><span class="type">gint</span> *y</code></em>,
84
- <em class="parameter"><code><span class="type">gint</span> *width</code></em>,
85
- <em class="parameter"><code><span class="type">gint</span> *height</code></em>,
86
- <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coords</code></em>);
87
- <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> * <a class="link" href="AtkText.html#atk-text-get-run-attributes" title="atk_text_get_run_attributes ()">atk_text_get_run_attributes</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
88
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
89
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
90
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);
91
- <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> * <a class="link" href="AtkText.html#atk-text-get-default-attributes" title="atk_text_get_default_attributes ()">atk_text_get_default_attributes</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);
92
- <span class="returnvalue">gint</span> <a class="link" href="AtkText.html#atk-text-get-character-count" title="atk_text_get_character_count ()">atk_text_get_character_count</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);
93
- <span class="returnvalue">gint</span> <a class="link" href="AtkText.html#atk-text-get-offset-at-point" title="atk_text_get_offset_at_point ()">atk_text_get_offset_at_point</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
94
- <em class="parameter"><code><span class="type">gint</span> x</code></em>,
95
- <em class="parameter"><code><span class="type">gint</span> y</code></em>,
96
- <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coords</code></em>);
97
- <a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="returnvalue">AtkTextRange</span></a> ** <a class="link" href="AtkText.html#atk-text-get-bounded-ranges" title="atk_text_get_bounded_ranges ()">atk_text_get_bounded_ranges</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
98
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> *rect</code></em>,
99
- <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coord_type</code></em>,
100
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType"><span class="type">AtkTextClipType</span></a> x_clip_type</code></em>,
101
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType"><span class="type">AtkTextClipType</span></a> y_clip_type</code></em>);
102
- <span class="returnvalue">void</span> <a class="link" href="AtkText.html#atk-text-get-range-extents" title="atk_text_get_range_extents ()">atk_text_get_range_extents</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
103
- <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
104
- <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
105
- <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coord_type</code></em>,
106
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> *rect</code></em>);
107
- <span class="returnvalue">void</span> <a class="link" href="AtkText.html#atk-text-free-ranges" title="atk_text_free_ranges ()">atk_text_free_ranges</a> (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="type">AtkTextRange</span></a> **ranges</code></em>);
108
- <span class="returnvalue">gint</span> <a class="link" href="AtkText.html#atk-text-get-n-selections" title="atk_text_get_n_selections ()">atk_text_get_n_selections</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);
109
- <span class="returnvalue">gchar</span> * <a class="link" href="AtkText.html#atk-text-get-selection" title="atk_text_get_selection ()">atk_text_get_selection</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
110
- <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
111
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
112
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);
113
- <span class="returnvalue">gboolean</span> <a class="link" href="AtkText.html#atk-text-add-selection" title="atk_text_add_selection ()">atk_text_add_selection</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
114
- <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
115
- <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);
116
- <span class="returnvalue">gboolean</span> <a class="link" href="AtkText.html#atk-text-remove-selection" title="atk_text_remove_selection ()">atk_text_remove_selection</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
117
- <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>);
118
- <span class="returnvalue">gboolean</span> <a class="link" href="AtkText.html#atk-text-set-selection" title="atk_text_set_selection ()">atk_text_set_selection</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
119
- <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
120
- <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
121
- <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);
122
- <span class="returnvalue">gboolean</span> <a class="link" href="AtkText.html#atk-text-set-caret-offset" title="atk_text_set_caret_offset ()">atk_text_set_caret_offset</a> (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
123
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>);
124
- <span class="returnvalue">void</span> <a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()">atk_attribute_set_free</a> (<em class="parameter"><code><a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> *attrib_set</code></em>);
125
- <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a> <a class="link" href="AtkText.html#atk-text-attribute-register" title="atk_text_attribute_register ()">atk_text_attribute_register</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
126
- const <span class="returnvalue">gchar</span> * <a class="link" href="AtkText.html#atk-text-attribute-get-name" title="atk_text_attribute_get_name ()">atk_text_attribute_get_name</a> (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> attr</code></em>);
127
- <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a> <a class="link" href="AtkText.html#atk-text-attribute-for-name" title="atk_text_attribute_for_name ()">atk_text_attribute_for_name</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
128
- const <span class="returnvalue">gchar</span> * <a class="link" href="AtkText.html#atk-text-attribute-get-value" title="atk_text_attribute_get_value ()">atk_text_attribute_get_value</a> (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> attr</code></em>,
129
- <em class="parameter"><code><span class="type">gint</span> index_</code></em>);
130
- </pre>
131
- </div>
132
- <div class="refsect1">
133
- <a name="AtkText.object-hierarchy"></a><h2>Object Hierarchy</h2>
134
- <pre class="synopsis">
135
- GInterface
136
- +----AtkText
137
- </pre>
138
- </div>
139
- <div class="refsect1">
140
- <a name="AtkText.implementations"></a><h2>Known Implementations</h2>
141
- <p>
142
- AtkText is implemented by
143
- <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
144
- </div>
145
- <div class="refsect1">
146
- <a name="AtkText.signals"></a><h2>Signals</h2>
147
- <pre class="synopsis">
148
- "<a class="link" href="AtkText.html#AtkText-text-attributes-changed" title='The "text-attributes-changed" signal'>text-attributes-changed</a>" : <code class="literal">Run Last</code>
149
- "<a class="link" href="AtkText.html#AtkText-text-caret-moved" title='The "text-caret-moved" signal'>text-caret-moved</a>" : <code class="literal">Run Last</code>
150
- "<a class="link" href="AtkText.html#AtkText-text-changed" title='The "text-changed" signal'>text-changed</a>" : <code class="literal">Has Details</code>
151
- "<a class="link" href="AtkText.html#AtkText-text-insert" title='The "text-insert" signal'>text-insert</a>" : <code class="literal">Has Details</code>
152
- "<a class="link" href="AtkText.html#AtkText-text-remove" title='The "text-remove" signal'>text-remove</a>" : <code class="literal">Has Details</code>
153
- "<a class="link" href="AtkText.html#AtkText-text-selection-changed" title='The "text-selection-changed" signal'>text-selection-changed</a>" : <code class="literal">Run Last</code>
154
- </pre>
155
- </div>
156
- <div class="refsect1">
157
- <a name="AtkText.description"></a><h2>Description</h2>
158
- <p>
159
- <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> should be implemented by <a href="AtkObject.html"><span class="type">AtkObjects</span></a> on behalf of widgets
160
- that have text content which is either attributed or otherwise
161
- non-trivial. <a href="AtkObject.html"><span class="type">AtkObjects</span></a> whose text content is simple,
162
- unattributed, and very brief may expose that content via
163
- <a class="link" href="AtkObject.html#atk-object-get-name" title="atk_object_get_name ()"><span class="type">atk_object_get_name</span></a> instead; however if the text is editable,
164
- multi-line, typically longer than three or four words, attributed,
165
- selectable, or if the object already uses the 'name' ATK property
166
- for other information, the <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> interface should be used to
167
- expose the text content. In the case of editable text content,
168
- <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> (a subtype of the <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> interface) should be
169
- implemented instead.
170
- </p>
171
- <p>
172
- <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> provides not only traversal facilities and change
173
- notification for text content, but also caret tracking and glyph
174
- bounding box calculations. Note that the text strings are exposed
175
- as UTF-8, and are therefore potentially multi-byte, and
176
- caret-to-byte offset mapping makes no assumptions about the
177
- character length; also bounding box glyph-to-offset mapping may be
178
- complex for languages which use ligatures.
179
- </p>
180
- </div>
181
38
  <div class="refsect1">
182
- <a name="AtkText.details"></a><h2>Details</h2>
183
- <div class="refsect2">
184
- <a name="AtkText-struct"></a><h3>AtkText</h3>
185
- <pre class="programlisting">typedef struct _AtkText AtkText;</pre>
186
- <p>
187
- </p>
188
- </div>
189
- <hr>
190
- <div class="refsect2">
191
- <a name="AtkTextIface"></a><h3>struct AtkTextIface</h3>
192
- <pre class="programlisting">struct AtkTextIface {
193
- GTypeInterface parent;
194
-
195
- gchar* (* get_text) (AtkText *text,
196
- gint start_offset,
197
- gint end_offset);
198
- gchar* (* get_text_after_offset) (AtkText *text,
199
- gint offset,
200
- AtkTextBoundary boundary_type,
201
- gint *start_offset,
202
- gint *end_offset);
203
- gchar* (* get_text_at_offset) (AtkText *text,
204
- gint offset,
205
- AtkTextBoundary boundary_type,
206
- gint *start_offset,
207
- gint *end_offset);
208
- gunichar (* get_character_at_offset) (AtkText *text,
209
- gint offset);
210
- gchar* (* get_text_before_offset) (AtkText *text,
211
- gint offset,
212
- AtkTextBoundary boundary_type,
213
- gint *start_offset,
214
- gint *end_offset);
215
- gint (* get_caret_offset) (AtkText *text);
216
- AtkAttributeSet* (* get_run_attributes) (AtkText *text,
217
- gint offset,
218
- gint *start_offset,
219
- gint *end_offset);
220
- AtkAttributeSet* (* get_default_attributes) (AtkText *text);
221
- void (* get_character_extents) (AtkText *text,
222
- gint offset,
223
- gint *x,
224
- gint *y,
225
- gint *width,
226
- gint *height,
227
- AtkCoordType coords);
228
- gint (* get_character_count) (AtkText *text);
229
- gint (* get_offset_at_point) (AtkText *text,
230
- gint x,
231
- gint y,
232
- AtkCoordType coords);
233
- gint (* get_n_selections) (AtkText *text);
234
- gchar* (* get_selection) (AtkText *text,
235
- gint selection_num,
236
- gint *start_offset,
237
- gint *end_offset);
238
- gboolean (* add_selection) (AtkText *text,
239
- gint start_offset,
240
- gint end_offset);
241
- gboolean (* remove_selection) (AtkText *text,
242
- gint selection_num);
243
- gboolean (* set_selection) (AtkText *text,
244
- gint selection_num,
245
- gint start_offset,
246
- gint end_offset);
247
- gboolean (* set_caret_offset) (AtkText *text,
248
- gint offset);
249
-
250
- /*
251
- * signal handlers
252
- */
253
- void (* text_changed) (AtkText *text,
254
- gint position,
255
- gint length);
256
- void (* text_caret_moved) (AtkText *text,
257
- gint location);
258
- void (* text_selection_changed) (AtkText *text);
259
-
260
- void (* text_attributes_changed) (AtkText *text);
261
-
262
-
263
- void (* get_range_extents) (AtkText *text,
264
- gint start_offset,
265
- gint end_offset,
266
- AtkCoordType coord_type,
267
- AtkTextRectangle *rect);
268
-
269
- AtkTextRange** (* get_bounded_ranges) (AtkText *text,
270
- AtkTextRectangle *rect,
271
- AtkCoordType coord_type,
272
- AtkTextClipType x_clip_type,
273
- AtkTextClipType y_clip_type);
274
-
275
- gchar* (* get_string_at_offset) (AtkText *text,
276
- gint offset,
277
- AtkTextGranularity granularity,
278
- gint *start_offset,
279
- gint *end_offset);
280
- };
281
- </pre>
282
- <div class="variablelist"><table border="0">
283
- <col align="left" valign="top">
39
+ <a name="AtkText.functions"></a><h2>Functions</h2>
40
+ <div class="informaltable"><table width="100%" border="0">
41
+ <colgroup>
42
+ <col width="150px" class="functions_return">
43
+ <col class="functions_name">
44
+ </colgroup>
284
45
  <tbody>
285
46
  <tr>
286
- <td><p><span class="term"><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="AtkTextIface.parent"></a>parent</code></em>;</span></p></td>
287
- <td></td>
288
- </tr>
289
- <tr>
290
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-text"></a>get_text</code></em> ()</span></p></td>
291
- <td></td>
292
- </tr>
293
- <tr>
294
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-text-after-offset"></a>get_text_after_offset</code></em> ()</span></p></td>
295
- <td>Gets specified text. This virtual function
296
- is deprecated and it should not be overridden.</td>
297
- </tr>
298
- <tr>
299
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-text-at-offset"></a>get_text_at_offset</code></em> ()</span></p></td>
300
- <td>Gets specified text. This virtual function
301
- is deprecated and it should not be overridden.</td>
302
- </tr>
303
- <tr>
304
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-character-at-offset"></a>get_character_at_offset</code></em> ()</span></p></td>
305
- <td></td>
306
- </tr>
307
- <tr>
308
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-text-before-offset"></a>get_text_before_offset</code></em> ()</span></p></td>
309
- <td>Gets specified text. This virtual function
310
- is deprecated and it should not be overridden.</td>
311
- </tr>
312
- <tr>
313
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-caret-offset"></a>get_caret_offset</code></em> ()</span></p></td>
314
- <td></td>
47
+ <td class="function_type">
48
+ <span class="returnvalue">gchar</span> *
49
+ </td>
50
+ <td class="function_name">
51
+ <a class="link" href="AtkText.html#atk-text-get-text" title="atk_text_get_text ()">atk_text_get_text</a> <span class="c_punctuation">()</span>
52
+ </td>
315
53
  </tr>
316
54
  <tr>
317
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-run-attributes"></a>get_run_attributes</code></em> ()</span></p></td>
318
- <td></td>
55
+ <td class="function_type">
56
+ <span class="returnvalue">gunichar</span>
57
+ </td>
58
+ <td class="function_name">
59
+ <a class="link" href="AtkText.html#atk-text-get-character-at-offset" title="atk_text_get_character_at_offset ()">atk_text_get_character_at_offset</a> <span class="c_punctuation">()</span>
60
+ </td>
319
61
  </tr>
320
62
  <tr>
321
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-default-attributes"></a>get_default_attributes</code></em> ()</span></p></td>
322
- <td></td>
63
+ <td class="function_type">
64
+ <span class="returnvalue">gchar</span> *
65
+ </td>
66
+ <td class="function_name">
67
+ <a class="link" href="AtkText.html#atk-text-get-text-after-offset" title="atk_text_get_text_after_offset ()">atk_text_get_text_after_offset</a> <span class="c_punctuation">()</span>
68
+ </td>
323
69
  </tr>
324
70
  <tr>
325
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-character-extents"></a>get_character_extents</code></em> ()</span></p></td>
326
- <td></td>
71
+ <td class="function_type">
72
+ <span class="returnvalue">gchar</span> *
73
+ </td>
74
+ <td class="function_name">
75
+ <a class="link" href="AtkText.html#atk-text-get-text-at-offset" title="atk_text_get_text_at_offset ()">atk_text_get_text_at_offset</a> <span class="c_punctuation">()</span>
76
+ </td>
327
77
  </tr>
328
78
  <tr>
329
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-character-count"></a>get_character_count</code></em> ()</span></p></td>
330
- <td></td>
79
+ <td class="function_type">
80
+ <span class="returnvalue">gchar</span> *
81
+ </td>
82
+ <td class="function_name">
83
+ <a class="link" href="AtkText.html#atk-text-get-text-before-offset" title="atk_text_get_text_before_offset ()">atk_text_get_text_before_offset</a> <span class="c_punctuation">()</span>
84
+ </td>
331
85
  </tr>
332
86
  <tr>
333
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-offset-at-point"></a>get_offset_at_point</code></em> ()</span></p></td>
334
- <td></td>
87
+ <td class="function_type">
88
+ <span class="returnvalue">gchar</span> *
89
+ </td>
90
+ <td class="function_name">
91
+ <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()">atk_text_get_string_at_offset</a> <span class="c_punctuation">()</span>
92
+ </td>
335
93
  </tr>
336
94
  <tr>
337
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-n-selections"></a>get_n_selections</code></em> ()</span></p></td>
338
- <td></td>
95
+ <td class="function_type">
96
+ <span class="returnvalue">gint</span>
97
+ </td>
98
+ <td class="function_name">
99
+ <a class="link" href="AtkText.html#atk-text-get-caret-offset" title="atk_text_get_caret_offset ()">atk_text_get_caret_offset</a> <span class="c_punctuation">()</span>
100
+ </td>
339
101
  </tr>
340
102
  <tr>
341
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-selection"></a>get_selection</code></em> ()</span></p></td>
342
- <td></td>
103
+ <td class="function_type">
104
+ <span class="returnvalue">void</span>
105
+ </td>
106
+ <td class="function_name">
107
+ <a class="link" href="AtkText.html#atk-text-get-character-extents" title="atk_text_get_character_extents ()">atk_text_get_character_extents</a> <span class="c_punctuation">()</span>
108
+ </td>
343
109
  </tr>
344
110
  <tr>
345
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.add-selection"></a>add_selection</code></em> ()</span></p></td>
346
- <td></td>
111
+ <td class="function_type">
112
+ <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
113
+ </td>
114
+ <td class="function_name">
115
+ <a class="link" href="AtkText.html#atk-text-get-run-attributes" title="atk_text_get_run_attributes ()">atk_text_get_run_attributes</a> <span class="c_punctuation">()</span>
116
+ </td>
347
117
  </tr>
348
118
  <tr>
349
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.remove-selection"></a>remove_selection</code></em> ()</span></p></td>
350
- <td></td>
119
+ <td class="function_type">
120
+ <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
121
+ </td>
122
+ <td class="function_name">
123
+ <a class="link" href="AtkText.html#atk-text-get-default-attributes" title="atk_text_get_default_attributes ()">atk_text_get_default_attributes</a> <span class="c_punctuation">()</span>
124
+ </td>
351
125
  </tr>
352
126
  <tr>
353
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.set-selection"></a>set_selection</code></em> ()</span></p></td>
354
- <td></td>
127
+ <td class="function_type">
128
+ <span class="returnvalue">gint</span>
129
+ </td>
130
+ <td class="function_name">
131
+ <a class="link" href="AtkText.html#atk-text-get-character-count" title="atk_text_get_character_count ()">atk_text_get_character_count</a> <span class="c_punctuation">()</span>
132
+ </td>
355
133
  </tr>
356
134
  <tr>
357
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.set-caret-offset"></a>set_caret_offset</code></em> ()</span></p></td>
358
- <td></td>
135
+ <td class="function_type">
136
+ <span class="returnvalue">gint</span>
137
+ </td>
138
+ <td class="function_name">
139
+ <a class="link" href="AtkText.html#atk-text-get-offset-at-point" title="atk_text_get_offset_at_point ()">atk_text_get_offset_at_point</a> <span class="c_punctuation">()</span>
140
+ </td>
359
141
  </tr>
360
142
  <tr>
361
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.text-changed"></a>text_changed</code></em> ()</span></p></td>
362
- <td>the signal handler which is executed when there is a
363
- text change. This virtual function is deprecated sice 2.9.4 and
364
- it should not be overriden.</td>
143
+ <td class="function_type">
144
+ <a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="returnvalue">AtkTextRange</span></a> **
145
+ </td>
146
+ <td class="function_name">
147
+ <a class="link" href="AtkText.html#atk-text-get-bounded-ranges" title="atk_text_get_bounded_ranges ()">atk_text_get_bounded_ranges</a> <span class="c_punctuation">()</span>
148
+ </td>
365
149
  </tr>
366
150
  <tr>
367
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.text-caret-moved"></a>text_caret_moved</code></em> ()</span></p></td>
368
- <td></td>
151
+ <td class="function_type">
152
+ <span class="returnvalue">void</span>
153
+ </td>
154
+ <td class="function_name">
155
+ <a class="link" href="AtkText.html#atk-text-get-range-extents" title="atk_text_get_range_extents ()">atk_text_get_range_extents</a> <span class="c_punctuation">()</span>
156
+ </td>
369
157
  </tr>
370
158
  <tr>
371
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.text-selection-changed"></a>text_selection_changed</code></em> ()</span></p></td>
372
- <td></td>
159
+ <td class="function_type">
160
+ <span class="returnvalue">void</span>
161
+ </td>
162
+ <td class="function_name">
163
+ <a class="link" href="AtkText.html#atk-text-free-ranges" title="atk_text_free_ranges ()">atk_text_free_ranges</a> <span class="c_punctuation">()</span>
164
+ </td>
373
165
  </tr>
374
166
  <tr>
375
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.text-attributes-changed"></a>text_attributes_changed</code></em> ()</span></p></td>
376
- <td></td>
167
+ <td class="function_type">
168
+ <span class="returnvalue">gint</span>
169
+ </td>
170
+ <td class="function_name">
171
+ <a class="link" href="AtkText.html#atk-text-get-n-selections" title="atk_text_get_n_selections ()">atk_text_get_n_selections</a> <span class="c_punctuation">()</span>
172
+ </td>
377
173
  </tr>
378
174
  <tr>
379
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-range-extents"></a>get_range_extents</code></em> ()</span></p></td>
380
- <td></td>
175
+ <td class="function_type">
176
+ <span class="returnvalue">gchar</span> *
177
+ </td>
178
+ <td class="function_name">
179
+ <a class="link" href="AtkText.html#atk-text-get-selection" title="atk_text_get_selection ()">atk_text_get_selection</a> <span class="c_punctuation">()</span>
180
+ </td>
381
181
  </tr>
382
182
  <tr>
383
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-bounded-ranges"></a>get_bounded_ranges</code></em> ()</span></p></td>
384
- <td></td>
183
+ <td class="function_type">
184
+ <span class="returnvalue">gboolean</span>
185
+ </td>
186
+ <td class="function_name">
187
+ <a class="link" href="AtkText.html#atk-text-add-selection" title="atk_text_add_selection ()">atk_text_add_selection</a> <span class="c_punctuation">()</span>
188
+ </td>
385
189
  </tr>
386
190
  <tr>
387
- <td><p><span class="term"><em class="structfield"><code><a name="AtkTextIface.get-string-at-offset"></a>get_string_at_offset</code></em> ()</span></p></td>
388
- <td>Gets a portion of the text exposed through
389
- an AtkText according to a given offset and a specific
390
- granularity, along with the start and end offsets defining the
391
- boundaries of such a portion of text.</td>
191
+ <td class="function_type">
192
+ <span class="returnvalue">gboolean</span>
193
+ </td>
194
+ <td class="function_name">
195
+ <a class="link" href="AtkText.html#atk-text-remove-selection" title="atk_text_remove_selection ()">atk_text_remove_selection</a> <span class="c_punctuation">()</span>
196
+ </td>
392
197
  </tr>
393
- </tbody>
394
- </table></div>
395
- </div>
396
- <hr>
397
- <div class="refsect2">
398
- <a name="AtkTextBoundary"></a><h3>enum AtkTextBoundary</h3>
399
- <pre class="programlisting">typedef enum {
400
- ATK_TEXT_BOUNDARY_CHAR,
401
- ATK_TEXT_BOUNDARY_WORD_START,
402
- ATK_TEXT_BOUNDARY_WORD_END,
403
- ATK_TEXT_BOUNDARY_SENTENCE_START,
404
- ATK_TEXT_BOUNDARY_SENTENCE_END,
405
- ATK_TEXT_BOUNDARY_LINE_START,
406
- ATK_TEXT_BOUNDARY_LINE_END
407
- } AtkTextBoundary;
408
- </pre>
409
- <p>
410
- Text boundary types used for specifying boundaries for regions of text.
411
- This enumerationis deprecated since 2.9.4 and should not be used. Use
412
- AtkTextGranularity with <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><span class="type">atk_text_get_string_at_offset</span></a> instead.
413
- </p>
414
- <div class="variablelist"><table border="0">
415
- <col align="left" valign="top">
416
- <tbody>
417
198
  <tr>
418
- <td><p><a name="ATK-TEXT-BOUNDARY-CHAR:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_BOUNDARY_CHAR</code></span></p></td>
419
- <td>Boundary is the boundary between characters
420
- (including non-printing characters)
199
+ <td class="function_type">
200
+ <span class="returnvalue">gboolean</span>
201
+ </td>
202
+ <td class="function_name">
203
+ <a class="link" href="AtkText.html#atk-text-set-selection" title="atk_text_set_selection ()">atk_text_set_selection</a> <span class="c_punctuation">()</span>
421
204
  </td>
422
205
  </tr>
423
206
  <tr>
424
- <td><p><a name="ATK-TEXT-BOUNDARY-WORD-START:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_BOUNDARY_WORD_START</code></span></p></td>
425
- <td>Boundary is the start (i.e. first character) of a word.
207
+ <td class="function_type">
208
+ <span class="returnvalue">gboolean</span>
209
+ </td>
210
+ <td class="function_name">
211
+ <a class="link" href="AtkText.html#atk-text-set-caret-offset" title="atk_text_set_caret_offset ()">atk_text_set_caret_offset</a> <span class="c_punctuation">()</span>
426
212
  </td>
427
213
  </tr>
428
214
  <tr>
429
- <td><p><a name="ATK-TEXT-BOUNDARY-WORD-END:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_BOUNDARY_WORD_END</code></span></p></td>
430
- <td>Boundary is the end (i.e. last
431
- character) of a word.
215
+ <td class="function_type">
216
+ <span class="returnvalue">void</span>
217
+ </td>
218
+ <td class="function_name">
219
+ <a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()">atk_attribute_set_free</a> <span class="c_punctuation">()</span>
432
220
  </td>
433
221
  </tr>
434
222
  <tr>
435
- <td><p><a name="ATK-TEXT-BOUNDARY-SENTENCE-START:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_BOUNDARY_SENTENCE_START</code></span></p></td>
436
- <td>Boundary is the first character in a sentence.
223
+ <td class="function_type">
224
+ <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a>
225
+ </td>
226
+ <td class="function_name">
227
+ <a class="link" href="AtkText.html#atk-text-attribute-register" title="atk_text_attribute_register ()">atk_text_attribute_register</a> <span class="c_punctuation">()</span>
437
228
  </td>
438
229
  </tr>
439
230
  <tr>
440
- <td><p><a name="ATK-TEXT-BOUNDARY-SENTENCE-END:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_BOUNDARY_SENTENCE_END</code></span></p></td>
441
- <td>Boundary is the last (terminal)
442
- character in a sentence; in languages which use "sentence stop"
443
- punctuation such as English, the boundary is thus the '.', '?', or
444
- similar terminal punctuation character.
231
+ <td class="function_type">const <span class="returnvalue">gchar</span> *
232
+ </td>
233
+ <td class="function_name">
234
+ <a class="link" href="AtkText.html#atk-text-attribute-get-name" title="atk_text_attribute_get_name ()">atk_text_attribute_get_name</a> <span class="c_punctuation">()</span>
445
235
  </td>
446
236
  </tr>
447
237
  <tr>
448
- <td><p><a name="ATK-TEXT-BOUNDARY-LINE-START:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_BOUNDARY_LINE_START</code></span></p></td>
449
- <td>Boundary is the initial character of the content or a
450
- character immediately following a newline, linefeed, or return character.
238
+ <td class="function_type">
239
+ <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a>
240
+ </td>
241
+ <td class="function_name">
242
+ <a class="link" href="AtkText.html#atk-text-attribute-for-name" title="atk_text_attribute_for_name ()">atk_text_attribute_for_name</a> <span class="c_punctuation">()</span>
451
243
  </td>
452
244
  </tr>
453
245
  <tr>
454
- <td><p><a name="ATK-TEXT-BOUNDARY-LINE-END:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_BOUNDARY_LINE_END</code></span></p></td>
455
- <td>Boundary is the linefeed, or return
456
- character.
246
+ <td class="function_type">const <span class="returnvalue">gchar</span> *
247
+ </td>
248
+ <td class="function_name">
249
+ <a class="link" href="AtkText.html#atk-text-attribute-get-value" title="atk_text_attribute_get_value ()">atk_text_attribute_get_value</a> <span class="c_punctuation">()</span>
457
250
  </td>
458
251
  </tr>
459
252
  </tbody>
460
253
  </table></div>
461
254
  </div>
462
- <hr>
463
- <div class="refsect2">
464
- <a name="AtkTextGranularity"></a><h3>enum AtkTextGranularity</h3>
465
- <pre class="programlisting">typedef enum {
466
- ATK_TEXT_GRANULARITY_CHAR,
467
- ATK_TEXT_GRANULARITY_WORD,
468
- ATK_TEXT_GRANULARITY_SENTENCE,
469
- ATK_TEXT_GRANULARITY_LINE,
470
- ATK_TEXT_GRANULARITY_PARAGRAPH
471
- } AtkTextGranularity;
472
- </pre>
473
- <p>
474
- Text granularity types used for specifying the granularity of the region of
475
- text we are interested in.
476
- </p>
477
- <div class="variablelist"><table border="0">
478
- <col align="left" valign="top">
255
+ <div class="refsect1">
256
+ <a name="AtkText.signals"></a><h2>Signals</h2>
257
+ <div class="informaltable"><table border="0">
258
+ <colgroup>
259
+ <col width="150px" class="signals_return">
260
+ <col width="300px" class="signals_name">
261
+ <col width="200px" class="signals_flags">
262
+ </colgroup>
479
263
  <tbody>
480
264
  <tr>
481
- <td><p><a name="ATK-TEXT-GRANULARITY-CHAR:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_GRANULARITY_CHAR</code></span></p></td>
482
- <td>Granularity is defined by the boundaries between characters
483
- (including non-printing characters)
484
- </td>
265
+ <td class="signal_type"><span class="returnvalue">void</span></td>
266
+ <td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-attributes-changed" title="The “text-attributes-changed” signal">text-attributes-changed</a></td>
267
+ <td class="signal_flags">Run Last</td>
485
268
  </tr>
486
269
  <tr>
487
- <td><p><a name="ATK-TEXT-GRANULARITY-WORD:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_GRANULARITY_WORD</code></span></p></td>
488
- <td>Granularity is defined by the boundaries of a word,
489
- starting at the beginning of the current word and finishing at the beginning of
490
- the following one, if present.
491
- </td>
270
+ <td class="signal_type"><span class="returnvalue">void</span></td>
271
+ <td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-caret-moved" title="The “text-caret-moved” signal">text-caret-moved</a></td>
272
+ <td class="signal_flags">Run Last</td>
492
273
  </tr>
493
274
  <tr>
494
- <td><p><a name="ATK-TEXT-GRANULARITY-SENTENCE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_GRANULARITY_SENTENCE</code></span></p></td>
495
- <td>Granularity is defined by the boundaries of a sentence,
496
- starting at the beginning of the current sentence and finishing at the beginning of
497
- the following one, if present.
498
- </td>
275
+ <td class="signal_type"><span class="returnvalue">void</span></td>
276
+ <td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-changed" title="The “text-changed” signal">text-changed</a></td>
277
+ <td class="signal_flags">Has Details</td>
499
278
  </tr>
500
279
  <tr>
501
- <td><p><a name="ATK-TEXT-GRANULARITY-LINE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_GRANULARITY_LINE</code></span></p></td>
502
- <td>Granularity is defined by the boundaries of a line,
503
- starting at the beginning of the current line and finishing at the beginning of
504
- the following one, if present.
505
- </td>
280
+ <td class="signal_type"><span class="returnvalue">void</span></td>
281
+ <td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-insert" title="The “text-insert” signal">text-insert</a></td>
282
+ <td class="signal_flags">Has Details</td>
506
283
  </tr>
507
284
  <tr>
508
- <td><p><a name="ATK-TEXT-GRANULARITY-PARAGRAPH:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_GRANULARITY_PARAGRAPH</code></span></p></td>
509
- <td>Granularity is defined by the boundaries of a paragraph,
510
- starting at the beginning of the current paragraph and finishing at the beginning of
511
- the following one, if present.
512
- </td>
285
+ <td class="signal_type"><span class="returnvalue">void</span></td>
286
+ <td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-remove" title="The “text-remove” signal">text-remove</a></td>
287
+ <td class="signal_flags">Has Details</td>
288
+ </tr>
289
+ <tr>
290
+ <td class="signal_type"><span class="returnvalue">void</span></td>
291
+ <td class="signal_name"><a class="link" href="AtkText.html#AtkText-text-selection-changed" title="The “text-selection-changed” signal">text-selection-changed</a></td>
292
+ <td class="signal_flags">Run Last</td>
513
293
  </tr>
514
294
  </tbody>
515
295
  </table></div>
516
296
  </div>
517
- <hr>
518
- <div class="refsect2">
519
- <a name="AtkTextClipType"></a><h3>enum AtkTextClipType</h3>
520
- <pre class="programlisting">typedef enum {
521
- ATK_TEXT_CLIP_NONE,
522
- ATK_TEXT_CLIP_MIN,
523
- ATK_TEXT_CLIP_MAX,
524
- ATK_TEXT_CLIP_BOTH
525
- } AtkTextClipType;
526
- </pre>
527
- <p>
528
- Describes the type of clipping required.
529
- </p>
530
- <div class="variablelist"><table border="0">
531
- <col align="left" valign="top">
297
+ <div class="refsect1">
298
+ <a name="AtkText.other"></a><h2>Types and Values</h2>
299
+ <div class="informaltable"><table width="100%" border="0">
300
+ <colgroup>
301
+ <col width="150px" class="name">
302
+ <col class="description">
303
+ </colgroup>
532
304
  <tbody>
533
305
  <tr>
534
- <td><p><a name="ATK-TEXT-CLIP-NONE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_CLIP_NONE</code></span></p></td>
535
- <td>No clipping to be done
536
- </td>
306
+ <td class="datatype_keyword"> </td>
307
+ <td class="function_name"><a class="link" href="AtkText.html#AtkText-struct" title="AtkText">AtkText</a></td>
537
308
  </tr>
538
309
  <tr>
539
- <td><p><a name="ATK-TEXT-CLIP-MIN:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_CLIP_MIN</code></span></p></td>
540
- <td>Text clipped by min coordinate is omitted
541
- </td>
310
+ <td class="datatype_keyword">struct</td>
311
+ <td class="function_name"><a class="link" href="AtkText.html#AtkTextIface" title="struct AtkTextIface">AtkTextIface</a></td>
542
312
  </tr>
543
313
  <tr>
544
- <td><p><a name="ATK-TEXT-CLIP-MAX:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_CLIP_MAX</code></span></p></td>
545
- <td>Text clipped by max coordinate is omitted
546
- </td>
314
+ <td class="datatype_keyword">enum</td>
315
+ <td class="function_name"><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary">AtkTextBoundary</a></td>
547
316
  </tr>
548
317
  <tr>
549
- <td><p><a name="ATK-TEXT-CLIP-BOTH:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_CLIP_BOTH</code></span></p></td>
550
- <td>Only text fully within mix/max bound is retained
551
- </td>
318
+ <td class="datatype_keyword">enum</td>
319
+ <td class="function_name"><a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity">AtkTextGranularity</a></td>
552
320
  </tr>
553
- </tbody>
554
- </table></div>
555
- </div>
556
- <hr>
557
- <div class="refsect2">
558
- <a name="AtkTextRange"></a><h3>struct AtkTextRange</h3>
559
- <pre class="programlisting">struct AtkTextRange {
560
- AtkTextRectangle bounds;
561
- gint start_offset;
562
- gint end_offset;
563
- gchar* content;
564
- };
565
- </pre>
566
- <p>
567
- A structure used to describe a text range.
568
- </p>
569
- <div class="variablelist"><table border="0">
570
- <col align="left" valign="top">
571
- <tbody>
572
321
  <tr>
573
- <td><p><span class="term"><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> <em class="structfield"><code><a name="AtkTextRange.bounds"></a>bounds</code></em>;</span></p></td>
574
- <td>A rectangle giving the bounds of the text range</td>
322
+ <td class="datatype_keyword">enum</td>
323
+ <td class="function_name"><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType">AtkTextClipType</a></td>
575
324
  </tr>
576
325
  <tr>
577
- <td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRange.start-offset"></a>start_offset</code></em>;</span></p></td>
578
- <td>The start offset of a AtkTextRange</td>
326
+ <td class="datatype_keyword">struct</td>
327
+ <td class="function_name"><a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange">AtkTextRange</a></td>
579
328
  </tr>
580
329
  <tr>
581
- <td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRange.end-offset"></a>end_offset</code></em>;</span></p></td>
582
- <td>The end offset of a AtkTextRange</td>
330
+ <td class="datatype_keyword">struct</td>
331
+ <td class="function_name"><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle">AtkTextRectangle</a></td>
583
332
  </tr>
584
333
  <tr>
585
- <td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="AtkTextRange.content"></a>content</code></em>;</span></p></td>
586
- <td>The text in the text range</td>
334
+ <td class="datatype_keyword">enum</td>
335
+ <td class="function_name"><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute">AtkTextAttribute</a></td>
587
336
  </tr>
588
337
  </tbody>
589
338
  </table></div>
590
339
  </div>
591
- <hr>
592
- <div class="refsect2">
593
- <a name="AtkTextRectangle"></a><h3>struct AtkTextRectangle</h3>
594
- <pre class="programlisting">struct AtkTextRectangle {
595
- gint x;
596
- gint y;
597
- gint width;
598
- gint height;
599
- };
340
+ <div class="refsect1">
341
+ <a name="AtkText.object-hierarchy"></a><h2>Object Hierarchy</h2>
342
+ <pre class="screen"> GInterface
343
+ <span class="lineart">╰──</span> AtkText
600
344
  </pre>
345
+ </div>
346
+ <div class="refsect1">
347
+ <a name="AtkText.implementations"></a><h2>Known Implementations</h2>
601
348
  <p>
602
- A structure used to store a rectangle used by AtkText.
603
- </p>
604
- <div class="variablelist"><table border="0">
605
- <col align="left" valign="top">
349
+ AtkText is implemented by
350
+ <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
351
+ </div>
352
+ <div class="refsect1">
353
+ <a name="AtkText.description"></a><h2>Description</h2>
354
+ <p><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> should be implemented by <a href="AtkObject.html"><span class="type">AtkObjects</span></a> on behalf of widgets
355
+ that have text content which is either attributed or otherwise
356
+ non-trivial. <a href="AtkObject.html"><span class="type">AtkObjects</span></a> whose text content is simple,
357
+ unattributed, and very brief may expose that content via
358
+ <a class="link" href="AtkObject.html#atk-object-get-name" title="atk_object_get_name ()"><span class="type">atk_object_get_name</span></a> instead; however if the text is editable,
359
+ multi-line, typically longer than three or four words, attributed,
360
+ selectable, or if the object already uses the 'name' ATK property
361
+ for other information, the <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> interface should be used to
362
+ expose the text content. In the case of editable text content,
363
+ <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> (a subtype of the <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> interface) should be
364
+ implemented instead.</p>
365
+ <p> <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> provides not only traversal facilities and change
366
+ notification for text content, but also caret tracking and glyph
367
+ bounding box calculations. Note that the text strings are exposed
368
+ as UTF-8, and are therefore potentially multi-byte, and
369
+ caret-to-byte offset mapping makes no assumptions about the
370
+ character length; also bounding box glyph-to-offset mapping may be
371
+ complex for languages which use ligatures.</p>
372
+ </div>
373
+ <div class="refsect1">
374
+ <a name="AtkText.functions_details"></a><h2>Functions</h2>
375
+ <div class="refsect2">
376
+ <a name="atk-text-get-text"></a><h3>atk_text_get_text ()</h3>
377
+ <pre class="programlisting"><span class="returnvalue">gchar</span> *
378
+ atk_text_get_text (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
379
+ <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
380
+ <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);</pre>
381
+ <p>Gets the specified text.</p>
382
+ <div class="refsect3">
383
+ <a name="id-1.5.13.9.2.5"></a><h4>Parameters</h4>
384
+ <div class="informaltable"><table width="100%" border="0">
385
+ <colgroup>
386
+ <col width="150px" class="parameters_name">
387
+ <col class="parameters_description">
388
+ <col width="200px" class="parameters_annotations">
389
+ </colgroup>
606
390
  <tbody>
607
391
  <tr>
608
- <td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRectangle.x"></a>x</code></em>;</span></p></td>
609
- <td>The horizontal coordinate of a rectangle</td>
392
+ <td class="parameter_name"><p>text</p></td>
393
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
394
+ <td class="parameter_annotations"> </td>
610
395
  </tr>
611
396
  <tr>
612
- <td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRectangle.y"></a>y</code></em>;</span></p></td>
613
- <td>The vertical coordinate of a rectangle</td>
397
+ <td class="parameter_name"><p>start_offset</p></td>
398
+ <td class="parameter_description"><p>start position</p></td>
399
+ <td class="parameter_annotations"> </td>
614
400
  </tr>
615
401
  <tr>
616
- <td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRectangle.width"></a>width</code></em>;</span></p></td>
617
- <td>The width of a rectangle</td>
618
- </tr>
619
- <tr>
620
- <td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRectangle.height"></a>height</code></em>;</span></p></td>
621
- <td>The height of a rectangle</td>
402
+ <td class="parameter_name"><p>end_offset</p></td>
403
+ <td class="parameter_description"><p>end position, or -1 for the end of the string.</p></td>
404
+ <td class="parameter_annotations"> </td>
622
405
  </tr>
623
406
  </tbody>
624
407
  </table></div>
625
408
  </div>
409
+ <div class="refsect3">
410
+ <a name="id-1.5.13.9.2.6"></a><h4>Returns</h4>
411
+ <p> a newly allocated string containing the text from <em class="parameter"><code>start_offset</code></em>
412
+ up
413
+ to, but not including <em class="parameter"><code>end_offset</code></em>
414
+ . Use <code class="function">g_free()</code> to free the returned string.</p>
415
+ <p></p>
416
+ </div>
417
+ </div>
626
418
  <hr>
627
419
  <div class="refsect2">
628
- <a name="AtkAttribute"></a><h3>struct AtkAttribute</h3>
629
- <pre class="programlisting">struct AtkAttribute {
630
- gchar* name;
631
- gchar* value;
632
- };
633
- </pre>
634
- <p>
635
- A string name/value pair representing a text attribute.
636
- </p>
637
- <div class="variablelist"><table border="0">
638
- <col align="left" valign="top">
420
+ <a name="atk-text-get-character-at-offset"></a><h3>atk_text_get_character_at_offset ()</h3>
421
+ <pre class="programlisting"><span class="returnvalue">gunichar</span>
422
+ atk_text_get_character_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
423
+ <em class="parameter"><code><span class="type">gint</span> offset</code></em>);</pre>
424
+ <p>Gets the specified text.</p>
425
+ <div class="refsect3">
426
+ <a name="id-1.5.13.9.3.5"></a><h4>Parameters</h4>
427
+ <div class="informaltable"><table width="100%" border="0">
428
+ <colgroup>
429
+ <col width="150px" class="parameters_name">
430
+ <col class="parameters_description">
431
+ <col width="200px" class="parameters_annotations">
432
+ </colgroup>
639
433
  <tbody>
640
434
  <tr>
641
- <td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="AtkAttribute.name"></a>name</code></em>;</span></p></td>
642
- <td>The attribute name. Call <code class="function">atk_text_attr_get_name()</code>
643
- </td>
435
+ <td class="parameter_name"><p>text</p></td>
436
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
437
+ <td class="parameter_annotations"> </td>
644
438
  </tr>
645
439
  <tr>
646
- <td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="AtkAttribute.value"></a>value</code></em>;</span></p></td>
647
- <td>the value of the attribute, represented as a string.
648
- Call <code class="function">atk_text_attr_get_value()</code> for those which are strings.
649
- For values which are numbers, the string representation of the number
650
- is in value.</td>
440
+ <td class="parameter_name"><p>offset</p></td>
441
+ <td class="parameter_description"><p>position</p></td>
442
+ <td class="parameter_annotations"> </td>
651
443
  </tr>
652
444
  </tbody>
653
445
  </table></div>
654
446
  </div>
655
- <hr>
656
- <div class="refsect2">
657
- <a name="AtkAttributeSet"></a><h3>AtkAttributeSet</h3>
658
- <pre class="programlisting">typedef GSList AtkAttributeSet;
659
- </pre>
660
- <p>
661
- This is a singly-linked list (a <span class="type">GSList</span>) of <a class="link" href="AtkText.html#AtkAttribute" title="struct AtkAttribute"><span class="type">AtkAttribute</span></a>. It is
662
- used by <a class="link" href="AtkText.html#atk-text-get-run-attributes" title="atk_text_get_run_attributes ()"><code class="function">atk_text_get_run_attributes()</code></a>, <a class="link" href="AtkText.html#atk-text-get-default-attributes" title="atk_text_get_default_attributes ()"><code class="function">atk_text_get_default_attributes()</code></a>
663
- and <a class="link" href="AtkEditableText.html#atk-editable-text-set-run-attributes" title="atk_editable_text_set_run_attributes ()"><code class="function">atk_editable_text_set_run_attributes()</code></a>
664
- </p>
447
+ <div class="refsect3">
448
+ <a name="id-1.5.13.9.3.6"></a><h4>Returns</h4>
449
+ <p> the character at <em class="parameter"><code>offset</code></em>
450
+ .</p>
451
+ <p></p>
452
+ </div>
665
453
  </div>
666
454
  <hr>
667
455
  <div class="refsect2">
668
- <a name="AtkTextAttribute"></a><h3>enum AtkTextAttribute</h3>
669
- <pre class="programlisting">typedef enum {
670
- ATK_TEXT_ATTR_INVALID = 0,
671
- ATK_TEXT_ATTR_LEFT_MARGIN,
672
- ATK_TEXT_ATTR_RIGHT_MARGIN,
673
- ATK_TEXT_ATTR_INDENT,
674
- ATK_TEXT_ATTR_INVISIBLE,
675
- ATK_TEXT_ATTR_EDITABLE,
676
- ATK_TEXT_ATTR_PIXELS_ABOVE_LINES,
677
- ATK_TEXT_ATTR_PIXELS_BELOW_LINES,
678
- ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP,
679
- ATK_TEXT_ATTR_BG_FULL_HEIGHT,
680
- ATK_TEXT_ATTR_RISE,
681
- ATK_TEXT_ATTR_UNDERLINE,
682
- ATK_TEXT_ATTR_STRIKETHROUGH,
683
- ATK_TEXT_ATTR_SIZE,
684
- ATK_TEXT_ATTR_SCALE,
685
- ATK_TEXT_ATTR_WEIGHT,
686
- ATK_TEXT_ATTR_LANGUAGE,
687
- ATK_TEXT_ATTR_FAMILY_NAME,
688
- ATK_TEXT_ATTR_BG_COLOR,
689
- ATK_TEXT_ATTR_FG_COLOR,
690
- ATK_TEXT_ATTR_BG_STIPPLE,
691
- ATK_TEXT_ATTR_FG_STIPPLE,
692
- ATK_TEXT_ATTR_WRAP_MODE,
693
- ATK_TEXT_ATTR_DIRECTION,
694
- ATK_TEXT_ATTR_JUSTIFICATION,
695
- ATK_TEXT_ATTR_STRETCH,
696
- ATK_TEXT_ATTR_VARIANT,
697
- ATK_TEXT_ATTR_STYLE,
698
- ATK_TEXT_ATTR_LAST_DEFINED
699
- } AtkTextAttribute;
700
- </pre>
701
- <p>
702
- Describes the text attributes supported
703
- </p>
704
- <div class="variablelist"><table border="0">
705
- <col align="left" valign="top">
456
+ <a name="atk-text-get-text-after-offset"></a><h3>atk_text_get_text_after_offset ()</h3>
457
+ <pre class="programlisting"><span class="returnvalue">gchar</span> *
458
+ atk_text_get_text_after_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
459
+ <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
460
+ <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
461
+ <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
462
+ <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
463
+ <div class="warning">
464
+ <p><code class="literal">atk_text_get_text_after_offset</code> is deprecated and should not be used in newly-written code.</p>
465
+ <p>This method is deprecated since ATK version
466
+ 2.9.3. Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
467
+ </div>
468
+ <p>Gets the specified text.</p>
469
+ <div class="refsect3">
470
+ <a name="id-1.5.13.9.4.6"></a><h4>Parameters</h4>
471
+ <div class="informaltable"><table width="100%" border="0">
472
+ <colgroup>
473
+ <col width="150px" class="parameters_name">
474
+ <col class="parameters_description">
475
+ <col width="200px" class="parameters_annotations">
476
+ </colgroup>
706
477
  <tbody>
707
478
  <tr>
708
- <td><p><a name="ATK-TEXT-ATTR-INVALID:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_INVALID</code></span></p></td>
709
- <td>Invalid attribute
710
- </td>
479
+ <td class="parameter_name"><p>text</p></td>
480
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
481
+ <td class="parameter_annotations"> </td>
711
482
  </tr>
712
483
  <tr>
713
- <td><p><a name="ATK-TEXT-ATTR-LEFT-MARGIN:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_LEFT_MARGIN</code></span></p></td>
714
- <td>The pixel width of the left margin
715
- </td>
484
+ <td class="parameter_name"><p>offset</p></td>
485
+ <td class="parameter_description"><p>position</p></td>
486
+ <td class="parameter_annotations"> </td>
716
487
  </tr>
717
488
  <tr>
718
- <td><p><a name="ATK-TEXT-ATTR-RIGHT-MARGIN:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_RIGHT_MARGIN</code></span></p></td>
719
- <td>The pixel width of the right margin
720
- </td>
489
+ <td class="parameter_name"><p>boundary_type</p></td>
490
+ <td class="parameter_description"><p>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a></p></td>
491
+ <td class="parameter_annotations"> </td>
721
492
  </tr>
722
493
  <tr>
723
- <td><p><a name="ATK-TEXT-ATTR-INDENT:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_INDENT</code></span></p></td>
724
- <td>The number of pixels that the text is indented
725
- </td>
494
+ <td class="parameter_name"><p>start_offset</p></td>
495
+ <td class="parameter_description"><p> the start offset of the returned string. </p></td>
496
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
726
497
  </tr>
727
498
  <tr>
728
- <td><p><a name="ATK-TEXT-ATTR-INVISIBLE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_INVISIBLE</code></span></p></td>
729
- <td>Either "true" or "false" indicating whether text is visible or not
730
- </td>
499
+ <td class="parameter_name"><p>end_offset</p></td>
500
+ <td class="parameter_description"><p> the offset of the first character after the
501
+ returned substring. </p></td>
502
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
731
503
  </tr>
504
+ </tbody>
505
+ </table></div>
506
+ </div>
507
+ <div class="refsect3">
508
+ <a name="id-1.5.13.9.4.7"></a><h4>Returns</h4>
509
+ <p> a newly allocated string containing the text after <em class="parameter"><code>offset</code></em>
510
+ bounded
511
+ by the specified <em class="parameter"><code>boundary_type</code></em>
512
+ . Use <code class="function">g_free()</code> to free the returned string.</p>
513
+ <p></p>
514
+ </div>
515
+ </div>
516
+ <hr>
517
+ <div class="refsect2">
518
+ <a name="atk-text-get-text-at-offset"></a><h3>atk_text_get_text_at_offset ()</h3>
519
+ <pre class="programlisting"><span class="returnvalue">gchar</span> *
520
+ atk_text_get_text_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
521
+ <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
522
+ <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
523
+ <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
524
+ <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
525
+ <div class="warning">
526
+ <p><code class="literal">atk_text_get_text_at_offset</code> is deprecated and should not be used in newly-written code.</p>
527
+ <p>This method is deprecated since ATK version
528
+ 2.9.4. Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
529
+ </div>
530
+ <p>Gets the specified text.</p>
531
+ <p>If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
532
+ offset is returned.</p>
533
+ <p>If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
534
+ is from the word start at or before the offset to the word start after
535
+ the offset.</p>
536
+ <p>The returned string will contain the word at the offset if the offset
537
+ is inside a word and will contain the word before the offset if the
538
+ offset is not inside a word.</p>
539
+ <p>If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
540
+ string is from the sentence start at or before the offset to the sentence
541
+ start after the offset.</p>
542
+ <p>The returned string will contain the sentence at the offset if the offset
543
+ is inside a sentence and will contain the sentence before the offset
544
+ if the offset is not inside a sentence.</p>
545
+ <p>If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
546
+ string is from the line start at or before the offset to the line
547
+ start after the offset.</p>
548
+ <div class="refsect3">
549
+ <a name="id-1.5.13.9.5.12"></a><h4>Parameters</h4>
550
+ <div class="informaltable"><table width="100%" border="0">
551
+ <colgroup>
552
+ <col width="150px" class="parameters_name">
553
+ <col class="parameters_description">
554
+ <col width="200px" class="parameters_annotations">
555
+ </colgroup>
556
+ <tbody>
732
557
  <tr>
733
- <td><p><a name="ATK-TEXT-ATTR-EDITABLE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_EDITABLE</code></span></p></td>
734
- <td>Either "true" or "false" indicating whether text is editable or not
735
- </td>
558
+ <td class="parameter_name"><p>text</p></td>
559
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
560
+ <td class="parameter_annotations"> </td>
736
561
  </tr>
737
562
  <tr>
738
- <td><p><a name="ATK-TEXT-ATTR-PIXELS-ABOVE-LINES:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_PIXELS_ABOVE_LINES</code></span></p></td>
739
- <td>Pixels of blank space to leave above each newline-terminated line.
740
- </td>
563
+ <td class="parameter_name"><p>offset</p></td>
564
+ <td class="parameter_description"><p>position</p></td>
565
+ <td class="parameter_annotations"> </td>
741
566
  </tr>
742
567
  <tr>
743
- <td><p><a name="ATK-TEXT-ATTR-PIXELS-BELOW-LINES:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_PIXELS_BELOW_LINES</code></span></p></td>
744
- <td>Pixels of blank space to leave below each newline-terminated line.
745
- </td>
568
+ <td class="parameter_name"><p>boundary_type</p></td>
569
+ <td class="parameter_description"><p>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a></p></td>
570
+ <td class="parameter_annotations"> </td>
746
571
  </tr>
747
572
  <tr>
748
- <td><p><a name="ATK-TEXT-ATTR-PIXELS-INSIDE-WRAP:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP</code></span></p></td>
749
- <td>Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).
750
- </td>
573
+ <td class="parameter_name"><p>start_offset</p></td>
574
+ <td class="parameter_description"><p> the start offset of the returned string. </p></td>
575
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
751
576
  </tr>
752
577
  <tr>
753
- <td><p><a name="ATK-TEXT-ATTR-BG-FULL-HEIGHT:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_BG_FULL_HEIGHT</code></span></p></td>
754
- <td>"true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.
755
- </td>
578
+ <td class="parameter_name"><p>end_offset</p></td>
579
+ <td class="parameter_description"><p> the offset of the first character after the
580
+ returned substring. </p></td>
581
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
756
582
  </tr>
583
+ </tbody>
584
+ </table></div>
585
+ </div>
586
+ <div class="refsect3">
587
+ <a name="id-1.5.13.9.5.13"></a><h4>Returns</h4>
588
+ <p> a newly allocated string containing the text at <em class="parameter"><code>offset</code></em>
589
+ bounded by
590
+ the specified <em class="parameter"><code>boundary_type</code></em>
591
+ . Use <code class="function">g_free()</code> to free the returned string.</p>
592
+ <p></p>
593
+ </div>
594
+ </div>
595
+ <hr>
596
+ <div class="refsect2">
597
+ <a name="atk-text-get-text-before-offset"></a><h3>atk_text_get_text_before_offset ()</h3>
598
+ <pre class="programlisting"><span class="returnvalue">gchar</span> *
599
+ atk_text_get_text_before_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
600
+ <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
601
+ <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
602
+ <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
603
+ <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
604
+ <div class="warning">
605
+ <p><code class="literal">atk_text_get_text_before_offset</code> is deprecated and should not be used in newly-written code.</p>
606
+ <p>This method is deprecated since ATK version
607
+ 2.9.3. Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
608
+ </div>
609
+ <p>Gets the specified text.</p>
610
+ <div class="refsect3">
611
+ <a name="id-1.5.13.9.6.6"></a><h4>Parameters</h4>
612
+ <div class="informaltable"><table width="100%" border="0">
613
+ <colgroup>
614
+ <col width="150px" class="parameters_name">
615
+ <col class="parameters_description">
616
+ <col width="200px" class="parameters_annotations">
617
+ </colgroup>
618
+ <tbody>
757
619
  <tr>
758
- <td><p><a name="ATK-TEXT-ATTR-RISE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_RISE</code></span></p></td>
759
- <td>Number of pixels that the characters are risen above the baseline
760
- </td>
620
+ <td class="parameter_name"><p>text</p></td>
621
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
622
+ <td class="parameter_annotations"> </td>
761
623
  </tr>
762
624
  <tr>
763
- <td><p><a name="ATK-TEXT-ATTR-UNDERLINE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_UNDERLINE</code></span></p></td>
764
- <td>"none", "single", "double", "low", or "error"
765
- </td>
625
+ <td class="parameter_name"><p>offset</p></td>
626
+ <td class="parameter_description"><p>position</p></td>
627
+ <td class="parameter_annotations"> </td>
766
628
  </tr>
767
629
  <tr>
768
- <td><p><a name="ATK-TEXT-ATTR-STRIKETHROUGH:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_STRIKETHROUGH</code></span></p></td>
769
- <td>"true" or "false" whether the text is strikethrough
770
- </td>
630
+ <td class="parameter_name"><p>boundary_type</p></td>
631
+ <td class="parameter_description"><p>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a></p></td>
632
+ <td class="parameter_annotations"> </td>
771
633
  </tr>
772
634
  <tr>
773
- <td><p><a name="ATK-TEXT-ATTR-SIZE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_SIZE</code></span></p></td>
774
- <td>The size of the characters.
775
- </td>
635
+ <td class="parameter_name"><p>start_offset</p></td>
636
+ <td class="parameter_description"><p> the start offset of the returned string. </p></td>
637
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
776
638
  </tr>
777
639
  <tr>
778
- <td><p><a name="ATK-TEXT-ATTR-SCALE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_SCALE</code></span></p></td>
779
- <td>The scale of the characters. The value is a string representation of a double
780
- </td>
640
+ <td class="parameter_name"><p>end_offset</p></td>
641
+ <td class="parameter_description"><p> the offset of the first character after the
642
+ returned substring. </p></td>
643
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
781
644
  </tr>
645
+ </tbody>
646
+ </table></div>
647
+ </div>
648
+ <div class="refsect3">
649
+ <a name="id-1.5.13.9.6.7"></a><h4>Returns</h4>
650
+ <p> a newly allocated string containing the text before <em class="parameter"><code>offset</code></em>
651
+ bounded
652
+ by the specified <em class="parameter"><code>boundary_type</code></em>
653
+ . Use <code class="function">g_free()</code> to free the returned string.</p>
654
+ <p></p>
655
+ </div>
656
+ </div>
657
+ <hr>
658
+ <div class="refsect2">
659
+ <a name="atk-text-get-string-at-offset"></a><h3>atk_text_get_string_at_offset ()</h3>
660
+ <pre class="programlisting"><span class="returnvalue">gchar</span> *
661
+ atk_text_get_string_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
662
+ <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
663
+ <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity"><span class="type">AtkTextGranularity</span></a> granularity</code></em>,
664
+ <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
665
+ <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
666
+ <p>Gets a portion of the text exposed through an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> according to a given <em class="parameter"><code>offset</code></em>
667
+
668
+ and a specific <em class="parameter"><code>granularity</code></em>
669
+ , along with the start and end offsets defining the
670
+ boundaries of such a portion of text.</p>
671
+ <p>If <em class="parameter"><code>granularity</code></em>
672
+ is ATK_TEXT_GRANULARITY_CHAR the character at the
673
+ offset is returned.</p>
674
+ <p>If <em class="parameter"><code>granularity</code></em>
675
+ is ATK_TEXT_GRANULARITY_WORD the returned string
676
+ is from the word start at or before the offset to the word start after
677
+ the offset.</p>
678
+ <p>The returned string will contain the word at the offset if the offset
679
+ is inside a word and will contain the word before the offset if the
680
+ offset is not inside a word.</p>
681
+ <p>If <em class="parameter"><code>granularity</code></em>
682
+ is ATK_TEXT_GRANULARITY_SENTENCE the returned string
683
+ is from the sentence start at or before the offset to the sentence
684
+ start after the offset.</p>
685
+ <p>The returned string will contain the sentence at the offset if the offset
686
+ is inside a sentence and will contain the sentence before the offset
687
+ if the offset is not inside a sentence.</p>
688
+ <p>If <em class="parameter"><code>granularity</code></em>
689
+ is ATK_TEXT_GRANULARITY_LINE the returned string
690
+ is from the line start at or before the offset to the line
691
+ start after the offset.</p>
692
+ <p>If <em class="parameter"><code>granularity</code></em>
693
+ is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string
694
+ is from the start of the paragraph at or before the offset to the start
695
+ of the following paragraph after the offset.</p>
696
+ <div class="refsect3">
697
+ <a name="id-1.5.13.9.7.12"></a><h4>Parameters</h4>
698
+ <div class="informaltable"><table width="100%" border="0">
699
+ <colgroup>
700
+ <col width="150px" class="parameters_name">
701
+ <col class="parameters_description">
702
+ <col width="200px" class="parameters_annotations">
703
+ </colgroup>
704
+ <tbody>
782
705
  <tr>
783
- <td><p><a name="ATK-TEXT-ATTR-WEIGHT:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_WEIGHT</code></span></p></td>
784
- <td>The weight of the characters.
785
- </td>
706
+ <td class="parameter_name"><p>text</p></td>
707
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
708
+ <td class="parameter_annotations"> </td>
786
709
  </tr>
787
710
  <tr>
788
- <td><p><a name="ATK-TEXT-ATTR-LANGUAGE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_LANGUAGE</code></span></p></td>
789
- <td>The language used
790
- </td>
711
+ <td class="parameter_name"><p>offset</p></td>
712
+ <td class="parameter_description"><p>position</p></td>
713
+ <td class="parameter_annotations"> </td>
791
714
  </tr>
792
715
  <tr>
793
- <td><p><a name="ATK-TEXT-ATTR-FAMILY-NAME:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_FAMILY_NAME</code></span></p></td>
794
- <td>The font family name
795
- </td>
716
+ <td class="parameter_name"><p>granularity</p></td>
717
+ <td class="parameter_description"><p>An <a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity"><span class="type">AtkTextGranularity</span></a></p></td>
718
+ <td class="parameter_annotations"> </td>
796
719
  </tr>
797
720
  <tr>
798
- <td><p><a name="ATK-TEXT-ATTR-BG-COLOR:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_BG_COLOR</code></span></p></td>
799
- <td>The background color. The value is an RGB value of the format "<code class="literal">u</code>,<code class="literal">u</code>,<code class="literal">u</code>"
800
- </td>
721
+ <td class="parameter_name"><p>start_offset</p></td>
722
+ <td class="parameter_description"><p> the start offset of the returned string, or -1
723
+ if an error has occurred (e.g. invalid offset, not implemented). </p></td>
724
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
801
725
  </tr>
802
726
  <tr>
803
- <td><p><a name="ATK-TEXT-ATTR-FG-COLOR:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_FG_COLOR</code></span></p></td>
804
- <td>The foreground color. The value is an RGB value of the format "<code class="literal">u</code>,<code class="literal">u</code>,<code class="literal">u</code>"
805
- </td>
727
+ <td class="parameter_name"><p>end_offset</p></td>
728
+ <td class="parameter_description"><p> the offset of the first character after the returned string,
729
+ or -1 if an error has occurred (e.g. invalid offset, not implemented). </p></td>
730
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
806
731
  </tr>
732
+ </tbody>
733
+ </table></div>
734
+ </div>
735
+ <div class="refsect3">
736
+ <a name="id-1.5.13.9.7.13"></a><h4>Returns</h4>
737
+ <p> a newly allocated string containing the text
738
+ at the <em class="parameter"><code>offset</code></em>
739
+ bounded by the specified <em class="parameter"><code>granularity</code></em>
740
+ . Use
741
+ <code class="function">g_free()</code> to free the returned string. Returns <code class="literal">NULL</code> if the
742
+ offset is invalid or no implementation is available. </p>
743
+ <p><span class="annotation">[<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>]</span></p>
744
+ </div>
745
+ <p class="since">Since 2.10</p>
746
+ </div>
747
+ <hr>
748
+ <div class="refsect2">
749
+ <a name="atk-text-get-caret-offset"></a><h3>atk_text_get_caret_offset ()</h3>
750
+ <pre class="programlisting"><span class="returnvalue">gint</span>
751
+ atk_text_get_caret_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
752
+ <p>Gets the offset position of the caret (cursor).</p>
753
+ <div class="refsect3">
754
+ <a name="id-1.5.13.9.8.5"></a><h4>Parameters</h4>
755
+ <div class="informaltable"><table width="100%" border="0">
756
+ <colgroup>
757
+ <col width="150px" class="parameters_name">
758
+ <col class="parameters_description">
759
+ <col width="200px" class="parameters_annotations">
760
+ </colgroup>
761
+ <tbody><tr>
762
+ <td class="parameter_name"><p>text</p></td>
763
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
764
+ <td class="parameter_annotations"> </td>
765
+ </tr></tbody>
766
+ </table></div>
767
+ </div>
768
+ <div class="refsect3">
769
+ <a name="id-1.5.13.9.8.6"></a><h4>Returns</h4>
770
+ <p> the offset position of the caret (cursor).</p>
771
+ <p></p>
772
+ </div>
773
+ </div>
774
+ <hr>
775
+ <div class="refsect2">
776
+ <a name="atk-text-get-character-extents"></a><h3>atk_text_get_character_extents ()</h3>
777
+ <pre class="programlisting"><span class="returnvalue">void</span>
778
+ atk_text_get_character_extents (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
779
+ <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
780
+ <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
781
+ <em class="parameter"><code><span class="type">gint</span> *y</code></em>,
782
+ <em class="parameter"><code><span class="type">gint</span> *width</code></em>,
783
+ <em class="parameter"><code><span class="type">gint</span> *height</code></em>,
784
+ <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coords</code></em>);</pre>
785
+ <p>Get the bounding box containing the glyph representing the character at
786
+ a particular text offset.</p>
787
+ <div class="refsect3">
788
+ <a name="id-1.5.13.9.9.5"></a><h4>Parameters</h4>
789
+ <div class="informaltable"><table width="100%" border="0">
790
+ <colgroup>
791
+ <col width="150px" class="parameters_name">
792
+ <col class="parameters_description">
793
+ <col width="200px" class="parameters_annotations">
794
+ </colgroup>
795
+ <tbody>
807
796
  <tr>
808
- <td><p><a name="ATK-TEXT-ATTR-BG-STIPPLE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_BG_STIPPLE</code></span></p></td>
809
- <td>"true" if a <span class="type">GdkBitmap</span> is set for stippling the background color.
810
- </td>
797
+ <td class="parameter_name"><p>text</p></td>
798
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
799
+ <td class="parameter_annotations"> </td>
811
800
  </tr>
812
801
  <tr>
813
- <td><p><a name="ATK-TEXT-ATTR-FG-STIPPLE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_FG_STIPPLE</code></span></p></td>
814
- <td>"true" if a <span class="type">GdkBitmap</span> is set for stippling the foreground color.
815
- </td>
802
+ <td class="parameter_name"><p>offset</p></td>
803
+ <td class="parameter_description"><p>The offset of the text character for which bounding information is required.</p></td>
804
+ <td class="parameter_annotations"> </td>
816
805
  </tr>
817
806
  <tr>
818
- <td><p><a name="ATK-TEXT-ATTR-WRAP-MODE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_WRAP_MODE</code></span></p></td>
819
- <td>The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char".
820
- </td>
807
+ <td class="parameter_name"><p>x</p></td>
808
+ <td class="parameter_description"><p>Pointer for the x cordinate of the bounding box</p></td>
809
+ <td class="parameter_annotations"> </td>
821
810
  </tr>
822
811
  <tr>
823
- <td><p><a name="ATK-TEXT-ATTR-DIRECTION:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_DIRECTION</code></span></p></td>
824
- <td>The direction of the text, if set. Values are "none", "ltr" or "rtl"
825
- </td>
812
+ <td class="parameter_name"><p>y</p></td>
813
+ <td class="parameter_description"><p>Pointer for the y cordinate of the bounding box</p></td>
814
+ <td class="parameter_annotations"> </td>
826
815
  </tr>
827
816
  <tr>
828
- <td><p><a name="ATK-TEXT-ATTR-JUSTIFICATION:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_JUSTIFICATION</code></span></p></td>
829
- <td>The justification of the text, if set. Values are "left", "right", "center" or "fill"
830
- </td>
817
+ <td class="parameter_name"><p>width</p></td>
818
+ <td class="parameter_description"><p>Pointer for the width of the bounding box</p></td>
819
+ <td class="parameter_annotations"> </td>
831
820
  </tr>
832
821
  <tr>
833
- <td><p><a name="ATK-TEXT-ATTR-STRETCH:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_STRETCH</code></span></p></td>
834
- <td>The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded"
835
- </td>
822
+ <td class="parameter_name"><p>height</p></td>
823
+ <td class="parameter_description"><p>Pointer for the height of the bounding box</p></td>
824
+ <td class="parameter_annotations"> </td>
836
825
  </tr>
837
826
  <tr>
838
- <td><p><a name="ATK-TEXT-ATTR-VARIANT:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_VARIANT</code></span></p></td>
839
- <td>The capitalization variant of the text, if set. Values are "normal" or "small_caps"
840
- </td>
827
+ <td class="parameter_name"><p>coords</p></td>
828
+ <td class="parameter_description"><p>specify whether coordinates are relative to the screen or widget window </p></td>
829
+ <td class="parameter_annotations"> </td>
830
+ </tr>
831
+ </tbody>
832
+ </table></div>
833
+ </div>
834
+ </div>
835
+ <hr>
836
+ <div class="refsect2">
837
+ <a name="atk-text-get-run-attributes"></a><h3>atk_text_get_run_attributes ()</h3>
838
+ <pre class="programlisting"><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
839
+ atk_text_get_run_attributes (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
840
+ <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
841
+ <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
842
+ <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
843
+ <p>Creates an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which consists of the attributes explicitly
844
+ set at the position <em class="parameter"><code>offset</code></em>
845
+ in the text. <em class="parameter"><code>start_offset</code></em>
846
+ and <em class="parameter"><code>end_offset</code></em>
847
+ are
848
+ set to the start and end of the range around <em class="parameter"><code>offset</code></em>
849
+ where the attributes are
850
+ invariant. Note that <em class="parameter"><code>end_offset</code></em>
851
+ is the offset of the first character
852
+ after the range. See the enum AtkTextAttribute for types of text
853
+ attributes that can be returned. Note that other attributes may also be
854
+ returned.</p>
855
+ <div class="refsect3">
856
+ <a name="id-1.5.13.9.10.5"></a><h4>Parameters</h4>
857
+ <div class="informaltable"><table width="100%" border="0">
858
+ <colgroup>
859
+ <col width="150px" class="parameters_name">
860
+ <col class="parameters_description">
861
+ <col width="200px" class="parameters_annotations">
862
+ </colgroup>
863
+ <tbody>
864
+ <tr>
865
+ <td class="parameter_name"><p>text</p></td>
866
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
867
+ <td class="parameter_annotations"> </td>
841
868
  </tr>
842
869
  <tr>
843
- <td><p><a name="ATK-TEXT-ATTR-STYLE:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_STYLE</code></span></p></td>
844
- <td>The slant style of the text, if set. Values are "normal", "oblique" or "italic"
845
- </td>
870
+ <td class="parameter_name"><p>offset</p></td>
871
+ <td class="parameter_description"><p>the offset at which to get the attributes, -1 means the offset of
872
+ the character to be inserted at the caret location.</p></td>
873
+ <td class="parameter_annotations"> </td>
846
874
  </tr>
847
875
  <tr>
848
- <td><p><a name="ATK-TEXT-ATTR-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATK_TEXT_ATTR_LAST_DEFINED</code></span></p></td>
849
- <td>not a valid text attribute, used for finding end of enumeration
850
- </td>
876
+ <td class="parameter_name"><p>start_offset</p></td>
877
+ <td class="parameter_description"><p> the address to put the start offset of the range. </p></td>
878
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
879
+ </tr>
880
+ <tr>
881
+ <td class="parameter_name"><p>end_offset</p></td>
882
+ <td class="parameter_description"><p> the address to put the end offset of the range. </p></td>
883
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
851
884
  </tr>
852
885
  </tbody>
853
886
  </table></div>
854
887
  </div>
888
+ <div class="refsect3">
889
+ <a name="id-1.5.13.9.10.6"></a><h4>Returns</h4>
890
+ <p> an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which contains the attributes
891
+ explicitly set at <em class="parameter"><code>offset</code></em>
892
+ . This <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> should be freed by a call
893
+ to <a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()"><code class="function">atk_attribute_set_free()</code></a>. </p>
894
+ <p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
895
+ </div>
896
+ </div>
855
897
  <hr>
856
898
  <div class="refsect2">
857
- <a name="atk-text-get-text"></a><h3>atk_text_get_text ()</h3>
858
- <pre class="programlisting"><span class="returnvalue">gchar</span> * atk_text_get_text (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
859
- <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
860
- <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);</pre>
861
- <p>
862
- Gets the specified text.
863
- </p>
864
- <div class="variablelist"><table border="0">
865
- <col align="left" valign="top">
899
+ <a name="atk-text-get-default-attributes"></a><h3>atk_text_get_default_attributes ()</h3>
900
+ <pre class="programlisting"><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> *
901
+ atk_text_get_default_attributes (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
902
+ <p>Creates an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which consists of the default values of
903
+ attributes for the text. See the enum AtkTextAttribute for types of text
904
+ attributes that can be returned. Note that other attributes may also be
905
+ returned.</p>
906
+ <div class="refsect3">
907
+ <a name="id-1.5.13.9.11.5"></a><h4>Parameters</h4>
908
+ <div class="informaltable"><table width="100%" border="0">
909
+ <colgroup>
910
+ <col width="150px" class="parameters_name">
911
+ <col class="parameters_description">
912
+ <col width="200px" class="parameters_annotations">
913
+ </colgroup>
914
+ <tbody><tr>
915
+ <td class="parameter_name"><p>text</p></td>
916
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
917
+ <td class="parameter_annotations"> </td>
918
+ </tr></tbody>
919
+ </table></div>
920
+ </div>
921
+ <div class="refsect3">
922
+ <a name="id-1.5.13.9.11.6"></a><h4>Returns</h4>
923
+ <p> an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which contains the default
924
+ values of attributes. at <em class="parameter"><code>offset</code></em>
925
+ . this <span class="type">atkattributeset</span> should be freed by
926
+ a call to <a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()"><code class="function">atk_attribute_set_free()</code></a>. </p>
927
+ <p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
928
+ </div>
929
+ </div>
930
+ <hr>
931
+ <div class="refsect2">
932
+ <a name="atk-text-get-character-count"></a><h3>atk_text_get_character_count ()</h3>
933
+ <pre class="programlisting"><span class="returnvalue">gint</span>
934
+ atk_text_get_character_count (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
935
+ <p>Gets the character count.</p>
936
+ <div class="refsect3">
937
+ <a name="id-1.5.13.9.12.5"></a><h4>Parameters</h4>
938
+ <div class="informaltable"><table width="100%" border="0">
939
+ <colgroup>
940
+ <col width="150px" class="parameters_name">
941
+ <col class="parameters_description">
942
+ <col width="200px" class="parameters_annotations">
943
+ </colgroup>
944
+ <tbody><tr>
945
+ <td class="parameter_name"><p>text</p></td>
946
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
947
+ <td class="parameter_annotations"> </td>
948
+ </tr></tbody>
949
+ </table></div>
950
+ </div>
951
+ <div class="refsect3">
952
+ <a name="id-1.5.13.9.12.6"></a><h4>Returns</h4>
953
+ <p> the number of characters.</p>
954
+ <p></p>
955
+ </div>
956
+ </div>
957
+ <hr>
958
+ <div class="refsect2">
959
+ <a name="atk-text-get-offset-at-point"></a><h3>atk_text_get_offset_at_point ()</h3>
960
+ <pre class="programlisting"><span class="returnvalue">gint</span>
961
+ atk_text_get_offset_at_point (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
962
+ <em class="parameter"><code><span class="type">gint</span> x</code></em>,
963
+ <em class="parameter"><code><span class="type">gint</span> y</code></em>,
964
+ <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coords</code></em>);</pre>
965
+ <p>Gets the offset of the character located at coordinates <em class="parameter"><code>x</code></em>
966
+ and <em class="parameter"><code>y</code></em>
967
+ . <em class="parameter"><code>x</code></em>
968
+ and <em class="parameter"><code>y</code></em>
969
+
970
+ are interpreted as being relative to the screen or this widget's window
971
+ depending on <em class="parameter"><code>coords</code></em>
972
+ .</p>
973
+ <div class="refsect3">
974
+ <a name="id-1.5.13.9.13.5"></a><h4>Parameters</h4>
975
+ <div class="informaltable"><table width="100%" border="0">
976
+ <colgroup>
977
+ <col width="150px" class="parameters_name">
978
+ <col class="parameters_description">
979
+ <col width="200px" class="parameters_annotations">
980
+ </colgroup>
866
981
  <tbody>
867
982
  <tr>
868
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
869
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
870
- </td>
983
+ <td class="parameter_name"><p>text</p></td>
984
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
985
+ <td class="parameter_annotations"> </td>
871
986
  </tr>
872
987
  <tr>
873
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
874
- <td>start position</td>
988
+ <td class="parameter_name"><p>x</p></td>
989
+ <td class="parameter_description"><p>screen x-position of character</p></td>
990
+ <td class="parameter_annotations"> </td>
875
991
  </tr>
876
992
  <tr>
877
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
878
- <td>end position, or -1 for the end of the string.</td>
993
+ <td class="parameter_name"><p>y</p></td>
994
+ <td class="parameter_description"><p>screen y-position of character</p></td>
995
+ <td class="parameter_annotations"> </td>
879
996
  </tr>
880
997
  <tr>
881
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
882
- <td>a newly allocated string containing the text from <em class="parameter"><code>start_offset</code></em> up
883
- to, but not including <em class="parameter"><code>end_offset</code></em>. Use <code class="function">g_free()</code> to free the returned string.</td>
998
+ <td class="parameter_name"><p>coords</p></td>
999
+ <td class="parameter_description"><p>specify whether coordinates are relative to the screen or
1000
+ widget window </p></td>
1001
+ <td class="parameter_annotations"> </td>
884
1002
  </tr>
885
1003
  </tbody>
886
1004
  </table></div>
887
1005
  </div>
1006
+ <div class="refsect3">
1007
+ <a name="id-1.5.13.9.13.6"></a><h4>Returns</h4>
1008
+ <p> the offset to the character which is located at
1009
+ the specified <em class="parameter"><code>x</code></em>
1010
+ and <em class="parameter"><code>y</code></em>
1011
+ coordinates.</p>
1012
+ <p></p>
1013
+ </div>
1014
+ </div>
888
1015
  <hr>
889
1016
  <div class="refsect2">
890
- <a name="atk-text-get-character-at-offset"></a><h3>atk_text_get_character_at_offset ()</h3>
891
- <pre class="programlisting"><span class="returnvalue">gunichar</span> atk_text_get_character_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
892
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>);</pre>
893
- <p>
894
- Gets the specified text.
895
- </p>
896
- <div class="variablelist"><table border="0">
897
- <col align="left" valign="top">
1017
+ <a name="atk-text-get-bounded-ranges"></a><h3>atk_text_get_bounded_ranges ()</h3>
1018
+ <pre class="programlisting"><a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="returnvalue">AtkTextRange</span></a> **
1019
+ atk_text_get_bounded_ranges (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1020
+ <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> *rect</code></em>,
1021
+ <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coord_type</code></em>,
1022
+ <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType"><span class="type">AtkTextClipType</span></a> x_clip_type</code></em>,
1023
+ <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType"><span class="type">AtkTextClipType</span></a> y_clip_type</code></em>);</pre>
1024
+ <p>Get the ranges of text in the specified bounding box.</p>
1025
+ <div class="refsect3">
1026
+ <a name="id-1.5.13.9.14.5"></a><h4>Parameters</h4>
1027
+ <div class="informaltable"><table width="100%" border="0">
1028
+ <colgroup>
1029
+ <col width="150px" class="parameters_name">
1030
+ <col class="parameters_description">
1031
+ <col width="200px" class="parameters_annotations">
1032
+ </colgroup>
898
1033
  <tbody>
899
1034
  <tr>
900
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
901
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
902
- </td>
1035
+ <td class="parameter_name"><p>text</p></td>
1036
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
1037
+ <td class="parameter_annotations"> </td>
903
1038
  </tr>
904
1039
  <tr>
905
- <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
906
- <td>position</td>
1040
+ <td class="parameter_name"><p>rect</p></td>
1041
+ <td class="parameter_description"><p>An AtkTextRectangle giving the dimensions of the bounding box.</p></td>
1042
+ <td class="parameter_annotations"> </td>
907
1043
  </tr>
908
1044
  <tr>
909
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
910
- <td>the character at <em class="parameter"><code>offset</code></em>.</td>
1045
+ <td class="parameter_name"><p>coord_type</p></td>
1046
+ <td class="parameter_description"><p>Specify whether coordinates are relative to the screen or widget window.</p></td>
1047
+ <td class="parameter_annotations"> </td>
1048
+ </tr>
1049
+ <tr>
1050
+ <td class="parameter_name"><p>x_clip_type</p></td>
1051
+ <td class="parameter_description"><p>Specify the horizontal clip type.</p></td>
1052
+ <td class="parameter_annotations"> </td>
1053
+ </tr>
1054
+ <tr>
1055
+ <td class="parameter_name"><p>y_clip_type</p></td>
1056
+ <td class="parameter_description"><p>Specify the vertical clip type.</p></td>
1057
+ <td class="parameter_annotations"> </td>
911
1058
  </tr>
912
1059
  </tbody>
913
1060
  </table></div>
914
1061
  </div>
1062
+ <div class="refsect3">
1063
+ <a name="id-1.5.13.9.14.6"></a><h4>Returns</h4>
1064
+ <p> Array of AtkTextRange. The last
1065
+ element of the array returned by this function will be NULL. </p>
1066
+ <p><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span></p>
1067
+ </div>
1068
+ <p class="since">Since 1.3</p>
1069
+ </div>
915
1070
  <hr>
916
1071
  <div class="refsect2">
917
- <a name="atk-text-get-text-after-offset"></a><h3>atk_text_get_text_after_offset ()</h3>
918
- <pre class="programlisting"><span class="returnvalue">gchar</span> * atk_text_get_text_after_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
919
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
920
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
921
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
922
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
923
- <div class="warning">
924
- <h3 class="title">Warning</h3>
925
- <p><code class="literal">atk_text_get_text_after_offset</code> is deprecated and should not be used in newly-written code. This method is deprecated since ATK version
926
- 2.9.3. Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
927
- </div>
928
- <p>
929
- Gets the specified text.
930
- </p>
931
- <div class="variablelist"><table border="0">
932
- <col align="left" valign="top">
1072
+ <a name="atk-text-get-range-extents"></a><h3>atk_text_get_range_extents ()</h3>
1073
+ <pre class="programlisting"><span class="returnvalue">void</span>
1074
+ atk_text_get_range_extents (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1075
+ <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
1076
+ <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
1077
+ <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coord_type</code></em>,
1078
+ <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> *rect</code></em>);</pre>
1079
+ <p>Get the bounding box for text within the specified range.</p>
1080
+ <div class="refsect3">
1081
+ <a name="id-1.5.13.9.15.5"></a><h4>Parameters</h4>
1082
+ <div class="informaltable"><table width="100%" border="0">
1083
+ <colgroup>
1084
+ <col width="150px" class="parameters_name">
1085
+ <col class="parameters_description">
1086
+ <col width="200px" class="parameters_annotations">
1087
+ </colgroup>
933
1088
  <tbody>
934
1089
  <tr>
935
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
936
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
937
- </td>
938
- </tr>
939
- <tr>
940
- <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
941
- <td>position</td>
1090
+ <td class="parameter_name"><p>text</p></td>
1091
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
1092
+ <td class="parameter_annotations"> </td>
942
1093
  </tr>
943
1094
  <tr>
944
- <td><p><span class="term"><em class="parameter"><code>boundary_type</code></em> :</span></p></td>
945
- <td>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a>
946
- </td>
1095
+ <td class="parameter_name"><p>start_offset</p></td>
1096
+ <td class="parameter_description"><p>The offset of the first text character for which boundary
1097
+ information is required.</p></td>
1098
+ <td class="parameter_annotations"> </td>
947
1099
  </tr>
948
1100
  <tr>
949
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
950
- <td>the start offset of the returned string. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
951
- </td>
1101
+ <td class="parameter_name"><p>end_offset</p></td>
1102
+ <td class="parameter_description"><p>The offset of the text character after the last character
1103
+ for which boundary information is required.</p></td>
1104
+ <td class="parameter_annotations"> </td>
952
1105
  </tr>
953
1106
  <tr>
954
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
955
- <td>the offset of the first character after the
956
- returned substring. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
957
- </td>
1107
+ <td class="parameter_name"><p>coord_type</p></td>
1108
+ <td class="parameter_description"><p>Specify whether coordinates are relative to the screen or widget window.</p></td>
1109
+ <td class="parameter_annotations"> </td>
958
1110
  </tr>
959
1111
  <tr>
960
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
961
- <td>a newly allocated string containing the text after <em class="parameter"><code>offset</code></em> bounded
962
- by the specified <em class="parameter"><code>boundary_type</code></em>. Use <code class="function">g_free()</code> to free the returned string.</td>
1112
+ <td class="parameter_name"><p>rect</p></td>
1113
+ <td class="parameter_description"><p>A pointer to a AtkTextRectangle which is filled in by this function.</p></td>
1114
+ <td class="parameter_annotations"> </td>
963
1115
  </tr>
964
1116
  </tbody>
965
1117
  </table></div>
966
1118
  </div>
1119
+ <p class="since">Since 1.3</p>
1120
+ </div>
967
1121
  <hr>
968
1122
  <div class="refsect2">
969
- <a name="atk-text-get-text-at-offset"></a><h3>atk_text_get_text_at_offset ()</h3>
970
- <pre class="programlisting"><span class="returnvalue">gchar</span> * atk_text_get_text_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
971
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
972
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
973
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
974
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
975
- <div class="warning">
976
- <h3 class="title">Warning</h3>
977
- <p><code class="literal">atk_text_get_text_at_offset</code> is deprecated and should not be used in newly-written code. This method is deprecated since ATK version
978
- 2.9.4. Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
1123
+ <a name="atk-text-free-ranges"></a><h3>atk_text_free_ranges ()</h3>
1124
+ <pre class="programlisting"><span class="returnvalue">void</span>
1125
+ atk_text_free_ranges (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="type">AtkTextRange</span></a> **ranges</code></em>);</pre>
1126
+ <p>Frees the memory associated with an array of AtkTextRange. It is assumed
1127
+ that the array was returned by the function atk_text_get_bounded_ranges
1128
+ and is NULL terminated.</p>
1129
+ <div class="refsect3">
1130
+ <a name="id-1.5.13.9.16.5"></a><h4>Parameters</h4>
1131
+ <div class="informaltable"><table width="100%" border="0">
1132
+ <colgroup>
1133
+ <col width="150px" class="parameters_name">
1134
+ <col class="parameters_description">
1135
+ <col width="200px" class="parameters_annotations">
1136
+ </colgroup>
1137
+ <tbody><tr>
1138
+ <td class="parameter_name"><p>ranges</p></td>
1139
+ <td class="parameter_description"><p> A pointer to an array of <a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="type">AtkTextRange</span></a> which is
1140
+ to be freed. </p></td>
1141
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a>]</span></td>
1142
+ </tr></tbody>
1143
+ </table></div>
979
1144
  </div>
980
- <p>
981
- Gets the specified text.
982
- </p>
983
- <p>
984
- If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the
985
- offset is returned.
986
- </p>
987
- <p>
988
- If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
989
- is from the word start at or before the offset to the word start after
990
- the offset.
991
- </p>
992
- <p>
993
- The returned string will contain the word at the offset if the offset
994
- is inside a word and will contain the word before the offset if the
995
- offset is not inside a word.
996
- </p>
997
- <p>
998
- If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned
999
- string is from the sentence start at or before the offset to the sentence
1000
- start after the offset.
1001
- </p>
1002
- <p>
1003
- The returned string will contain the sentence at the offset if the offset
1004
- is inside a sentence and will contain the sentence before the offset
1005
- if the offset is not inside a sentence.
1006
- </p>
1007
- <p>
1008
- If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned
1009
- string is from the line start at or before the offset to the line
1010
- start after the offset.
1011
- </p>
1012
- <div class="variablelist"><table border="0">
1013
- <col align="left" valign="top">
1145
+ <p class="since">Since 1.3</p>
1146
+ </div>
1147
+ <hr>
1148
+ <div class="refsect2">
1149
+ <a name="atk-text-get-n-selections"></a><h3>atk_text_get_n_selections ()</h3>
1150
+ <pre class="programlisting"><span class="returnvalue">gint</span>
1151
+ atk_text_get_n_selections (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
1152
+ <p>Gets the number of selected regions.</p>
1153
+ <div class="refsect3">
1154
+ <a name="id-1.5.13.9.17.5"></a><h4>Parameters</h4>
1155
+ <div class="informaltable"><table width="100%" border="0">
1156
+ <colgroup>
1157
+ <col width="150px" class="parameters_name">
1158
+ <col class="parameters_description">
1159
+ <col width="200px" class="parameters_annotations">
1160
+ </colgroup>
1161
+ <tbody><tr>
1162
+ <td class="parameter_name"><p>text</p></td>
1163
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
1164
+ <td class="parameter_annotations"> </td>
1165
+ </tr></tbody>
1166
+ </table></div>
1167
+ </div>
1168
+ <div class="refsect3">
1169
+ <a name="id-1.5.13.9.17.6"></a><h4>Returns</h4>
1170
+ <p> The number of selected regions, or -1 if a failure
1171
+ occurred.</p>
1172
+ <p></p>
1173
+ </div>
1174
+ </div>
1175
+ <hr>
1176
+ <div class="refsect2">
1177
+ <a name="atk-text-get-selection"></a><h3>atk_text_get_selection ()</h3>
1178
+ <pre class="programlisting"><span class="returnvalue">gchar</span> *
1179
+ atk_text_get_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1180
+ <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
1181
+ <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
1182
+ <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
1183
+ <p>Gets the text from the specified selection.</p>
1184
+ <div class="refsect3">
1185
+ <a name="id-1.5.13.9.18.5"></a><h4>Parameters</h4>
1186
+ <div class="informaltable"><table width="100%" border="0">
1187
+ <colgroup>
1188
+ <col width="150px" class="parameters_name">
1189
+ <col class="parameters_description">
1190
+ <col width="200px" class="parameters_annotations">
1191
+ </colgroup>
1014
1192
  <tbody>
1015
1193
  <tr>
1016
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1017
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1018
- </td>
1194
+ <td class="parameter_name"><p>text</p></td>
1195
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
1196
+ <td class="parameter_annotations"> </td>
1019
1197
  </tr>
1020
1198
  <tr>
1021
- <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
1022
- <td>position</td>
1199
+ <td class="parameter_name"><p>selection_num</p></td>
1200
+ <td class="parameter_description"><p>The selection number. The selected regions are
1201
+ assigned numbers that correspond to how far the region is from the
1202
+ start of the text. The selected region closest to the beginning
1203
+ of the text region is assigned the number 0, etc. Note that adding,
1204
+ moving or deleting a selected region can change the numbering.</p></td>
1205
+ <td class="parameter_annotations"> </td>
1023
1206
  </tr>
1024
1207
  <tr>
1025
- <td><p><span class="term"><em class="parameter"><code>boundary_type</code></em> :</span></p></td>
1026
- <td>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a>
1027
- </td>
1208
+ <td class="parameter_name"><p>start_offset</p></td>
1209
+ <td class="parameter_description"><p> passes back the start position of the selected region. </p></td>
1210
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
1028
1211
  </tr>
1029
1212
  <tr>
1030
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1031
- <td>the start offset of the returned string. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
1032
- </td>
1213
+ <td class="parameter_name"><p>end_offset</p></td>
1214
+ <td class="parameter_description"><p> passes back the end position of (e.g. offset immediately past)
1215
+ the selected region. </p></td>
1216
+ <td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span></td>
1033
1217
  </tr>
1218
+ </tbody>
1219
+ </table></div>
1220
+ </div>
1221
+ <div class="refsect3">
1222
+ <a name="id-1.5.13.9.18.6"></a><h4>Returns</h4>
1223
+ <p> a newly allocated string containing the selected text. Use <code class="function">g_free()</code>
1224
+ to free the returned string.</p>
1225
+ <p></p>
1226
+ </div>
1227
+ </div>
1228
+ <hr>
1229
+ <div class="refsect2">
1230
+ <a name="atk-text-add-selection"></a><h3>atk_text_add_selection ()</h3>
1231
+ <pre class="programlisting"><span class="returnvalue">gboolean</span>
1232
+ atk_text_add_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1233
+ <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
1234
+ <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);</pre>
1235
+ <p>Adds a selection bounded by the specified offsets.</p>
1236
+ <div class="refsect3">
1237
+ <a name="id-1.5.13.9.19.5"></a><h4>Parameters</h4>
1238
+ <div class="informaltable"><table width="100%" border="0">
1239
+ <colgroup>
1240
+ <col width="150px" class="parameters_name">
1241
+ <col class="parameters_description">
1242
+ <col width="200px" class="parameters_annotations">
1243
+ </colgroup>
1244
+ <tbody>
1034
1245
  <tr>
1035
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1036
- <td>the offset of the first character after the
1037
- returned substring. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
1038
- </td>
1246
+ <td class="parameter_name"><p>text</p></td>
1247
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
1248
+ <td class="parameter_annotations"> </td>
1249
+ </tr>
1250
+ <tr>
1251
+ <td class="parameter_name"><p>start_offset</p></td>
1252
+ <td class="parameter_description"><p>the start position of the selected region</p></td>
1253
+ <td class="parameter_annotations"> </td>
1039
1254
  </tr>
1040
1255
  <tr>
1041
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1042
- <td>a newly allocated string containing the text at <em class="parameter"><code>offset</code></em> bounded by
1043
- the specified <em class="parameter"><code>boundary_type</code></em>. Use <code class="function">g_free()</code> to free the returned string.</td>
1256
+ <td class="parameter_name"><p>end_offset</p></td>
1257
+ <td class="parameter_description"><p>the offset of the first character after the selected region.</p></td>
1258
+ <td class="parameter_annotations"> </td>
1044
1259
  </tr>
1045
1260
  </tbody>
1046
1261
  </table></div>
1047
1262
  </div>
1263
+ <div class="refsect3">
1264
+ <a name="id-1.5.13.9.19.6"></a><h4>Returns</h4>
1265
+ <p> <code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise</p>
1266
+ <p></p>
1267
+ </div>
1268
+ </div>
1048
1269
  <hr>
1049
1270
  <div class="refsect2">
1050
- <a name="atk-text-get-text-before-offset"></a><h3>atk_text_get_text_before_offset ()</h3>
1051
- <pre class="programlisting"><span class="returnvalue">gchar</span> * atk_text_get_text_before_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1052
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
1053
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a> boundary_type</code></em>,
1054
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
1055
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
1056
- <div class="warning">
1057
- <h3 class="title">Warning</h3>
1058
- <p><code class="literal">atk_text_get_text_before_offset</code> is deprecated and should not be used in newly-written code. This method is deprecated since ATK version
1059
- 2.9.3. Please use <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><code class="function">atk_text_get_string_at_offset()</code></a> instead.</p>
1271
+ <a name="atk-text-remove-selection"></a><h3>atk_text_remove_selection ()</h3>
1272
+ <pre class="programlisting"><span class="returnvalue">gboolean</span>
1273
+ atk_text_remove_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1274
+ <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>);</pre>
1275
+ <p>Removes the specified selection.</p>
1276
+ <div class="refsect3">
1277
+ <a name="id-1.5.13.9.20.5"></a><h4>Parameters</h4>
1278
+ <div class="informaltable"><table width="100%" border="0">
1279
+ <colgroup>
1280
+ <col width="150px" class="parameters_name">
1281
+ <col class="parameters_description">
1282
+ <col width="200px" class="parameters_annotations">
1283
+ </colgroup>
1284
+ <tbody>
1285
+ <tr>
1286
+ <td class="parameter_name"><p>text</p></td>
1287
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
1288
+ <td class="parameter_annotations"> </td>
1289
+ </tr>
1290
+ <tr>
1291
+ <td class="parameter_name"><p>selection_num</p></td>
1292
+ <td class="parameter_description"><p>The selection number. The selected regions are
1293
+ assigned numbers that correspond to how far the region is from the
1294
+ start of the text. The selected region closest to the beginning
1295
+ of the text region is assigned the number 0, etc. Note that adding,
1296
+ moving or deleting a selected region can change the numbering.</p></td>
1297
+ <td class="parameter_annotations"> </td>
1298
+ </tr>
1299
+ </tbody>
1300
+ </table></div>
1060
1301
  </div>
1061
- <p>
1062
- Gets the specified text.
1063
- </p>
1064
- <div class="variablelist"><table border="0">
1065
- <col align="left" valign="top">
1302
+ <div class="refsect3">
1303
+ <a name="id-1.5.13.9.20.6"></a><h4>Returns</h4>
1304
+ <p> <code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise</p>
1305
+ <p></p>
1306
+ </div>
1307
+ </div>
1308
+ <hr>
1309
+ <div class="refsect2">
1310
+ <a name="atk-text-set-selection"></a><h3>atk_text_set_selection ()</h3>
1311
+ <pre class="programlisting"><span class="returnvalue">gboolean</span>
1312
+ atk_text_set_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1313
+ <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
1314
+ <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
1315
+ <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);</pre>
1316
+ <p>Changes the start and end offset of the specified selection.</p>
1317
+ <div class="refsect3">
1318
+ <a name="id-1.5.13.9.21.5"></a><h4>Parameters</h4>
1319
+ <div class="informaltable"><table width="100%" border="0">
1320
+ <colgroup>
1321
+ <col width="150px" class="parameters_name">
1322
+ <col class="parameters_description">
1323
+ <col width="200px" class="parameters_annotations">
1324
+ </colgroup>
1066
1325
  <tbody>
1067
1326
  <tr>
1068
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1069
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1070
- </td>
1327
+ <td class="parameter_name"><p>text</p></td>
1328
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
1329
+ <td class="parameter_annotations"> </td>
1071
1330
  </tr>
1072
1331
  <tr>
1073
- <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
1074
- <td>position</td>
1332
+ <td class="parameter_name"><p>selection_num</p></td>
1333
+ <td class="parameter_description"><p>The selection number. The selected regions are
1334
+ assigned numbers that correspond to how far the region is from the
1335
+ start of the text. The selected region closest to the beginning
1336
+ of the text region is assigned the number 0, etc. Note that adding,
1337
+ moving or deleting a selected region can change the numbering.</p></td>
1338
+ <td class="parameter_annotations"> </td>
1075
1339
  </tr>
1076
1340
  <tr>
1077
- <td><p><span class="term"><em class="parameter"><code>boundary_type</code></em> :</span></p></td>
1078
- <td>An <a class="link" href="AtkText.html#AtkTextBoundary" title="enum AtkTextBoundary"><span class="type">AtkTextBoundary</span></a>
1079
- </td>
1341
+ <td class="parameter_name"><p>start_offset</p></td>
1342
+ <td class="parameter_description"><p>the new start position of the selection</p></td>
1343
+ <td class="parameter_annotations"> </td>
1080
1344
  </tr>
1081
1345
  <tr>
1082
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1083
- <td>the start offset of the returned string. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
1084
- </td>
1346
+ <td class="parameter_name"><p>end_offset</p></td>
1347
+ <td class="parameter_description"><p>the new end position of (e.g. offset immediately past)
1348
+ the selection</p></td>
1349
+ <td class="parameter_annotations"> </td>
1085
1350
  </tr>
1351
+ </tbody>
1352
+ </table></div>
1353
+ </div>
1354
+ <div class="refsect3">
1355
+ <a name="id-1.5.13.9.21.6"></a><h4>Returns</h4>
1356
+ <p> <code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise</p>
1357
+ <p></p>
1358
+ </div>
1359
+ </div>
1360
+ <hr>
1361
+ <div class="refsect2">
1362
+ <a name="atk-text-set-caret-offset"></a><h3>atk_text_set_caret_offset ()</h3>
1363
+ <pre class="programlisting"><span class="returnvalue">gboolean</span>
1364
+ atk_text_set_caret_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1365
+ <em class="parameter"><code><span class="type">gint</span> offset</code></em>);</pre>
1366
+ <p>Sets the caret (cursor) position to the specified <em class="parameter"><code>offset</code></em>
1367
+ .</p>
1368
+ <div class="refsect3">
1369
+ <a name="id-1.5.13.9.22.5"></a><h4>Parameters</h4>
1370
+ <div class="informaltable"><table width="100%" border="0">
1371
+ <colgroup>
1372
+ <col width="150px" class="parameters_name">
1373
+ <col class="parameters_description">
1374
+ <col width="200px" class="parameters_annotations">
1375
+ </colgroup>
1376
+ <tbody>
1086
1377
  <tr>
1087
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1088
- <td>the offset of the first character after the
1089
- returned substring. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
1090
- </td>
1378
+ <td class="parameter_name"><p>text</p></td>
1379
+ <td class="parameter_description"><p>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a></p></td>
1380
+ <td class="parameter_annotations"> </td>
1091
1381
  </tr>
1092
1382
  <tr>
1093
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1094
- <td>a newly allocated string containing the text before <em class="parameter"><code>offset</code></em> bounded
1095
- by the specified <em class="parameter"><code>boundary_type</code></em>. Use <code class="function">g_free()</code> to free the returned string.</td>
1383
+ <td class="parameter_name"><p>offset</p></td>
1384
+ <td class="parameter_description"><p>position</p></td>
1385
+ <td class="parameter_annotations"> </td>
1096
1386
  </tr>
1097
1387
  </tbody>
1098
1388
  </table></div>
1099
1389
  </div>
1390
+ <div class="refsect3">
1391
+ <a name="id-1.5.13.9.22.6"></a><h4>Returns</h4>
1392
+ <p> <code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise.</p>
1393
+ <p></p>
1394
+ </div>
1395
+ </div>
1396
+ <hr>
1397
+ <div class="refsect2">
1398
+ <a name="atk-attribute-set-free"></a><h3>atk_attribute_set_free ()</h3>
1399
+ <pre class="programlisting"><span class="returnvalue">void</span>
1400
+ atk_attribute_set_free (<em class="parameter"><code><a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> *attrib_set</code></em>);</pre>
1401
+ <p>Frees the memory used by an <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>, including all its
1402
+ <a href="AtkObject.html#AtkAttribute"><span class="type">AtkAttributes</span></a>.</p>
1403
+ <div class="refsect3">
1404
+ <a name="id-1.5.13.9.23.5"></a><h4>Parameters</h4>
1405
+ <div class="informaltable"><table width="100%" border="0">
1406
+ <colgroup>
1407
+ <col width="150px" class="parameters_name">
1408
+ <col class="parameters_description">
1409
+ <col width="200px" class="parameters_annotations">
1410
+ </colgroup>
1411
+ <tbody><tr>
1412
+ <td class="parameter_name"><p>attrib_set</p></td>
1413
+ <td class="parameter_description"><p>The <a class="link" href="AtkObject.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> to free</p></td>
1414
+ <td class="parameter_annotations"> </td>
1415
+ </tr></tbody>
1416
+ </table></div>
1417
+ </div>
1418
+ </div>
1100
1419
  <hr>
1101
1420
  <div class="refsect2">
1102
- <a name="atk-text-get-string-at-offset"></a><h3>atk_text_get_string_at_offset ()</h3>
1103
- <pre class="programlisting"><span class="returnvalue">gchar</span> * atk_text_get_string_at_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1104
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
1105
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity"><span class="type">AtkTextGranularity</span></a> granularity</code></em>,
1106
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
1107
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
1108
- <p>
1109
- Gets a portion of the text exposed through an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> according to a given <em class="parameter"><code>offset</code></em>
1110
- and a specific <em class="parameter"><code>granularity</code></em>, along with the start and end offsets defining the
1111
- boundaries of such a portion of text.
1112
- </p>
1113
- <p>
1114
- If <em class="parameter"><code>granularity</code></em> is ATK_TEXT_GRANULARITY_CHAR the character at the
1115
- offset is returned.
1116
- </p>
1117
- <p>
1118
- If <em class="parameter"><code>granularity</code></em> is ATK_TEXT_GRANULARITY_WORD the returned string
1119
- is from the word start at or before the offset to the word start after
1120
- the offset.
1121
- </p>
1122
- <p>
1123
- The returned string will contain the word at the offset if the offset
1124
- is inside a word and will contain the word before the offset if the
1125
- offset is not inside a word.
1126
- </p>
1127
- <p>
1128
- If <em class="parameter"><code>granularity</code></em> is ATK_TEXT_GRANULARITY_SENTENCE the returned string
1129
- is from the sentence start at or before the offset to the sentence
1130
- start after the offset.
1131
- </p>
1132
- <p>
1133
- The returned string will contain the sentence at the offset if the offset
1134
- is inside a sentence and will contain the sentence before the offset
1135
- if the offset is not inside a sentence.
1136
- </p>
1137
- <p>
1138
- If <em class="parameter"><code>granularity</code></em> is ATK_TEXT_GRANULARITY_LINE the returned string
1139
- is from the line start at or before the offset to the line
1140
- start after the offset.
1421
+ <a name="atk-text-attribute-register"></a><h3>atk_text_attribute_register ()</h3>
1422
+ <pre class="programlisting"><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a>
1423
+ atk_text_attribute_register (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
1424
+ <p>Associate <em class="parameter"><code>name</code></em>
1425
+ with a new <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
1426
+ <div class="refsect3">
1427
+ <a name="id-1.5.13.9.24.5"></a><h4>Parameters</h4>
1428
+ <div class="informaltable"><table width="100%" border="0">
1429
+ <colgroup>
1430
+ <col width="150px" class="parameters_name">
1431
+ <col class="parameters_description">
1432
+ <col width="200px" class="parameters_annotations">
1433
+ </colgroup>
1434
+ <tbody><tr>
1435
+ <td class="parameter_name"><p>name</p></td>
1436
+ <td class="parameter_description"><p>a name string</p></td>
1437
+ <td class="parameter_annotations"> </td>
1438
+ </tr></tbody>
1439
+ </table></div>
1440
+ </div>
1441
+ <div class="refsect3">
1442
+ <a name="id-1.5.13.9.24.6"></a><h4>Returns</h4>
1443
+ <p> an <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> associated with <em class="parameter"><code>name</code></em>
1141
1444
  </p>
1445
+ <p></p>
1446
+ </div>
1447
+ </div>
1448
+ <hr>
1449
+ <div class="refsect2">
1450
+ <a name="atk-text-attribute-get-name"></a><h3>atk_text_attribute_get_name ()</h3>
1451
+ <pre class="programlisting">const <span class="returnvalue">gchar</span> *
1452
+ atk_text_attribute_get_name (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> attr</code></em>);</pre>
1453
+ <p>Gets the name corresponding to the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
1454
+ <div class="refsect3">
1455
+ <a name="id-1.5.13.9.25.5"></a><h4>Parameters</h4>
1456
+ <div class="informaltable"><table width="100%" border="0">
1457
+ <colgroup>
1458
+ <col width="150px" class="parameters_name">
1459
+ <col class="parameters_description">
1460
+ <col width="200px" class="parameters_annotations">
1461
+ </colgroup>
1462
+ <tbody><tr>
1463
+ <td class="parameter_name"><p>attr</p></td>
1464
+ <td class="parameter_description"><p>The <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> whose name is required</p></td>
1465
+ <td class="parameter_annotations"> </td>
1466
+ </tr></tbody>
1467
+ </table></div>
1468
+ </div>
1469
+ <div class="refsect3">
1470
+ <a name="id-1.5.13.9.25.6"></a><h4>Returns</h4>
1471
+ <p> a string containing the name; this string should not be freed</p>
1472
+ <p></p>
1473
+ </div>
1474
+ </div>
1475
+ <hr>
1476
+ <div class="refsect2">
1477
+ <a name="atk-text-attribute-for-name"></a><h3>atk_text_attribute_for_name ()</h3>
1478
+ <pre class="programlisting"><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a>
1479
+ atk_text_attribute_for_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
1480
+ <p>Get the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> type corresponding to a text attribute name.</p>
1481
+ <div class="refsect3">
1482
+ <a name="id-1.5.13.9.26.5"></a><h4>Parameters</h4>
1483
+ <div class="informaltable"><table width="100%" border="0">
1484
+ <colgroup>
1485
+ <col width="150px" class="parameters_name">
1486
+ <col class="parameters_description">
1487
+ <col width="200px" class="parameters_annotations">
1488
+ </colgroup>
1489
+ <tbody><tr>
1490
+ <td class="parameter_name"><p>name</p></td>
1491
+ <td class="parameter_description"><p>a string which is the (non-localized) name of an ATK text attribute.</p></td>
1492
+ <td class="parameter_annotations"> </td>
1493
+ </tr></tbody>
1494
+ </table></div>
1495
+ </div>
1496
+ <div class="refsect3">
1497
+ <a name="id-1.5.13.9.26.6"></a><h4>Returns</h4>
1498
+ <p> the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> enumerated type corresponding to the specified
1499
+ name,
1500
+ or <span class="type">ATK_TEXT_ATTRIBUTE_INVALID</span> if no matching text attribute is found.</p>
1501
+ <p></p>
1502
+ </div>
1503
+ </div>
1504
+ <hr>
1505
+ <div class="refsect2">
1506
+ <a name="atk-text-attribute-get-value"></a><h3>atk_text_attribute_get_value ()</h3>
1507
+ <pre class="programlisting">const <span class="returnvalue">gchar</span> *
1508
+ atk_text_attribute_get_value (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> attr</code></em>,
1509
+ <em class="parameter"><code><span class="type">gint</span> index_</code></em>);</pre>
1510
+ <p>Gets the value for the index of the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a></p>
1511
+ <div class="refsect3">
1512
+ <a name="id-1.5.13.9.27.5"></a><h4>Parameters</h4>
1513
+ <div class="informaltable"><table width="100%" border="0">
1514
+ <colgroup>
1515
+ <col width="150px" class="parameters_name">
1516
+ <col class="parameters_description">
1517
+ <col width="200px" class="parameters_annotations">
1518
+ </colgroup>
1519
+ <tbody>
1520
+ <tr>
1521
+ <td class="parameter_name"><p>attr</p></td>
1522
+ <td class="parameter_description"><p>The <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> for which a value is required</p></td>
1523
+ <td class="parameter_annotations"> </td>
1524
+ </tr>
1525
+ <tr>
1526
+ <td class="parameter_name"><p>index_</p></td>
1527
+ <td class="parameter_description"><p>The index of the required value</p></td>
1528
+ <td class="parameter_annotations"> </td>
1529
+ </tr>
1530
+ </tbody>
1531
+ </table></div>
1532
+ </div>
1533
+ <div class="refsect3">
1534
+ <a name="id-1.5.13.9.27.6"></a><h4>Returns</h4>
1535
+ <p> a string containing the value; this string
1536
+ should not be freed; <code class="literal">NULL</code> is returned if there are no values
1537
+ maintained for the attr value. </p>
1538
+ <p><span class="annotation">[<a href="http://foldoc.org/nullable"><span class="acronym">nullable</span></a>]</span></p>
1539
+ </div>
1540
+ </div>
1541
+ </div>
1542
+ <div class="refsect1">
1543
+ <a name="AtkText.other_details"></a><h2>Types and Values</h2>
1544
+ <div class="refsect2">
1545
+ <a name="AtkText-struct"></a><h3>AtkText</h3>
1546
+ <pre class="programlisting">typedef struct _AtkText AtkText;</pre>
1142
1547
  <p>
1143
- If <em class="parameter"><code>granularity</code></em> is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string
1144
- is from the start of the paragraph at or before the offset to the start
1145
- of the following paragraph after the offset.
1146
1548
  </p>
1147
- <div class="variablelist"><table border="0">
1148
- <col align="left" valign="top">
1549
+ </div>
1550
+ <hr>
1551
+ <div class="refsect2">
1552
+ <a name="AtkTextIface"></a><h3>struct AtkTextIface</h3>
1553
+ <pre class="programlisting">struct AtkTextIface {
1554
+ GTypeInterface parent;
1555
+
1556
+ gchar* (* get_text) (AtkText *text,
1557
+ gint start_offset,
1558
+ gint end_offset);
1559
+ gchar* (* get_text_after_offset) (AtkText *text,
1560
+ gint offset,
1561
+ AtkTextBoundary boundary_type,
1562
+ gint *start_offset,
1563
+ gint *end_offset);
1564
+ gchar* (* get_text_at_offset) (AtkText *text,
1565
+ gint offset,
1566
+ AtkTextBoundary boundary_type,
1567
+ gint *start_offset,
1568
+ gint *end_offset);
1569
+ gunichar (* get_character_at_offset) (AtkText *text,
1570
+ gint offset);
1571
+ gchar* (* get_text_before_offset) (AtkText *text,
1572
+ gint offset,
1573
+ AtkTextBoundary boundary_type,
1574
+ gint *start_offset,
1575
+ gint *end_offset);
1576
+ gint (* get_caret_offset) (AtkText *text);
1577
+ AtkAttributeSet* (* get_run_attributes) (AtkText *text,
1578
+ gint offset,
1579
+ gint *start_offset,
1580
+ gint *end_offset);
1581
+ AtkAttributeSet* (* get_default_attributes) (AtkText *text);
1582
+ void (* get_character_extents) (AtkText *text,
1583
+ gint offset,
1584
+ gint *x,
1585
+ gint *y,
1586
+ gint *width,
1587
+ gint *height,
1588
+ AtkCoordType coords);
1589
+ gint (* get_character_count) (AtkText *text);
1590
+ gint (* get_offset_at_point) (AtkText *text,
1591
+ gint x,
1592
+ gint y,
1593
+ AtkCoordType coords);
1594
+ gint (* get_n_selections) (AtkText *text);
1595
+ gchar* (* get_selection) (AtkText *text,
1596
+ gint selection_num,
1597
+ gint *start_offset,
1598
+ gint *end_offset);
1599
+ gboolean (* add_selection) (AtkText *text,
1600
+ gint start_offset,
1601
+ gint end_offset);
1602
+ gboolean (* remove_selection) (AtkText *text,
1603
+ gint selection_num);
1604
+ gboolean (* set_selection) (AtkText *text,
1605
+ gint selection_num,
1606
+ gint start_offset,
1607
+ gint end_offset);
1608
+ gboolean (* set_caret_offset) (AtkText *text,
1609
+ gint offset);
1610
+
1611
+ /*
1612
+ * signal handlers
1613
+ */
1614
+ void (* text_changed) (AtkText *text,
1615
+ gint position,
1616
+ gint length);
1617
+ void (* text_caret_moved) (AtkText *text,
1618
+ gint location);
1619
+ void (* text_selection_changed) (AtkText *text);
1620
+
1621
+ void (* text_attributes_changed) (AtkText *text);
1622
+
1623
+
1624
+ void (* get_range_extents) (AtkText *text,
1625
+ gint start_offset,
1626
+ gint end_offset,
1627
+ AtkCoordType coord_type,
1628
+ AtkTextRectangle *rect);
1629
+
1630
+ AtkTextRange** (* get_bounded_ranges) (AtkText *text,
1631
+ AtkTextRectangle *rect,
1632
+ AtkCoordType coord_type,
1633
+ AtkTextClipType x_clip_type,
1634
+ AtkTextClipType y_clip_type);
1635
+
1636
+ gchar* (* get_string_at_offset) (AtkText *text,
1637
+ gint offset,
1638
+ AtkTextGranularity granularity,
1639
+ gint *start_offset,
1640
+ gint *end_offset);
1641
+ };
1642
+ </pre>
1643
+ <div class="refsect3">
1644
+ <a name="id-1.5.13.10.3.4"></a><h4>Members</h4>
1645
+ <div class="informaltable"><table width="100%" border="0">
1646
+ <colgroup>
1647
+ <col width="300px" class="struct_members_name">
1648
+ <col class="struct_members_description">
1649
+ <col width="200px" class="struct_members_annotations">
1650
+ </colgroup>
1149
1651
  <tbody>
1150
1652
  <tr>
1151
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1152
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1153
- </td>
1653
+ <td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="AtkTextIface.parent"></a>parent</code></em>;</p></td>
1654
+ <td class="struct_member_description"> </td>
1655
+ <td class="struct_member_annotations"> </td>
1656
+ </tr>
1657
+ <tr>
1658
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-text"></a>get_text</code></em> ()</p></td>
1659
+ <td class="struct_member_description"> </td>
1660
+ <td class="struct_member_annotations"> </td>
1661
+ </tr>
1662
+ <tr>
1663
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-text-after-offset"></a>get_text_after_offset</code></em> ()</p></td>
1664
+ <td class="struct_member_description"><p>Gets specified text. This virtual function
1665
+ is deprecated and it should not be overridden.</p></td>
1666
+ <td class="struct_member_annotations"> </td>
1667
+ </tr>
1668
+ <tr>
1669
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-text-at-offset"></a>get_text_at_offset</code></em> ()</p></td>
1670
+ <td class="struct_member_description"><p>Gets specified text. This virtual function
1671
+ is deprecated and it should not be overridden.</p></td>
1672
+ <td class="struct_member_annotations"> </td>
1673
+ </tr>
1674
+ <tr>
1675
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-character-at-offset"></a>get_character_at_offset</code></em> ()</p></td>
1676
+ <td class="struct_member_description"> </td>
1677
+ <td class="struct_member_annotations"> </td>
1678
+ </tr>
1679
+ <tr>
1680
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-text-before-offset"></a>get_text_before_offset</code></em> ()</p></td>
1681
+ <td class="struct_member_description"><p>Gets specified text. This virtual function
1682
+ is deprecated and it should not be overridden.</p></td>
1683
+ <td class="struct_member_annotations"> </td>
1684
+ </tr>
1685
+ <tr>
1686
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-caret-offset"></a>get_caret_offset</code></em> ()</p></td>
1687
+ <td class="struct_member_description"> </td>
1688
+ <td class="struct_member_annotations"> </td>
1689
+ </tr>
1690
+ <tr>
1691
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-run-attributes"></a>get_run_attributes</code></em> ()</p></td>
1692
+ <td class="struct_member_description"> </td>
1693
+ <td class="struct_member_annotations"> </td>
1154
1694
  </tr>
1155
1695
  <tr>
1156
- <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
1157
- <td>position</td>
1696
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-default-attributes"></a>get_default_attributes</code></em> ()</p></td>
1697
+ <td class="struct_member_description"> </td>
1698
+ <td class="struct_member_annotations"> </td>
1158
1699
  </tr>
1159
1700
  <tr>
1160
- <td><p><span class="term"><em class="parameter"><code>granularity</code></em> :</span></p></td>
1161
- <td>An <a class="link" href="AtkText.html#AtkTextGranularity" title="enum AtkTextGranularity"><span class="type">AtkTextGranularity</span></a>
1162
- </td>
1701
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-character-extents"></a>get_character_extents</code></em> ()</p></td>
1702
+ <td class="struct_member_description"> </td>
1703
+ <td class="struct_member_annotations"> </td>
1163
1704
  </tr>
1164
1705
  <tr>
1165
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1166
- <td>the start offset of the returned string, or -1
1167
- if an error has occurred (e.g. invalid offset, not implemented). <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
1168
- </td>
1706
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-character-count"></a>get_character_count</code></em> ()</p></td>
1707
+ <td class="struct_member_description"> </td>
1708
+ <td class="struct_member_annotations"> </td>
1169
1709
  </tr>
1170
1710
  <tr>
1171
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1172
- <td>the offset of the first character after the returned string,
1173
- or -1 if an error has occurred (e.g. invalid offset, not implemented). <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
1174
- </td>
1711
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-offset-at-point"></a>get_offset_at_point</code></em> ()</p></td>
1712
+ <td class="struct_member_description"> </td>
1713
+ <td class="struct_member_annotations"> </td>
1175
1714
  </tr>
1176
1715
  <tr>
1177
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1178
- <td>a newly allocated string containing the text at the <em class="parameter"><code>offset</code></em> bounded
1179
- by the specified <em class="parameter"><code>granularity</code></em>. Use <code class="function">g_free()</code> to free the returned string.
1180
- Returns <code class="literal">NULL</code> if the offset is invalid or no implementation is available.</td>
1716
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-n-selections"></a>get_n_selections</code></em> ()</p></td>
1717
+ <td class="struct_member_description"> </td>
1718
+ <td class="struct_member_annotations"> </td>
1181
1719
  </tr>
1182
- </tbody>
1183
- </table></div>
1184
- <p class="since">Since 2.9.4</p>
1185
- </div>
1186
- <hr>
1187
- <div class="refsect2">
1188
- <a name="atk-text-get-caret-offset"></a><h3>atk_text_get_caret_offset ()</h3>
1189
- <pre class="programlisting"><span class="returnvalue">gint</span> atk_text_get_caret_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
1190
- <p>
1191
- Gets the offset position of the caret (cursor).
1192
- </p>
1193
- <div class="variablelist"><table border="0">
1194
- <col align="left" valign="top">
1195
- <tbody>
1196
1720
  <tr>
1197
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1198
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1199
- </td>
1721
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-selection"></a>get_selection</code></em> ()</p></td>
1722
+ <td class="struct_member_description"> </td>
1723
+ <td class="struct_member_annotations"> </td>
1200
1724
  </tr>
1201
1725
  <tr>
1202
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1203
- <td>the offset position of the caret (cursor).</td>
1726
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.add-selection"></a>add_selection</code></em> ()</p></td>
1727
+ <td class="struct_member_description"> </td>
1728
+ <td class="struct_member_annotations"> </td>
1204
1729
  </tr>
1205
- </tbody>
1206
- </table></div>
1207
- </div>
1208
- <hr>
1209
- <div class="refsect2">
1210
- <a name="atk-text-get-character-extents"></a><h3>atk_text_get_character_extents ()</h3>
1211
- <pre class="programlisting"><span class="returnvalue">void</span> atk_text_get_character_extents (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1212
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
1213
- <em class="parameter"><code><span class="type">gint</span> *x</code></em>,
1214
- <em class="parameter"><code><span class="type">gint</span> *y</code></em>,
1215
- <em class="parameter"><code><span class="type">gint</span> *width</code></em>,
1216
- <em class="parameter"><code><span class="type">gint</span> *height</code></em>,
1217
- <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coords</code></em>);</pre>
1218
- <p>
1219
- Get the bounding box containing the glyph representing the character at
1220
- a particular text offset.
1221
- </p>
1222
- <div class="variablelist"><table border="0">
1223
- <col align="left" valign="top">
1224
- <tbody>
1225
1730
  <tr>
1226
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1227
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1228
- </td>
1731
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.remove-selection"></a>remove_selection</code></em> ()</p></td>
1732
+ <td class="struct_member_description"> </td>
1733
+ <td class="struct_member_annotations"> </td>
1734
+ </tr>
1735
+ <tr>
1736
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.set-selection"></a>set_selection</code></em> ()</p></td>
1737
+ <td class="struct_member_description"> </td>
1738
+ <td class="struct_member_annotations"> </td>
1229
1739
  </tr>
1230
1740
  <tr>
1231
- <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
1232
- <td>The offset of the text character for which bounding information is required.</td>
1741
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.set-caret-offset"></a>set_caret_offset</code></em> ()</p></td>
1742
+ <td class="struct_member_description"> </td>
1743
+ <td class="struct_member_annotations"> </td>
1233
1744
  </tr>
1234
1745
  <tr>
1235
- <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
1236
- <td>Pointer for the x cordinate of the bounding box</td>
1746
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.text-changed"></a>text_changed</code></em> ()</p></td>
1747
+ <td class="struct_member_description"><p>the signal handler which is executed when there is a
1748
+ text change. This virtual function is deprecated sice 2.9.4 and
1749
+ it should not be overriden.</p></td>
1750
+ <td class="struct_member_annotations"> </td>
1751
+ </tr>
1752
+ <tr>
1753
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.text-caret-moved"></a>text_caret_moved</code></em> ()</p></td>
1754
+ <td class="struct_member_description"> </td>
1755
+ <td class="struct_member_annotations"> </td>
1756
+ </tr>
1757
+ <tr>
1758
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.text-selection-changed"></a>text_selection_changed</code></em> ()</p></td>
1759
+ <td class="struct_member_description"> </td>
1760
+ <td class="struct_member_annotations"> </td>
1237
1761
  </tr>
1238
1762
  <tr>
1239
- <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
1240
- <td>Pointer for the y cordinate of the bounding box</td>
1763
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.text-attributes-changed"></a>text_attributes_changed</code></em> ()</p></td>
1764
+ <td class="struct_member_description"> </td>
1765
+ <td class="struct_member_annotations"> </td>
1241
1766
  </tr>
1242
1767
  <tr>
1243
- <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1244
- <td>Pointer for the width of the bounding box</td>
1768
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-range-extents"></a>get_range_extents</code></em> ()</p></td>
1769
+ <td class="struct_member_description"> </td>
1770
+ <td class="struct_member_annotations"> </td>
1245
1771
  </tr>
1246
1772
  <tr>
1247
- <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1248
- <td>Pointer for the height of the bounding box</td>
1773
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-bounded-ranges"></a>get_bounded_ranges</code></em> ()</p></td>
1774
+ <td class="struct_member_description"> </td>
1775
+ <td class="struct_member_annotations"> </td>
1249
1776
  </tr>
1250
1777
  <tr>
1251
- <td><p><span class="term"><em class="parameter"><code>coords</code></em> :</span></p></td>
1252
- <td>specify whether coordinates are relative to the screen or widget window</td>
1778
+ <td class="struct_member_name"><p><em class="structfield"><code><a name="AtkTextIface.get-string-at-offset"></a>get_string_at_offset</code></em> ()</p></td>
1779
+ <td class="struct_member_description"><p>Gets a portion of the text exposed through
1780
+ an AtkText according to a given offset and a specific
1781
+ granularity, along with the start and end offsets defining the
1782
+ boundaries of such a portion of text.</p></td>
1783
+ <td class="struct_member_annotations"> </td>
1253
1784
  </tr>
1254
1785
  </tbody>
1255
1786
  </table></div>
1256
1787
  </div>
1788
+ </div>
1257
1789
  <hr>
1258
1790
  <div class="refsect2">
1259
- <a name="atk-text-get-run-attributes"></a><h3>atk_text_get_run_attributes ()</h3>
1260
- <pre class="programlisting"><a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> * atk_text_get_run_attributes (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1261
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
1262
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
1263
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
1264
- <p>
1265
- Creates an <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which consists of the attributes explicitly
1266
- set at the position <em class="parameter"><code>offset</code></em> in the text. <em class="parameter"><code>start_offset</code></em> and <em class="parameter"><code>end_offset</code></em> are
1267
- set to the start and end of the range around <em class="parameter"><code>offset</code></em> where the attributes are
1268
- invariant. Note that <em class="parameter"><code>end_offset</code></em> is the offset of the first character
1269
- after the range. See the enum AtkTextAttribute for types of text
1270
- attributes that can be returned. Note that other attributes may also be
1271
- returned.
1272
- </p>
1273
- <div class="variablelist"><table border="0">
1274
- <col align="left" valign="top">
1791
+ <a name="AtkTextBoundary"></a><h3>enum AtkTextBoundary</h3>
1792
+ <p>Text boundary types used for specifying boundaries for regions of text.
1793
+ This enumerationis deprecated since 2.9.4 and should not be used. Use
1794
+ AtkTextGranularity with <a class="link" href="AtkText.html#atk-text-get-string-at-offset" title="atk_text_get_string_at_offset ()"><span class="type">atk_text_get_string_at_offset</span></a> instead.</p>
1795
+ <div class="refsect3">
1796
+ <a name="id-1.5.13.10.4.4"></a><h4>Members</h4>
1797
+ <div class="informaltable"><table width="100%" border="0">
1798
+ <colgroup>
1799
+ <col width="300px" class="enum_members_name">
1800
+ <col class="enum_members_description">
1801
+ <col width="200px" class="enum_members_annotations">
1802
+ </colgroup>
1275
1803
  <tbody>
1276
1804
  <tr>
1277
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1278
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1805
+ <td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-CHAR:CAPS"></a>ATK_TEXT_BOUNDARY_CHAR</p></td>
1806
+ <td class="enum_member_description">
1807
+ <p>Boundary is the boundary between characters
1808
+ (including non-printing characters)</p>
1279
1809
  </td>
1810
+ <td class="enum_member_annotations"> </td>
1280
1811
  </tr>
1281
1812
  <tr>
1282
- <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
1283
- <td>the offset at which to get the attributes, -1 means the offset of
1284
- the character to be inserted at the caret location.</td>
1285
- </tr>
1286
- <tr>
1287
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1288
- <td>the address to put the start offset of the range. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
1813
+ <td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-WORD-START:CAPS"></a>ATK_TEXT_BOUNDARY_WORD_START</p></td>
1814
+ <td class="enum_member_description">
1815
+ <p>Boundary is the start (i.e. first character) of a word.</p>
1289
1816
  </td>
1817
+ <td class="enum_member_annotations"> </td>
1290
1818
  </tr>
1291
1819
  <tr>
1292
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1293
- <td>the address to put the end offset of the range. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
1820
+ <td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-WORD-END:CAPS"></a>ATK_TEXT_BOUNDARY_WORD_END</p></td>
1821
+ <td class="enum_member_description">
1822
+ <p>Boundary is the end (i.e. last
1823
+ character) of a word.</p>
1294
1824
  </td>
1825
+ <td class="enum_member_annotations"> </td>
1295
1826
  </tr>
1296
1827
  <tr>
1297
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1298
- <td>an <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which contains the attributes
1299
- explicitly set at <em class="parameter"><code>offset</code></em>. This <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> should be freed by a call
1300
- to <a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()"><code class="function">atk_attribute_set_free()</code></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
1828
+ <td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-SENTENCE-START:CAPS"></a>ATK_TEXT_BOUNDARY_SENTENCE_START</p></td>
1829
+ <td class="enum_member_description">
1830
+ <p>Boundary is the first character in a sentence.</p>
1301
1831
  </td>
1832
+ <td class="enum_member_annotations"> </td>
1302
1833
  </tr>
1303
- </tbody>
1304
- </table></div>
1305
- </div>
1306
- <hr>
1307
- <div class="refsect2">
1308
- <a name="atk-text-get-default-attributes"></a><h3>atk_text_get_default_attributes ()</h3>
1309
- <pre class="programlisting"><a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="returnvalue">AtkAttributeSet</span></a> * atk_text_get_default_attributes (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
1310
- <p>
1311
- Creates an <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which consists of the default values of
1312
- attributes for the text. See the enum AtkTextAttribute for types of text
1313
- attributes that can be returned. Note that other attributes may also be
1314
- returned.
1315
- </p>
1316
- <div class="variablelist"><table border="0">
1317
- <col align="left" valign="top">
1318
- <tbody>
1319
1834
  <tr>
1320
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1321
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1835
+ <td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-SENTENCE-END:CAPS"></a>ATK_TEXT_BOUNDARY_SENTENCE_END</p></td>
1836
+ <td class="enum_member_description">
1837
+ <p>Boundary is the last (terminal)
1838
+ character in a sentence; in languages which use "sentence stop"
1839
+ punctuation such as English, the boundary is thus the '.', '?', or
1840
+ similar terminal punctuation character.</p>
1322
1841
  </td>
1842
+ <td class="enum_member_annotations"> </td>
1323
1843
  </tr>
1324
1844
  <tr>
1325
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1326
- <td>an <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> which contains the default
1327
- values of attributes. at <em class="parameter"><code>offset</code></em>. this <span class="type">atkattributeset</span> should be freed by
1328
- a call to <a class="link" href="AtkText.html#atk-attribute-set-free" title="atk_attribute_set_free ()"><code class="function">atk_attribute_set_free()</code></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
1845
+ <td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-LINE-START:CAPS"></a>ATK_TEXT_BOUNDARY_LINE_START</p></td>
1846
+ <td class="enum_member_description">
1847
+ <p>Boundary is the initial character of the content or a
1848
+ character immediately following a newline, linefeed, or return character.</p>
1329
1849
  </td>
1850
+ <td class="enum_member_annotations"> </td>
1330
1851
  </tr>
1331
- </tbody>
1332
- </table></div>
1333
- </div>
1334
- <hr>
1335
- <div class="refsect2">
1336
- <a name="atk-text-get-character-count"></a><h3>atk_text_get_character_count ()</h3>
1337
- <pre class="programlisting"><span class="returnvalue">gint</span> atk_text_get_character_count (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
1338
- <p>
1339
- Gets the character count.
1340
- </p>
1341
- <div class="variablelist"><table border="0">
1342
- <col align="left" valign="top">
1343
- <tbody>
1344
1852
  <tr>
1345
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1346
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1853
+ <td class="enum_member_name"><p><a name="ATK-TEXT-BOUNDARY-LINE-END:CAPS"></a>ATK_TEXT_BOUNDARY_LINE_END</p></td>
1854
+ <td class="enum_member_description">
1855
+ <p>Boundary is the linefeed, or return
1856
+ character.</p>
1347
1857
  </td>
1348
- </tr>
1349
- <tr>
1350
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1351
- <td>the number of characters.</td>
1858
+ <td class="enum_member_annotations"> </td>
1352
1859
  </tr>
1353
1860
  </tbody>
1354
1861
  </table></div>
1355
1862
  </div>
1863
+ </div>
1356
1864
  <hr>
1357
1865
  <div class="refsect2">
1358
- <a name="atk-text-get-offset-at-point"></a><h3>atk_text_get_offset_at_point ()</h3>
1359
- <pre class="programlisting"><span class="returnvalue">gint</span> atk_text_get_offset_at_point (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1360
- <em class="parameter"><code><span class="type">gint</span> x</code></em>,
1361
- <em class="parameter"><code><span class="type">gint</span> y</code></em>,
1362
- <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coords</code></em>);</pre>
1363
- <p>
1364
- Gets the offset of the character located at coordinates <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>. <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>
1365
- are interpreted as being relative to the screen or this widget's window
1366
- depending on <em class="parameter"><code>coords</code></em>.
1367
- </p>
1368
- <div class="variablelist"><table border="0">
1369
- <col align="left" valign="top">
1866
+ <a name="AtkTextGranularity"></a><h3>enum AtkTextGranularity</h3>
1867
+ <p>Text granularity types used for specifying the granularity of the region of
1868
+ text we are interested in.</p>
1869
+ <div class="refsect3">
1870
+ <a name="id-1.5.13.10.5.4"></a><h4>Members</h4>
1871
+ <div class="informaltable"><table width="100%" border="0">
1872
+ <colgroup>
1873
+ <col width="300px" class="enum_members_name">
1874
+ <col class="enum_members_description">
1875
+ <col width="200px" class="enum_members_annotations">
1876
+ </colgroup>
1370
1877
  <tbody>
1371
1878
  <tr>
1372
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1373
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1879
+ <td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-CHAR:CAPS"></a>ATK_TEXT_GRANULARITY_CHAR</p></td>
1880
+ <td class="enum_member_description">
1881
+ <p>Granularity is defined by the boundaries between characters
1882
+ (including non-printing characters)</p>
1374
1883
  </td>
1884
+ <td class="enum_member_annotations"> </td>
1375
1885
  </tr>
1376
1886
  <tr>
1377
- <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
1378
- <td>screen x-position of character</td>
1887
+ <td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-WORD:CAPS"></a>ATK_TEXT_GRANULARITY_WORD</p></td>
1888
+ <td class="enum_member_description">
1889
+ <p>Granularity is defined by the boundaries of a word,
1890
+ starting at the beginning of the current word and finishing at the beginning of
1891
+ the following one, if present.</p>
1892
+ </td>
1893
+ <td class="enum_member_annotations"> </td>
1379
1894
  </tr>
1380
1895
  <tr>
1381
- <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
1382
- <td>screen y-position of character</td>
1896
+ <td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-SENTENCE:CAPS"></a>ATK_TEXT_GRANULARITY_SENTENCE</p></td>
1897
+ <td class="enum_member_description">
1898
+ <p>Granularity is defined by the boundaries of a sentence,
1899
+ starting at the beginning of the current sentence and finishing at the beginning of
1900
+ the following one, if present.</p>
1901
+ </td>
1902
+ <td class="enum_member_annotations"> </td>
1383
1903
  </tr>
1384
1904
  <tr>
1385
- <td><p><span class="term"><em class="parameter"><code>coords</code></em> :</span></p></td>
1386
- <td>specify whether coordinates are relative to the screen or
1387
- widget window</td>
1905
+ <td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-LINE:CAPS"></a>ATK_TEXT_GRANULARITY_LINE</p></td>
1906
+ <td class="enum_member_description">
1907
+ <p>Granularity is defined by the boundaries of a line,
1908
+ starting at the beginning of the current line and finishing at the beginning of
1909
+ the following one, if present.</p>
1910
+ </td>
1911
+ <td class="enum_member_annotations"> </td>
1388
1912
  </tr>
1389
1913
  <tr>
1390
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1391
- <td>the offset to the character which is located at
1392
- the specified <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em> coordinates.</td>
1914
+ <td class="enum_member_name"><p><a name="ATK-TEXT-GRANULARITY-PARAGRAPH:CAPS"></a>ATK_TEXT_GRANULARITY_PARAGRAPH</p></td>
1915
+ <td class="enum_member_description">
1916
+ <p>Granularity is defined by the boundaries of a paragraph,
1917
+ starting at the beginning of the current paragraph and finishing at the beginning of
1918
+ the following one, if present.</p>
1919
+ </td>
1920
+ <td class="enum_member_annotations"> </td>
1393
1921
  </tr>
1394
1922
  </tbody>
1395
1923
  </table></div>
1396
1924
  </div>
1925
+ </div>
1397
1926
  <hr>
1398
1927
  <div class="refsect2">
1399
- <a name="atk-text-get-bounded-ranges"></a><h3>atk_text_get_bounded_ranges ()</h3>
1400
- <pre class="programlisting"><a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="returnvalue">AtkTextRange</span></a> ** atk_text_get_bounded_ranges (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1401
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> *rect</code></em>,
1402
- <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coord_type</code></em>,
1403
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType"><span class="type">AtkTextClipType</span></a> x_clip_type</code></em>,
1404
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextClipType" title="enum AtkTextClipType"><span class="type">AtkTextClipType</span></a> y_clip_type</code></em>);</pre>
1405
- <p>
1406
- Get the ranges of text in the specified bounding box.
1407
- </p>
1408
- <div class="variablelist"><table border="0">
1409
- <col align="left" valign="top">
1928
+ <a name="AtkTextClipType"></a><h3>enum AtkTextClipType</h3>
1929
+ <p>Describes the type of clipping required.</p>
1930
+ <div class="refsect3">
1931
+ <a name="id-1.5.13.10.6.4"></a><h4>Members</h4>
1932
+ <div class="informaltable"><table width="100%" border="0">
1933
+ <colgroup>
1934
+ <col width="300px" class="enum_members_name">
1935
+ <col class="enum_members_description">
1936
+ <col width="200px" class="enum_members_annotations">
1937
+ </colgroup>
1410
1938
  <tbody>
1411
1939
  <tr>
1412
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1413
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1940
+ <td class="enum_member_name"><p><a name="ATK-TEXT-CLIP-NONE:CAPS"></a>ATK_TEXT_CLIP_NONE</p></td>
1941
+ <td class="enum_member_description">
1942
+ <p>No clipping to be done</p>
1414
1943
  </td>
1944
+ <td class="enum_member_annotations"> </td>
1415
1945
  </tr>
1416
1946
  <tr>
1417
- <td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
1418
- <td>An AtkTextRectangle giving the dimensions of the bounding box.</td>
1419
- </tr>
1420
- <tr>
1421
- <td><p><span class="term"><em class="parameter"><code>coord_type</code></em> :</span></p></td>
1422
- <td>Specify whether coordinates are relative to the screen or widget window.</td>
1423
- </tr>
1424
- <tr>
1425
- <td><p><span class="term"><em class="parameter"><code>x_clip_type</code></em> :</span></p></td>
1426
- <td>Specify the horizontal clip type.</td>
1947
+ <td class="enum_member_name"><p><a name="ATK-TEXT-CLIP-MIN:CAPS"></a>ATK_TEXT_CLIP_MIN</p></td>
1948
+ <td class="enum_member_description">
1949
+ <p>Text clipped by min coordinate is omitted</p>
1950
+ </td>
1951
+ <td class="enum_member_annotations"> </td>
1427
1952
  </tr>
1428
1953
  <tr>
1429
- <td><p><span class="term"><em class="parameter"><code>y_clip_type</code></em> :</span></p></td>
1430
- <td>Specify the vertical clip type.</td>
1954
+ <td class="enum_member_name"><p><a name="ATK-TEXT-CLIP-MAX:CAPS"></a>ATK_TEXT_CLIP_MAX</p></td>
1955
+ <td class="enum_member_description">
1956
+ <p>Text clipped by max coordinate is omitted</p>
1957
+ </td>
1958
+ <td class="enum_member_annotations"> </td>
1431
1959
  </tr>
1432
1960
  <tr>
1433
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1434
- <td>Array of AtkTextRange. The last
1435
- element of the array returned by this function will be NULL.
1436
- Virtual: get_bounded_ranges. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span>
1961
+ <td class="enum_member_name"><p><a name="ATK-TEXT-CLIP-BOTH:CAPS"></a>ATK_TEXT_CLIP_BOTH</p></td>
1962
+ <td class="enum_member_description">
1963
+ <p>Only text fully within mix/max bound is retained</p>
1437
1964
  </td>
1965
+ <td class="enum_member_annotations"> </td>
1438
1966
  </tr>
1439
1967
  </tbody>
1440
1968
  </table></div>
1441
- <p class="since">Since 1.3</p>
1969
+ </div>
1442
1970
  </div>
1443
1971
  <hr>
1444
1972
  <div class="refsect2">
1445
- <a name="atk-text-get-range-extents"></a><h3>atk_text_get_range_extents ()</h3>
1446
- <pre class="programlisting"><span class="returnvalue">void</span> atk_text_get_range_extents (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1447
- <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
1448
- <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>,
1449
- <em class="parameter"><code><a class="link" href="AtkUtil.html#AtkCoordType" title="enum AtkCoordType"><span class="type">AtkCoordType</span></a> coord_type</code></em>,
1450
- <em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> *rect</code></em>);</pre>
1451
- <p>
1452
- Get the bounding box for text within the specified range.
1453
- </p>
1454
- <div class="variablelist"><table border="0">
1455
- <col align="left" valign="top">
1973
+ <a name="AtkTextRange"></a><h3>struct AtkTextRange</h3>
1974
+ <pre class="programlisting">struct AtkTextRange {
1975
+ AtkTextRectangle bounds;
1976
+ gint start_offset;
1977
+ gint end_offset;
1978
+ gchar* content;
1979
+ };
1980
+ </pre>
1981
+ <p>A structure used to describe a text range.</p>
1982
+ <div class="refsect3">
1983
+ <a name="id-1.5.13.10.7.5"></a><h4>Members</h4>
1984
+ <div class="informaltable"><table width="100%" border="0">
1985
+ <colgroup>
1986
+ <col width="300px" class="struct_members_name">
1987
+ <col class="struct_members_description">
1988
+ <col width="200px" class="struct_members_annotations">
1989
+ </colgroup>
1456
1990
  <tbody>
1457
1991
  <tr>
1458
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1459
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1460
- </td>
1461
- </tr>
1462
- <tr>
1463
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1464
- <td>The offset of the first text character for which boundary
1465
- information is required.</td>
1992
+ <td class="struct_member_name"><p><a class="link" href="AtkText.html#AtkTextRectangle" title="struct AtkTextRectangle"><span class="type">AtkTextRectangle</span></a> <em class="structfield"><code><a name="AtkTextRange.bounds"></a>bounds</code></em>;</p></td>
1993
+ <td class="struct_member_description"><p>A rectangle giving the bounds of the text range</p></td>
1994
+ <td class="struct_member_annotations"> </td>
1466
1995
  </tr>
1467
1996
  <tr>
1468
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1469
- <td>The offset of the text character after the last character
1470
- for which boundary information is required.</td>
1997
+ <td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRange.start-offset"></a>start_offset</code></em>;</p></td>
1998
+ <td class="struct_member_description"><p>The start offset of a AtkTextRange</p></td>
1999
+ <td class="struct_member_annotations"> </td>
1471
2000
  </tr>
1472
2001
  <tr>
1473
- <td><p><span class="term"><em class="parameter"><code>coord_type</code></em> :</span></p></td>
1474
- <td>Specify whether coordinates are relative to the screen or widget window.</td>
2002
+ <td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRange.end-offset"></a>end_offset</code></em>;</p></td>
2003
+ <td class="struct_member_description"><p>The end offset of a AtkTextRange</p></td>
2004
+ <td class="struct_member_annotations"> </td>
1475
2005
  </tr>
1476
2006
  <tr>
1477
- <td><p><span class="term"><em class="parameter"><code>rect</code></em> :</span></p></td>
1478
- <td>A pointer to a AtkTextRectangle which is filled in by this function.</td>
2007
+ <td class="struct_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="AtkTextRange.content"></a>content</code></em>;</p></td>
2008
+ <td class="struct_member_description"><p>The text in the text range</p></td>
2009
+ <td class="struct_member_annotations"> </td>
1479
2010
  </tr>
1480
2011
  </tbody>
1481
2012
  </table></div>
1482
- <p class="since">Since 1.3</p>
1483
2013
  </div>
1484
- <hr>
1485
- <div class="refsect2">
1486
- <a name="atk-text-free-ranges"></a><h3>atk_text_free_ranges ()</h3>
1487
- <pre class="programlisting"><span class="returnvalue">void</span> atk_text_free_ranges (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="type">AtkTextRange</span></a> **ranges</code></em>);</pre>
1488
- <p>
1489
- Frees the memory associated with an array of AtkTextRange. It is assumed
1490
- that the array was returned by the function atk_text_get_bounded_ranges
1491
- and is NULL terminated.
1492
- </p>
1493
- <div class="variablelist"><table border="0">
1494
- <col align="left" valign="top">
1495
- <tbody><tr>
1496
- <td><p><span class="term"><em class="parameter"><code>ranges</code></em> :</span></p></td>
1497
- <td>A pointer to an array of <a class="link" href="AtkText.html#AtkTextRange" title="struct AtkTextRange"><span class="type">AtkTextRange</span></a> which is
1498
- to be freed. <span class="annotation">[<a href="http://foldoc.org/array"><span class="acronym">array</span></a>]</span>
1499
- </td>
1500
- </tr></tbody>
1501
- </table></div>
1502
- <p class="since">Since 1.3</p>
1503
2014
  </div>
1504
2015
  <hr>
1505
2016
  <div class="refsect2">
1506
- <a name="atk-text-get-n-selections"></a><h3>atk_text_get_n_selections ()</h3>
1507
- <pre class="programlisting"><span class="returnvalue">gint</span> atk_text_get_n_selections (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>);</pre>
1508
- <p>
1509
- Gets the number of selected regions.
1510
- </p>
1511
- <div class="variablelist"><table border="0">
1512
- <col align="left" valign="top">
2017
+ <a name="AtkTextRectangle"></a><h3>struct AtkTextRectangle</h3>
2018
+ <pre class="programlisting">struct AtkTextRectangle {
2019
+ gint x;
2020
+ gint y;
2021
+ gint width;
2022
+ gint height;
2023
+ };
2024
+ </pre>
2025
+ <p>A structure used to store a rectangle used by AtkText.</p>
2026
+ <div class="refsect3">
2027
+ <a name="id-1.5.13.10.8.5"></a><h4>Members</h4>
2028
+ <div class="informaltable"><table width="100%" border="0">
2029
+ <colgroup>
2030
+ <col width="300px" class="struct_members_name">
2031
+ <col class="struct_members_description">
2032
+ <col width="200px" class="struct_members_annotations">
2033
+ </colgroup>
1513
2034
  <tbody>
1514
2035
  <tr>
1515
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1516
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
1517
- </td>
2036
+ <td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRectangle.x"></a>x</code></em>;</p></td>
2037
+ <td class="struct_member_description"><p>The horizontal coordinate of a rectangle</p></td>
2038
+ <td class="struct_member_annotations"> </td>
2039
+ </tr>
2040
+ <tr>
2041
+ <td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRectangle.y"></a>y</code></em>;</p></td>
2042
+ <td class="struct_member_description"><p>The vertical coordinate of a rectangle</p></td>
2043
+ <td class="struct_member_annotations"> </td>
1518
2044
  </tr>
1519
2045
  <tr>
1520
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1521
- <td>The number of selected regions, or -1 if a failure
1522
- occurred.</td>
2046
+ <td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRectangle.width"></a>width</code></em>;</p></td>
2047
+ <td class="struct_member_description"><p>The width of a rectangle</p></td>
2048
+ <td class="struct_member_annotations"> </td>
2049
+ </tr>
2050
+ <tr>
2051
+ <td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="AtkTextRectangle.height"></a>height</code></em>;</p></td>
2052
+ <td class="struct_member_description"><p>The height of a rectangle</p></td>
2053
+ <td class="struct_member_annotations"> </td>
1523
2054
  </tr>
1524
2055
  </tbody>
1525
2056
  </table></div>
1526
2057
  </div>
2058
+ </div>
1527
2059
  <hr>
1528
2060
  <div class="refsect2">
1529
- <a name="atk-text-get-selection"></a><h3>atk_text_get_selection ()</h3>
1530
- <pre class="programlisting"><span class="returnvalue">gchar</span> * atk_text_get_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1531
- <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
1532
- <em class="parameter"><code><span class="type">gint</span> *start_offset</code></em>,
1533
- <em class="parameter"><code><span class="type">gint</span> *end_offset</code></em>);</pre>
1534
- <p>
1535
- Gets the text from the specified selection.
1536
- </p>
1537
- <div class="variablelist"><table border="0">
1538
- <col align="left" valign="top">
2061
+ <a name="AtkTextAttribute"></a><h3>enum AtkTextAttribute</h3>
2062
+ <p>Describes the text attributes supported</p>
2063
+ <div class="refsect3">
2064
+ <a name="id-1.5.13.10.9.4"></a><h4>Members</h4>
2065
+ <div class="informaltable"><table width="100%" border="0">
2066
+ <colgroup>
2067
+ <col width="300px" class="enum_members_name">
2068
+ <col class="enum_members_description">
2069
+ <col width="200px" class="enum_members_annotations">
2070
+ </colgroup>
1539
2071
  <tbody>
1540
2072
  <tr>
1541
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1542
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
2073
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-INVALID:CAPS"></a>ATK_TEXT_ATTR_INVALID</p></td>
2074
+ <td class="enum_member_description">
2075
+ <p>Invalid attribute, like bad spelling or grammar.</p>
1543
2076
  </td>
2077
+ <td class="enum_member_annotations"> </td>
1544
2078
  </tr>
1545
2079
  <tr>
1546
- <td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
1547
- <td>The selection number. The selected regions are
1548
- assigned numbers that correspond to how far the region is from the
1549
- start of the text. The selected region closest to the beginning
1550
- of the text region is assigned the number 0, etc. Note that adding,
1551
- moving or deleting a selected region can change the numbering.</td>
2080
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-LEFT-MARGIN:CAPS"></a>ATK_TEXT_ATTR_LEFT_MARGIN</p></td>
2081
+ <td class="enum_member_description">
2082
+ <p>The pixel width of the left margin</p>
2083
+ </td>
2084
+ <td class="enum_member_annotations"> </td>
1552
2085
  </tr>
1553
2086
  <tr>
1554
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1555
- <td>passes back the start position of the selected region. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
2087
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-RIGHT-MARGIN:CAPS"></a>ATK_TEXT_ATTR_RIGHT_MARGIN</p></td>
2088
+ <td class="enum_member_description">
2089
+ <p>The pixel width of the right margin</p>
1556
2090
  </td>
2091
+ <td class="enum_member_annotations"> </td>
1557
2092
  </tr>
1558
2093
  <tr>
1559
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1560
- <td>passes back the end position of (e.g. offset immediately past)
1561
- the selected region. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
2094
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-INDENT:CAPS"></a>ATK_TEXT_ATTR_INDENT</p></td>
2095
+ <td class="enum_member_description">
2096
+ <p>The number of pixels that the text is indented</p>
1562
2097
  </td>
2098
+ <td class="enum_member_annotations"> </td>
1563
2099
  </tr>
1564
2100
  <tr>
1565
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1566
- <td>a newly allocated string containing the selected text. Use <code class="function">g_free()</code>
1567
- to free the returned string.</td>
2101
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-INVISIBLE:CAPS"></a>ATK_TEXT_ATTR_INVISIBLE</p></td>
2102
+ <td class="enum_member_description">
2103
+ <p>Either "true" or "false" indicating whether text is visible or not</p>
2104
+ </td>
2105
+ <td class="enum_member_annotations"> </td>
1568
2106
  </tr>
1569
- </tbody>
1570
- </table></div>
1571
- </div>
1572
- <hr>
1573
- <div class="refsect2">
1574
- <a name="atk-text-add-selection"></a><h3>atk_text_add_selection ()</h3>
1575
- <pre class="programlisting"><span class="returnvalue">gboolean</span> atk_text_add_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1576
- <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
1577
- <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);</pre>
1578
- <p>
1579
- Adds a selection bounded by the specified offsets.
1580
- </p>
1581
- <div class="variablelist"><table border="0">
1582
- <col align="left" valign="top">
1583
- <tbody>
1584
2107
  <tr>
1585
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1586
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
2108
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-EDITABLE:CAPS"></a>ATK_TEXT_ATTR_EDITABLE</p></td>
2109
+ <td class="enum_member_description">
2110
+ <p>Either "true" or "false" indicating whether text is editable or not</p>
1587
2111
  </td>
2112
+ <td class="enum_member_annotations"> </td>
1588
2113
  </tr>
1589
2114
  <tr>
1590
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1591
- <td>the start position of the selected region</td>
2115
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-PIXELS-ABOVE-LINES:CAPS"></a>ATK_TEXT_ATTR_PIXELS_ABOVE_LINES</p></td>
2116
+ <td class="enum_member_description">
2117
+ <p>Pixels of blank space to leave above each newline-terminated line. </p>
2118
+ </td>
2119
+ <td class="enum_member_annotations"> </td>
1592
2120
  </tr>
1593
2121
  <tr>
1594
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1595
- <td>the offset of the first character after the selected region.</td>
2122
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-PIXELS-BELOW-LINES:CAPS"></a>ATK_TEXT_ATTR_PIXELS_BELOW_LINES</p></td>
2123
+ <td class="enum_member_description">
2124
+ <p>Pixels of blank space to leave below each newline-terminated line.</p>
2125
+ </td>
2126
+ <td class="enum_member_annotations"> </td>
1596
2127
  </tr>
1597
2128
  <tr>
1598
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1599
- <td>
1600
- <code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise</td>
2129
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-PIXELS-INSIDE-WRAP:CAPS"></a>ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP</p></td>
2130
+ <td class="enum_member_description">
2131
+ <p>Pixels of blank space to leave between wrapped lines inside the same newline-terminated line (paragraph).</p>
2132
+ </td>
2133
+ <td class="enum_member_annotations"> </td>
1601
2134
  </tr>
1602
- </tbody>
1603
- </table></div>
1604
- </div>
1605
- <hr>
1606
- <div class="refsect2">
1607
- <a name="atk-text-remove-selection"></a><h3>atk_text_remove_selection ()</h3>
1608
- <pre class="programlisting"><span class="returnvalue">gboolean</span> atk_text_remove_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1609
- <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>);</pre>
1610
- <p>
1611
- Removes the specified selection.
1612
- </p>
1613
- <div class="variablelist"><table border="0">
1614
- <col align="left" valign="top">
1615
- <tbody>
1616
2135
  <tr>
1617
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1618
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
2136
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-BG-FULL-HEIGHT:CAPS"></a>ATK_TEXT_ATTR_BG_FULL_HEIGHT</p></td>
2137
+ <td class="enum_member_description">
2138
+ <p>"true" or "false" whether to make the background color for each character the height of the highest font used on the current line, or the height of the font used for the current character.</p>
1619
2139
  </td>
2140
+ <td class="enum_member_annotations"> </td>
1620
2141
  </tr>
1621
2142
  <tr>
1622
- <td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
1623
- <td>The selection number. The selected regions are
1624
- assigned numbers that correspond to how far the region is from the
1625
- start of the text. The selected region closest to the beginning
1626
- of the text region is assigned the number 0, etc. Note that adding,
1627
- moving or deleting a selected region can change the numbering.</td>
2143
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-RISE:CAPS"></a>ATK_TEXT_ATTR_RISE</p></td>
2144
+ <td class="enum_member_description">
2145
+ <p>Number of pixels that the characters are risen above the baseline</p>
2146
+ </td>
2147
+ <td class="enum_member_annotations"> </td>
1628
2148
  </tr>
1629
2149
  <tr>
1630
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1631
- <td>
1632
- <code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise</td>
2150
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-UNDERLINE:CAPS"></a>ATK_TEXT_ATTR_UNDERLINE</p></td>
2151
+ <td class="enum_member_description">
2152
+ <p>"none", "single", "double", "low", or "error"</p>
2153
+ </td>
2154
+ <td class="enum_member_annotations"> </td>
1633
2155
  </tr>
1634
- </tbody>
1635
- </table></div>
1636
- </div>
1637
- <hr>
1638
- <div class="refsect2">
1639
- <a name="atk-text-set-selection"></a><h3>atk_text_set_selection ()</h3>
1640
- <pre class="programlisting"><span class="returnvalue">gboolean</span> atk_text_set_selection (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1641
- <em class="parameter"><code><span class="type">gint</span> selection_num</code></em>,
1642
- <em class="parameter"><code><span class="type">gint</span> start_offset</code></em>,
1643
- <em class="parameter"><code><span class="type">gint</span> end_offset</code></em>);</pre>
1644
- <p>
1645
- Changes the start and end offset of the specified selection.
1646
- </p>
1647
- <div class="variablelist"><table border="0">
1648
- <col align="left" valign="top">
1649
- <tbody>
1650
2156
  <tr>
1651
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1652
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
2157
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-STRIKETHROUGH:CAPS"></a>ATK_TEXT_ATTR_STRIKETHROUGH</p></td>
2158
+ <td class="enum_member_description">
2159
+ <p>"true" or "false" whether the text is strikethrough </p>
1653
2160
  </td>
2161
+ <td class="enum_member_annotations"> </td>
1654
2162
  </tr>
1655
2163
  <tr>
1656
- <td><p><span class="term"><em class="parameter"><code>selection_num</code></em> :</span></p></td>
1657
- <td>The selection number. The selected regions are
1658
- assigned numbers that correspond to how far the region is from the
1659
- start of the text. The selected region closest to the beginning
1660
- of the text region is assigned the number 0, etc. Note that adding,
1661
- moving or deleting a selected region can change the numbering.</td>
2164
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-SIZE:CAPS"></a>ATK_TEXT_ATTR_SIZE</p></td>
2165
+ <td class="enum_member_description">
2166
+ <p>The size of the characters in points. eg: 10</p>
2167
+ </td>
2168
+ <td class="enum_member_annotations"> </td>
1662
2169
  </tr>
1663
2170
  <tr>
1664
- <td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
1665
- <td>the new start position of the selection</td>
2171
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-SCALE:CAPS"></a>ATK_TEXT_ATTR_SCALE</p></td>
2172
+ <td class="enum_member_description">
2173
+ <p>The scale of the characters. The value is a string representation of a double </p>
2174
+ </td>
2175
+ <td class="enum_member_annotations"> </td>
1666
2176
  </tr>
1667
2177
  <tr>
1668
- <td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
1669
- <td>the new end position of (e.g. offset immediately past)
1670
- the selection</td>
2178
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-WEIGHT:CAPS"></a>ATK_TEXT_ATTR_WEIGHT</p></td>
2179
+ <td class="enum_member_description">
2180
+ <p>The weight of the characters.</p>
2181
+ </td>
2182
+ <td class="enum_member_annotations"> </td>
1671
2183
  </tr>
1672
2184
  <tr>
1673
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1674
- <td>
1675
- <code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise</td>
2185
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-LANGUAGE:CAPS"></a>ATK_TEXT_ATTR_LANGUAGE</p></td>
2186
+ <td class="enum_member_description">
2187
+ <p>The language used</p>
2188
+ </td>
2189
+ <td class="enum_member_annotations"> </td>
1676
2190
  </tr>
1677
- </tbody>
1678
- </table></div>
1679
- </div>
1680
- <hr>
1681
- <div class="refsect2">
1682
- <a name="atk-text-set-caret-offset"></a><h3>atk_text_set_caret_offset ()</h3>
1683
- <pre class="programlisting"><span class="returnvalue">gboolean</span> atk_text_set_caret_offset (<em class="parameter"><code><a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *text</code></em>,
1684
- <em class="parameter"><code><span class="type">gint</span> offset</code></em>);</pre>
1685
- <p>
1686
- Sets the caret (cursor) position to the specified <em class="parameter"><code>offset</code></em>.
1687
- </p>
1688
- <div class="variablelist"><table border="0">
1689
- <col align="left" valign="top">
1690
- <tbody>
1691
2191
  <tr>
1692
- <td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1693
- <td>an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
2192
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-FAMILY-NAME:CAPS"></a>ATK_TEXT_ATTR_FAMILY_NAME</p></td>
2193
+ <td class="enum_member_description">
2194
+ <p>The font family name</p>
1694
2195
  </td>
2196
+ <td class="enum_member_annotations"> </td>
1695
2197
  </tr>
1696
2198
  <tr>
1697
- <td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
1698
- <td>position</td>
2199
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-BG-COLOR:CAPS"></a>ATK_TEXT_ATTR_BG_COLOR</p></td>
2200
+ <td class="enum_member_description">
2201
+ <p>The background color. The value is an RGB value of the format "<code class="literal">u</code>,<code class="literal">u</code>,<code class="literal">u</code>"</p>
2202
+ </td>
2203
+ <td class="enum_member_annotations"> </td>
1699
2204
  </tr>
1700
2205
  <tr>
1701
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1702
- <td>
1703
- <code class="literal">TRUE</code> if success, <code class="literal">FALSE</code> otherwise.</td>
2206
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-FG-COLOR:CAPS"></a>ATK_TEXT_ATTR_FG_COLOR</p></td>
2207
+ <td class="enum_member_description">
2208
+ <p>The foreground color. The value is an RGB value of the format "<code class="literal">u</code>,<code class="literal">u</code>,<code class="literal">u</code>"</p>
2209
+ </td>
2210
+ <td class="enum_member_annotations"> </td>
1704
2211
  </tr>
1705
- </tbody>
1706
- </table></div>
1707
- </div>
1708
- <hr>
1709
- <div class="refsect2">
1710
- <a name="atk-attribute-set-free"></a><h3>atk_attribute_set_free ()</h3>
1711
- <pre class="programlisting"><span class="returnvalue">void</span> atk_attribute_set_free (<em class="parameter"><code><a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> *attrib_set</code></em>);</pre>
1712
- <p>
1713
- Frees the memory used by an <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>, including all its
1714
- <a href="AtkText.html#AtkAttribute"><span class="type">AtkAttributes</span></a>.
1715
- </p>
1716
- <div class="variablelist"><table border="0">
1717
- <col align="left" valign="top">
1718
- <tbody><tr>
1719
- <td><p><span class="term"><em class="parameter"><code>attrib_set</code></em> :</span></p></td>
1720
- <td>The <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a> to free</td>
1721
- </tr></tbody>
1722
- </table></div>
1723
- </div>
1724
- <hr>
1725
- <div class="refsect2">
1726
- <a name="atk-text-attribute-register"></a><h3>atk_text_attribute_register ()</h3>
1727
- <pre class="programlisting"><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a> atk_text_attribute_register (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
1728
- <p>
1729
- Associate <em class="parameter"><code>name</code></em> with a new <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a>
1730
- </p>
1731
- <div class="variablelist"><table border="0">
1732
- <col align="left" valign="top">
1733
- <tbody>
1734
2212
  <tr>
1735
- <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1736
- <td>a name string</td>
2213
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-BG-STIPPLE:CAPS"></a>ATK_TEXT_ATTR_BG_STIPPLE</p></td>
2214
+ <td class="enum_member_description">
2215
+ <p>"true" if a <span class="type">GdkBitmap</span> is set for stippling the background color.</p>
2216
+ </td>
2217
+ <td class="enum_member_annotations"> </td>
1737
2218
  </tr>
1738
2219
  <tr>
1739
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1740
- <td>an <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> associated with <em class="parameter"><code>name</code></em>
2220
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-FG-STIPPLE:CAPS"></a>ATK_TEXT_ATTR_FG_STIPPLE</p></td>
2221
+ <td class="enum_member_description">
2222
+ <p>"true" if a <span class="type">GdkBitmap</span> is set for stippling the foreground color.</p>
1741
2223
  </td>
2224
+ <td class="enum_member_annotations"> </td>
1742
2225
  </tr>
1743
- </tbody>
1744
- </table></div>
1745
- </div>
1746
- <hr>
1747
- <div class="refsect2">
1748
- <a name="atk-text-attribute-get-name"></a><h3>atk_text_attribute_get_name ()</h3>
1749
- <pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_text_attribute_get_name (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> attr</code></em>);</pre>
1750
- <p>
1751
- Gets the name corresponding to the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a>
1752
- </p>
1753
- <div class="variablelist"><table border="0">
1754
- <col align="left" valign="top">
1755
- <tbody>
1756
2226
  <tr>
1757
- <td><p><span class="term"><em class="parameter"><code>attr</code></em> :</span></p></td>
1758
- <td>The <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> whose name is required</td>
2227
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-WRAP-MODE:CAPS"></a>ATK_TEXT_ATTR_WRAP_MODE</p></td>
2228
+ <td class="enum_member_description">
2229
+ <p>The wrap mode of the text, if any. Values are "none", "char", "word", or "word_char".</p>
2230
+ </td>
2231
+ <td class="enum_member_annotations"> </td>
1759
2232
  </tr>
1760
2233
  <tr>
1761
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1762
- <td>a string containing the name; this string should not be freed</td>
2234
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-DIRECTION:CAPS"></a>ATK_TEXT_ATTR_DIRECTION</p></td>
2235
+ <td class="enum_member_description">
2236
+ <p>The direction of the text, if set. Values are "none", "ltr" or "rtl" </p>
2237
+ </td>
2238
+ <td class="enum_member_annotations"> </td>
1763
2239
  </tr>
1764
- </tbody>
1765
- </table></div>
1766
- </div>
1767
- <hr>
1768
- <div class="refsect2">
1769
- <a name="atk-text-attribute-for-name"></a><h3>atk_text_attribute_for_name ()</h3>
1770
- <pre class="programlisting"><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="returnvalue">AtkTextAttribute</span></a> atk_text_attribute_for_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
1771
- <p>
1772
- Get the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> type corresponding to a text attribute name.
1773
- </p>
1774
- <div class="variablelist"><table border="0">
1775
- <col align="left" valign="top">
1776
- <tbody>
1777
2240
  <tr>
1778
- <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1779
- <td>a string which is the (non-localized) name of an ATK text attribute.</td>
2241
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-JUSTIFICATION:CAPS"></a>ATK_TEXT_ATTR_JUSTIFICATION</p></td>
2242
+ <td class="enum_member_description">
2243
+ <p>The justification of the text, if set. Values are "left", "right", "center" or "fill" </p>
2244
+ </td>
2245
+ <td class="enum_member_annotations"> </td>
1780
2246
  </tr>
1781
2247
  <tr>
1782
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1783
- <td>the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> enumerated type corresponding to the specified
1784
- name,
1785
- or <span class="type">ATK_TEXT_ATTRIBUTE_INVALID</span> if no matching text attribute is found.</td>
2248
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-STRETCH:CAPS"></a>ATK_TEXT_ATTR_STRETCH</p></td>
2249
+ <td class="enum_member_description">
2250
+ <p>The stretch of the text, if set. Values are "ultra_condensed", "extra_condensed", "condensed", "semi_condensed", "normal", "semi_expanded", "expanded", "extra_expanded" or "ultra_expanded"</p>
2251
+ </td>
2252
+ <td class="enum_member_annotations"> </td>
1786
2253
  </tr>
1787
- </tbody>
1788
- </table></div>
1789
- </div>
1790
- <hr>
1791
- <div class="refsect2">
1792
- <a name="atk-text-attribute-get-value"></a><h3>atk_text_attribute_get_value ()</h3>
1793
- <pre class="programlisting">const <span class="returnvalue">gchar</span> * atk_text_attribute_get_value (<em class="parameter"><code><a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> attr</code></em>,
1794
- <em class="parameter"><code><span class="type">gint</span> index_</code></em>);</pre>
1795
- <p>
1796
- Gets the value for the index of the <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a>
1797
- </p>
1798
- <div class="variablelist"><table border="0">
1799
- <col align="left" valign="top">
1800
- <tbody>
1801
2254
  <tr>
1802
- <td><p><span class="term"><em class="parameter"><code>attr</code></em> :</span></p></td>
1803
- <td>The <a class="link" href="AtkText.html#AtkTextAttribute" title="enum AtkTextAttribute"><span class="type">AtkTextAttribute</span></a> for which a value is required</td>
2255
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-VARIANT:CAPS"></a>ATK_TEXT_ATTR_VARIANT</p></td>
2256
+ <td class="enum_member_description">
2257
+ <p>The capitalization variant of the text, if set. Values are "normal" or "small_caps"</p>
2258
+ </td>
2259
+ <td class="enum_member_annotations"> </td>
1804
2260
  </tr>
1805
2261
  <tr>
1806
- <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
1807
- <td>The index of the required value</td>
2262
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-STYLE:CAPS"></a>ATK_TEXT_ATTR_STYLE</p></td>
2263
+ <td class="enum_member_description">
2264
+ <p>The slant style of the text, if set. Values are "normal", "oblique" or "italic"</p>
2265
+ </td>
2266
+ <td class="enum_member_annotations"> </td>
1808
2267
  </tr>
1809
2268
  <tr>
1810
- <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1811
- <td>a string containing the value; this string should not be freed;
1812
- NULL is returned if there are no values maintained for the attr value.</td>
2269
+ <td class="enum_member_name"><p><a name="ATK-TEXT-ATTR-LAST-DEFINED:CAPS"></a>ATK_TEXT_ATTR_LAST_DEFINED</p></td>
2270
+ <td class="enum_member_description">
2271
+ <p>not a valid text attribute, used for finding end of enumeration</p>
2272
+ </td>
2273
+ <td class="enum_member_annotations"> </td>
1813
2274
  </tr>
1814
2275
  </tbody>
1815
2276
  </table></div>
1816
2277
  </div>
1817
2278
  </div>
2279
+ </div>
1818
2280
  <div class="refsect1">
1819
2281
  <a name="AtkText.signal-details"></a><h2>Signal Details</h2>
1820
2282
  <div class="refsect2">
1821
- <a name="AtkText-text-attributes-changed"></a><h3>The <code class="literal">"text-attributes-changed"</code> signal</h3>
1822
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
1823
- <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1824
- <p>
1825
- The "text-attributes-changed" signal is emitted when the text
2283
+ <a name="AtkText-text-attributes-changed"></a><h3>The <code class="literal">“text-attributes-changed”</code> signal</h3>
2284
+ <pre class="programlisting"><span class="returnvalue">void</span>
2285
+ user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
2286
+ <span class="type">gpointer</span> user_data)</pre>
2287
+ <p>The "text-attributes-changed" signal is emitted when the text
1826
2288
  attributes of the text of an object which implements AtkText
1827
- changes.
1828
- </p>
1829
- <div class="variablelist"><table border="0">
1830
- <col align="left" valign="top">
2289
+ changes.</p>
2290
+ <div class="refsect3">
2291
+ <a name="id-1.5.13.11.2.5"></a><h4>Parameters</h4>
2292
+ <div class="informaltable"><table width="100%" border="0">
2293
+ <colgroup>
2294
+ <col width="150px" class="parameters_name">
2295
+ <col class="parameters_description">
2296
+ <col width="200px" class="parameters_annotations">
2297
+ </colgroup>
1831
2298
  <tbody>
1832
2299
  <tr>
1833
- <td><p><span class="term"><em class="parameter"><code>atktext</code></em> :</span></p></td>
1834
- <td>the object which received the signal.</td>
2300
+ <td class="parameter_name"><p>atktext</p></td>
2301
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
2302
+ <td class="parameter_annotations"> </td>
1835
2303
  </tr>
1836
2304
  <tr>
1837
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1838
- <td>user data set when the signal handler was connected.</td>
2305
+ <td class="parameter_name"><p>user_data</p></td>
2306
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
2307
+ <td class="parameter_annotations"> </td>
1839
2308
  </tr>
1840
2309
  </tbody>
1841
2310
  </table></div>
1842
2311
  </div>
2312
+ <p>Flags: Run Last</p>
2313
+ </div>
1843
2314
  <hr>
1844
2315
  <div class="refsect2">
1845
- <a name="AtkText-text-caret-moved"></a><h3>The <code class="literal">"text-caret-moved"</code> signal</h3>
1846
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
1847
- <span class="type">gint</span> arg1,
1848
- <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1849
- <p>
1850
- The "text-caret-moved" signal is emitted when the caret
2316
+ <a name="AtkText-text-caret-moved"></a><h3>The <code class="literal">“text-caret-moved”</code> signal</h3>
2317
+ <pre class="programlisting"><span class="returnvalue">void</span>
2318
+ user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
2319
+ <span class="type">gint</span> arg1,
2320
+ <span class="type">gpointer</span> user_data)</pre>
2321
+ <p>The "text-caret-moved" signal is emitted when the caret
1851
2322
  position of the text of an object which implements AtkText
1852
- changes.
1853
- </p>
1854
- <div class="variablelist"><table border="0">
1855
- <col align="left" valign="top">
2323
+ changes.</p>
2324
+ <div class="refsect3">
2325
+ <a name="id-1.5.13.11.3.5"></a><h4>Parameters</h4>
2326
+ <div class="informaltable"><table width="100%" border="0">
2327
+ <colgroup>
2328
+ <col width="150px" class="parameters_name">
2329
+ <col class="parameters_description">
2330
+ <col width="200px" class="parameters_annotations">
2331
+ </colgroup>
1856
2332
  <tbody>
1857
2333
  <tr>
1858
- <td><p><span class="term"><em class="parameter"><code>atktext</code></em> :</span></p></td>
1859
- <td>the object which received the signal.</td>
2334
+ <td class="parameter_name"><p>atktext</p></td>
2335
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
2336
+ <td class="parameter_annotations"> </td>
1860
2337
  </tr>
1861
2338
  <tr>
1862
- <td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
1863
- <td>The new position of the text caret.</td>
2339
+ <td class="parameter_name"><p>arg1</p></td>
2340
+ <td class="parameter_description"><p>The new position of the text caret.</p></td>
2341
+ <td class="parameter_annotations"> </td>
1864
2342
  </tr>
1865
2343
  <tr>
1866
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1867
- <td>user data set when the signal handler was connected.</td>
2344
+ <td class="parameter_name"><p>user_data</p></td>
2345
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
2346
+ <td class="parameter_annotations"> </td>
1868
2347
  </tr>
1869
2348
  </tbody>
1870
2349
  </table></div>
1871
2350
  </div>
2351
+ <p>Flags: Run Last</p>
2352
+ </div>
1872
2353
  <hr>
1873
2354
  <div class="refsect2">
1874
- <a name="AtkText-text-changed"></a><h3>The <code class="literal">"text-changed"</code> signal</h3>
1875
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
1876
- <span class="type">gint</span> arg1,
1877
- <span class="type">gint</span> arg2,
1878
- <span class="type">gpointer</span> user_data) : <code class="literal">Has Details</code></pre>
1879
- <div class="warning">
1880
- <h3 class="title">Warning</h3>
1881
- <p><code class="literal">AtkText::text-changed</code> is deprecated and should not be used in newly-written code. Since 2.9.4. Use <span class="type">"text-insert"</span> or
1882
- <span class="type">"text-remove"</span> instead.</p>
1883
- </div>
1884
- <p>
1885
- The "text-changed" signal is emitted when the text of the
2355
+ <a name="AtkText-text-changed"></a><h3>The <code class="literal">“text-changed”</code> signal</h3>
2356
+ <pre class="programlisting"><span class="returnvalue">void</span>
2357
+ user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
2358
+ <span class="type">gint</span> arg1,
2359
+ <span class="type">gint</span> arg2,
2360
+ <span class="type">gpointer</span> user_data)</pre>
2361
+ <p>The "text-changed" signal is emitted when the text of the
1886
2362
  object which implements the AtkText interface changes, This
1887
2363
  signal will have a detail which is either "insert" or
1888
2364
  "delete" which identifies whether the text change was an
1889
- insertion or a deletion.
1890
- </p>
1891
- <div class="variablelist"><table border="0">
1892
- <col align="left" valign="top">
2365
+ insertion or a deletion.</p>
2366
+ <div class="warning">
2367
+ <p><code class="literal">AtkText::text-changed</code> is deprecated and should not be used in newly-written code.</p>
2368
+ <p>Since 2.9.4. Use <span class="type">“text-insert”</span> or
2369
+ <span class="type">“text-remove”</span> instead.</p>
2370
+ </div>
2371
+ <div class="refsect3">
2372
+ <a name="id-1.5.13.11.4.6"></a><h4>Parameters</h4>
2373
+ <div class="informaltable"><table width="100%" border="0">
2374
+ <colgroup>
2375
+ <col width="150px" class="parameters_name">
2376
+ <col class="parameters_description">
2377
+ <col width="200px" class="parameters_annotations">
2378
+ </colgroup>
1893
2379
  <tbody>
1894
2380
  <tr>
1895
- <td><p><span class="term"><em class="parameter"><code>atktext</code></em> :</span></p></td>
1896
- <td>the object which received the signal.</td>
2381
+ <td class="parameter_name"><p>atktext</p></td>
2382
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
2383
+ <td class="parameter_annotations"> </td>
1897
2384
  </tr>
1898
2385
  <tr>
1899
- <td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
1900
- <td>The position (character offset) of the insertion or deletion.</td>
2386
+ <td class="parameter_name"><p>arg1</p></td>
2387
+ <td class="parameter_description"><p>The position (character offset) of the insertion or deletion.</p></td>
2388
+ <td class="parameter_annotations"> </td>
1901
2389
  </tr>
1902
2390
  <tr>
1903
- <td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
1904
- <td>The length (in characters) of text inserted or deleted.</td>
2391
+ <td class="parameter_name"><p>arg2</p></td>
2392
+ <td class="parameter_description"><p>The length (in characters) of text inserted or deleted.</p></td>
2393
+ <td class="parameter_annotations"> </td>
1905
2394
  </tr>
1906
2395
  <tr>
1907
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1908
- <td>user data set when the signal handler was connected.</td>
2396
+ <td class="parameter_name"><p>user_data</p></td>
2397
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
2398
+ <td class="parameter_annotations"> </td>
1909
2399
  </tr>
1910
2400
  </tbody>
1911
2401
  </table></div>
1912
2402
  </div>
2403
+ <p>Flags: Has Details</p>
2404
+ </div>
1913
2405
  <hr>
1914
2406
  <div class="refsect2">
1915
- <a name="AtkText-text-insert"></a><h3>The <code class="literal">"text-insert"</code> signal</h3>
1916
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
1917
- <span class="type">gint</span> arg1,
1918
- <span class="type">gint</span> arg2,
1919
- <span class="type">gchar</span> *arg3,
1920
- <span class="type">gpointer</span> user_data) : <code class="literal">Has Details</code></pre>
1921
- <p>
1922
- The "text-insert" signal is emitted when a new text is
1923
- inserted.
1924
- </p>
1925
- <div class="variablelist"><table border="0">
1926
- <col align="left" valign="top">
2407
+ <a name="AtkText-text-insert"></a><h3>The <code class="literal">“text-insert”</code> signal</h3>
2408
+ <pre class="programlisting"><span class="returnvalue">void</span>
2409
+ user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
2410
+ <span class="type">gint</span> arg1,
2411
+ <span class="type">gint</span> arg2,
2412
+ <span class="type">gchar</span> *arg3,
2413
+ <span class="type">gpointer</span> user_data)</pre>
2414
+ <p>The "text-insert" signal is emitted when a new text is
2415
+ inserted. If the signal was not triggered by the user
2416
+ (e.g. typing or pasting text), the "system" detail should be
2417
+ included.</p>
2418
+ <div class="refsect3">
2419
+ <a name="id-1.5.13.11.5.5"></a><h4>Parameters</h4>
2420
+ <div class="informaltable"><table width="100%" border="0">
2421
+ <colgroup>
2422
+ <col width="150px" class="parameters_name">
2423
+ <col class="parameters_description">
2424
+ <col width="200px" class="parameters_annotations">
2425
+ </colgroup>
1927
2426
  <tbody>
1928
2427
  <tr>
1929
- <td><p><span class="term"><em class="parameter"><code>atktext</code></em> :</span></p></td>
1930
- <td>the object which received the signal.</td>
2428
+ <td class="parameter_name"><p>atktext</p></td>
2429
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
2430
+ <td class="parameter_annotations"> </td>
1931
2431
  </tr>
1932
2432
  <tr>
1933
- <td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
1934
- <td>The position (character offset) of the insertion.</td>
2433
+ <td class="parameter_name"><p>arg1</p></td>
2434
+ <td class="parameter_description"><p>The position (character offset) of the insertion.</p></td>
2435
+ <td class="parameter_annotations"> </td>
1935
2436
  </tr>
1936
2437
  <tr>
1937
- <td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
1938
- <td>The length (in characters) of text inserted.</td>
2438
+ <td class="parameter_name"><p>arg2</p></td>
2439
+ <td class="parameter_description"><p>The length (in characters) of text inserted.</p></td>
2440
+ <td class="parameter_annotations"> </td>
1939
2441
  </tr>
1940
2442
  <tr>
1941
- <td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
1942
- <td>The new text inserted</td>
2443
+ <td class="parameter_name"><p>arg3</p></td>
2444
+ <td class="parameter_description"><p>The new text inserted</p></td>
2445
+ <td class="parameter_annotations"> </td>
1943
2446
  </tr>
1944
2447
  <tr>
1945
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1946
- <td>user data set when the signal handler was connected.</td>
2448
+ <td class="parameter_name"><p>user_data</p></td>
2449
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
2450
+ <td class="parameter_annotations"> </td>
1947
2451
  </tr>
1948
2452
  </tbody>
1949
2453
  </table></div>
1950
2454
  </div>
2455
+ <p>Flags: Has Details</p>
2456
+ </div>
1951
2457
  <hr>
1952
2458
  <div class="refsect2">
1953
- <a name="AtkText-text-remove"></a><h3>The <code class="literal">"text-remove"</code> signal</h3>
1954
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
1955
- <span class="type">gint</span> arg1,
1956
- <span class="type">gint</span> arg2,
1957
- <span class="type">gchar</span> *arg3,
1958
- <span class="type">gpointer</span> user_data) : <code class="literal">Has Details</code></pre>
1959
- <p>
1960
- The "text-remove" signal is emitted when a new text is
1961
- removed.
1962
- </p>
1963
- <div class="variablelist"><table border="0">
1964
- <col align="left" valign="top">
2459
+ <a name="AtkText-text-remove"></a><h3>The <code class="literal">“text-remove”</code> signal</h3>
2460
+ <pre class="programlisting"><span class="returnvalue">void</span>
2461
+ user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
2462
+ <span class="type">gint</span> arg1,
2463
+ <span class="type">gint</span> arg2,
2464
+ <span class="type">gchar</span> *arg3,
2465
+ <span class="type">gpointer</span> user_data)</pre>
2466
+ <p>The "text-remove" signal is emitted when a new text is
2467
+ removed. If the signal was not triggered by the user
2468
+ (e.g. typing or pasting text), the "system" detail should be
2469
+ included.</p>
2470
+ <div class="refsect3">
2471
+ <a name="id-1.5.13.11.6.5"></a><h4>Parameters</h4>
2472
+ <div class="informaltable"><table width="100%" border="0">
2473
+ <colgroup>
2474
+ <col width="150px" class="parameters_name">
2475
+ <col class="parameters_description">
2476
+ <col width="200px" class="parameters_annotations">
2477
+ </colgroup>
1965
2478
  <tbody>
1966
2479
  <tr>
1967
- <td><p><span class="term"><em class="parameter"><code>atktext</code></em> :</span></p></td>
1968
- <td>the object which received the signal.</td>
2480
+ <td class="parameter_name"><p>atktext</p></td>
2481
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
2482
+ <td class="parameter_annotations"> </td>
1969
2483
  </tr>
1970
2484
  <tr>
1971
- <td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
1972
- <td>The position (character offset) of the removal.</td>
2485
+ <td class="parameter_name"><p>arg1</p></td>
2486
+ <td class="parameter_description"><p>The position (character offset) of the removal.</p></td>
2487
+ <td class="parameter_annotations"> </td>
1973
2488
  </tr>
1974
2489
  <tr>
1975
- <td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
1976
- <td>The length (in characters) of text removed.</td>
2490
+ <td class="parameter_name"><p>arg2</p></td>
2491
+ <td class="parameter_description"><p>The length (in characters) of text removed.</p></td>
2492
+ <td class="parameter_annotations"> </td>
1977
2493
  </tr>
1978
2494
  <tr>
1979
- <td><p><span class="term"><em class="parameter"><code>arg3</code></em> :</span></p></td>
1980
- <td>The old text removed</td>
2495
+ <td class="parameter_name"><p>arg3</p></td>
2496
+ <td class="parameter_description"><p>The old text removed</p></td>
2497
+ <td class="parameter_annotations"> </td>
1981
2498
  </tr>
1982
2499
  <tr>
1983
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1984
- <td>user data set when the signal handler was connected.</td>
2500
+ <td class="parameter_name"><p>user_data</p></td>
2501
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
2502
+ <td class="parameter_annotations"> </td>
1985
2503
  </tr>
1986
2504
  </tbody>
1987
2505
  </table></div>
1988
2506
  </div>
2507
+ <p>Flags: Has Details</p>
2508
+ </div>
1989
2509
  <hr>
1990
2510
  <div class="refsect2">
1991
- <a name="AtkText-text-selection-changed"></a><h3>The <code class="literal">"text-selection-changed"</code> signal</h3>
1992
- <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
1993
- <span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
1994
- <p>
1995
- The "text-selection-changed" signal is emitted when the
1996
- selected text of an object which implements AtkText changes.
1997
- </p>
1998
- <div class="variablelist"><table border="0">
1999
- <col align="left" valign="top">
2511
+ <a name="AtkText-text-selection-changed"></a><h3>The <code class="literal">“text-selection-changed”</code> signal</h3>
2512
+ <pre class="programlisting"><span class="returnvalue">void</span>
2513
+ user_function (<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> *atktext,
2514
+ <span class="type">gpointer</span> user_data)</pre>
2515
+ <p>The "text-selection-changed" signal is emitted when the
2516
+ selected text of an object which implements AtkText changes.</p>
2517
+ <div class="refsect3">
2518
+ <a name="id-1.5.13.11.7.5"></a><h4>Parameters</h4>
2519
+ <div class="informaltable"><table width="100%" border="0">
2520
+ <colgroup>
2521
+ <col width="150px" class="parameters_name">
2522
+ <col class="parameters_description">
2523
+ <col width="200px" class="parameters_annotations">
2524
+ </colgroup>
2000
2525
  <tbody>
2001
2526
  <tr>
2002
- <td><p><span class="term"><em class="parameter"><code>atktext</code></em> :</span></p></td>
2003
- <td>the object which received the signal.</td>
2527
+ <td class="parameter_name"><p>atktext</p></td>
2528
+ <td class="parameter_description"><p>the object which received the signal.</p></td>
2529
+ <td class="parameter_annotations"> </td>
2004
2530
  </tr>
2005
2531
  <tr>
2006
- <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2007
- <td>user data set when the signal handler was connected.</td>
2532
+ <td class="parameter_name"><p>user_data</p></td>
2533
+ <td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
2534
+ <td class="parameter_annotations"> </td>
2008
2535
  </tr>
2009
2536
  </tbody>
2010
2537
  </table></div>
2011
2538
  </div>
2539
+ <p>Flags: Run Last</p>
2540
+ </div>
2012
2541
  </div>
2013
2542
  </div>
2014
2543
  <div class="footer">
2015
2544
  <hr>
2016
- Generated by GTK-Doc V1.19.1</div>
2545
+ Generated by GTK-Doc V1.21.1</div>
2017
2546
  </body>
2018
2547
  </html>