doc/libatspi/html/libatspi-atspi-constants.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>atspi-constants</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="libatspi-atspi-types.html" title="atspi-types">
  10 <link rel="next" href="libatspi-atspi-misc.html" title="atspi-misc">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libatspi-atspi-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="libatspi-atspi-misc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libatspi-atspi-constants.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libatspi-atspi-constants.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libatspi-atspi-constants"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="libatspi-atspi-constants.top_of_page"></a>atspi-constants</span></h2>
  34 <p>atspi-constants — Constant definitions needed by multiple interfaces.</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libatspi-atspi-constants.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">enum                <a class="link" href="libatspi-atspi-constants.html#AtspiLocaleType" title="enum AtspiLocaleType">AtspiLocaleType</a>;
  41 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-LOCALE-TYPE:CAPS" title="ATSPI_LOCALE_TYPE">ATSPI_LOCALE_TYPE</a>
  42 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType">AtspiCoordType</a>;
  43 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-COORD-TYPE-COUNT:CAPS" title="ATSPI_COORD_TYPE_COUNT">ATSPI_COORD_TYPE_COUNT</a>
  44 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder">AtspiCollectionSortOrder</a>;
  45 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-SORTORDER-COUNT:CAPS" title="ATSPI_SORTORDER_COUNT">ATSPI_SORTORDER_COUNT</a>
  46 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionMatchType" title="enum AtspiCollectionMatchType">AtspiCollectionMatchType</a>;
  47 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-MATCHTYPES-COUNT:CAPS" title="ATSPI_MATCHTYPES_COUNT">ATSPI_MATCHTYPES_COUNT</a>
  48 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType">AtspiCollectionTreeTraversalType</a>;
  49 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-TREETRAVERSALTYPE:CAPS" title="ATSPI_TREETRAVERSALTYPE">ATSPI_TREETRAVERSALTYPE</a>
  50 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer">AtspiComponentLayer</a>;
  51 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-COMPONENTLAYER-COUNT:CAPS" title="ATSPI_COMPONENTLAYER_COUNT">ATSPI_COMPONENTLAYER_COUNT</a>
  52 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType">AtspiTextBoundaryType</a>;
  53 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-TEXT-BOUNDARY-TYPE-COUNT:CAPS" title="ATSPI_TEXT_BOUNDARY_TYPE_COUNT">ATSPI_TEXT_BOUNDARY_TYPE_COUNT</a>
  54 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType">AtspiTextClipType</a>;
  55 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-TEXT-CLIP-TYPE-COUNT:CAPS" title="ATSPI_TEXT_CLIP_TYPE_COUNT">ATSPI_TEXT_CLIP_TYPE_COUNT</a>
  56 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType">AtspiStateType</a>;
  57 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-STATETYPE-COUNT:CAPS" title="ATSPI_STATETYPE_COUNT">ATSPI_STATETYPE_COUNT</a>
  58 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiKeyEventType" title="enum AtspiKeyEventType">AtspiKeyEventType</a>;
  59 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEYEVENTTYPE-COUNT:CAPS" title="ATSPI_KEYEVENTTYPE_COUNT">ATSPI_KEYEVENTTYPE_COUNT</a>
  60 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiEventType" title="enum AtspiEventType">AtspiEventType</a>;
  61 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-EVENTTYPE-COUNT:CAPS" title="ATSPI_EVENTTYPE_COUNT">ATSPI_EVENTTYPE_COUNT</a>
  62 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType">AtspiKeySynthType</a>;
  63 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEYSYNTHTYPE-COUNT:CAPS" title="ATSPI_KEYSYNTHTYPE_COUNT">ATSPI_KEYSYNTHTYPE_COUNT</a>
  64 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiModifierType" title="enum AtspiModifierType">AtspiModifierType</a>;
  65 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-MODIFIERTYPE-COUNT:CAPS" title="ATSPI_MODIFIERTYPE_COUNT">ATSPI_MODIFIERTYPE_COUNT</a>
  66 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType">AtspiRelationType</a>;
  67 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-RELATIONTYPE-COUNT:CAPS" title="ATSPI_RELATIONTYPE_COUNT">ATSPI_RELATIONTYPE_COUNT</a>
  68 enum                <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole">AtspiRole</a>;
  69 #define             <a class="link" href="libatspi-atspi-constants.html#ATSPI-ROLE-COUNT:CAPS" title="ATSPI_ROLE_COUNT">ATSPI_ROLE_COUNT</a>
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="libatspi-atspi-constants.description"></a><h2>Description</h2>
  74 <p>
  75 Constant definitions needed by multiple interfaces.
  76 </p>
  77 </div>
  78 <div class="refsect1">
  79 <a name="libatspi-atspi-constants.details"></a><h2>Details</h2>
  80 <div class="refsect2">
  81 <a name="AtspiLocaleType"></a><h3>enum AtspiLocaleType</h3>
  82 <pre class="programlisting">typedef enum {
  83     ATSPI_LOCALE_TYPE_MESSAGES,
  84     ATSPI_LOCALE_TYPE_COLLATE,
  85     ATSPI_LOCALE_TYPE_CTYPE,
  86     ATSPI_LOCALE_TYPE_MONETARY,
  87     ATSPI_LOCALE_TYPE_NUMERIC,
  88     ATSPI_LOCALE_TYPE_TIME,
  89 } AtspiLocaleType;
  90 </pre>
  91 <p>
  92 Used by interfaces <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> and <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a>, this
  93 enumeration corresponds to the POSIX 'setlocale' enum values.
  94 </p>
  95 <div class="variablelist"><table border="0" class="variablelist">
  96 <colgroup>
  97 <col align="left" valign="top">
  98 <col>
  99 </colgroup>
 100 <tbody>
 101 <tr>
 102 <td><p><a name="ATSPI-LOCALE-TYPE-MESSAGES:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_MESSAGES</code></span></p></td>
 103 <td>For localizable natural-language messages.
 104 </td>
 105 </tr>
 106 <tr>
 107 <td><p><a name="ATSPI-LOCALE-TYPE-COLLATE:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_COLLATE</code></span></p></td>
 108 <td>For regular expression matching and string
 109 collation.
 110 </td>
 111 </tr>
 112 <tr>
 113 <td><p><a name="ATSPI-LOCALE-TYPE-CTYPE:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_CTYPE</code></span></p></td>
 114 <td>For regular expression matching, character
 115 classification, conversion, case-sensitive comparison, and wide character
 116 functions.
 117 </td>
 118 </tr>
 119 <tr>
 120 <td><p><a name="ATSPI-LOCALE-TYPE-MONETARY:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_MONETARY</code></span></p></td>
 121 <td>For monetary formatting.
 122 </td>
 123 </tr>
 124 <tr>
 125 <td><p><a name="ATSPI-LOCALE-TYPE-NUMERIC:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_NUMERIC</code></span></p></td>
 126 <td>For number formatting (such as the decimal
 127 point and the thousands separator).
 128 </td>
 129 </tr>
 130 <tr>
 131 <td><p><a name="ATSPI-LOCALE-TYPE-TIME:CAPS"></a><span class="term"><code class="literal">ATSPI_LOCALE_TYPE_TIME</code></span></p></td>
 132 <td>For time and date formatting.
 133 </td>
 134 </tr>
 135 </tbody>
 136 </table></div>
 137 </div>
 138 <hr>
 139 <div class="refsect2">
 140 <a name="ATSPI-LOCALE-TYPE:CAPS"></a><h3>ATSPI_LOCALE_TYPE</h3>
 141 <pre class="programlisting">#define ATSPI_LOCALE_TYPE _COUNT(5+1)
 142 </pre>
 143 <p>
 144 </p>
 145 </div>
 146 <hr>
 147 <div class="refsect2">
 148 <a name="AtspiCoordType"></a><h3>enum AtspiCoordType</h3>
 149 <pre class="programlisting">typedef enum {
 150     ATSPI_COORD_TYPE_SCREEN,
 151     ATSPI_COORD_TYPE_WINDOW,
 152 } AtspiCoordType;
 153 </pre>
 154 <p>
 155 Enumeration used by <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>, <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a>, and <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> interfaces
 156 to specify whether coordinates are relative to the window or the screen.
 157 </p>
 158 <div class="variablelist"><table border="0" class="variablelist">
 159 <colgroup>
 160 <col align="left" valign="top">
 161 <col>
 162 </colgroup>
 163 <tbody>
 164 <tr>
 165 <td><p><a name="ATSPI-COORD-TYPE-SCREEN:CAPS"></a><span class="term"><code class="literal">ATSPI_COORD_TYPE_SCREEN</code></span></p></td>
 166 <td>Specifies xy coordinates relative to the screen.
 167 </td>
 168 </tr>
 169 <tr>
 170 <td><p><a name="ATSPI-COORD-TYPE-WINDOW:CAPS"></a><span class="term"><code class="literal">ATSPI_COORD_TYPE_WINDOW</code></span></p></td>
 171 <td>Specifies xy coordinates relative to the widget's
 172 top-level window.
 173 </td>
 174 </tr>
 175 </tbody>
 176 </table></div>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="ATSPI-COORD-TYPE-COUNT:CAPS"></a><h3>ATSPI_COORD_TYPE_COUNT</h3>
 181 <pre class="programlisting">#define ATSPI_COORD_TYPE_COUNT (1+1)
 182 </pre>
 183 <p>
 184 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a>.
 185 </p>
 186 </div>
 187 <hr>
 188 <div class="refsect2">
 189 <a name="AtspiCollectionSortOrder"></a><h3>enum AtspiCollectionSortOrder</h3>
 190 <pre class="programlisting">typedef enum {
 191     ATSPI_Collection_SORT_ORDER_INVALID,
 192     ATSPI_Collection_SORT_ORDER_CANONICAL,
 193     ATSPI_Collection_SORT_ORDER_FLOW,
 194     ATSPI_Collection_SORT_ORDER_TAB,
 195     ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL,
 196     ATSPI_Collection_SORT_ORDER_REVERSE_FLOW,
 197     ATSPI_Collection_SORT_ORDER_REVERSE_TAB,
 198     ATSPI_Collection_SORT_ORDER_LAST_DEFINED,
 199 } AtspiCollectionSortOrder;
 200 </pre>
 201 <p>
 202 Enumeration used by interface <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to specify
 203 the way <span class="type">AtspiAccesible</span> objects should be sorted.
 204 </p>
 205 <div class="variablelist"><table border="0" class="variablelist">
 206 <colgroup>
 207 <col align="left" valign="top">
 208 <col>
 209 </colgroup>
 210 <tbody>
 211 <tr>
 212 <td><p><a name="ATSPI-Collection-SORT-ORDER-INVALID"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_INVALID</code></span></p></td>
 213 <td></td>
 214 </tr>
 215 <tr>
 216 <td><p><a name="ATSPI-Collection-SORT-ORDER-CANONICAL"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_CANONICAL</code></span></p></td>
 217 <td></td>
 218 </tr>
 219 <tr>
 220 <td><p><a name="ATSPI-Collection-SORT-ORDER-FLOW"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_FLOW</code></span></p></td>
 221 <td></td>
 222 </tr>
 223 <tr>
 224 <td><p><a name="ATSPI-Collection-SORT-ORDER-TAB"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_TAB</code></span></p></td>
 225 <td></td>
 226 </tr>
 227 <tr>
 228 <td><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-CANONICAL"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL</code></span></p></td>
 229 <td></td>
 230 </tr>
 231 <tr>
 232 <td><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-FLOW"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_REVERSE_FLOW</code></span></p></td>
 233 <td></td>
 234 </tr>
 235 <tr>
 236 <td><p><a name="ATSPI-Collection-SORT-ORDER-REVERSE-TAB"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_REVERSE_TAB</code></span></p></td>
 237 <td></td>
 238 </tr>
 239 <tr>
 240 <td><p><a name="ATSPI-Collection-SORT-ORDER-LAST-DEFINED"></a><span class="term"><code class="literal">ATSPI_Collection_SORT_ORDER_LAST_DEFINED</code></span></p></td>
 241 <td></td>
 242 </tr>
 243 </tbody>
 244 </table></div>
 245 </div>
 246 <hr>
 247 <div class="refsect2">
 248 <a name="ATSPI-SORTORDER-COUNT:CAPS"></a><h3>ATSPI_SORTORDER_COUNT</h3>
 249 <pre class="programlisting">#define ATSPI_SORTORDER_COUNT (7+1)
 250 </pre>
 251 <p>
 252 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a>.
 253 </p>
 254 </div>
 255 <hr>
 256 <div class="refsect2">
 257 <a name="AtspiCollectionMatchType"></a><h3>enum AtspiCollectionMatchType</h3>
 258 <pre class="programlisting">typedef enum {
 259     ATSPI_Collection_MATCH_INVALID,
 260     ATSPI_Collection_MATCH_ALL,
 261     ATSPI_Collection_MATCH_ANY,
 262     ATSPI_Collection_MATCH_NONE,
 263     ATSPI_Collection_MATCH_EMPTY,
 264     ATSPI_Collection_MATCH_LAST_DEFINED,
 265 } AtspiCollectionMatchType;
 266 </pre>
 267 <p>
 268 Enumeration used by <a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> to specify
 269 how to interpret <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects.
 270 </p>
 271 <div class="variablelist"><table border="0" class="variablelist">
 272 <colgroup>
 273 <col align="left" valign="top">
 274 <col>
 275 </colgroup>
 276 <tbody>
 277 <tr>
 278 <td><p><a name="ATSPI-Collection-MATCH-INVALID"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_INVALID</code></span></p></td>
 279 <td>Indicates an error condition or
 280 uninitialized value.
 281 </td>
 282 </tr>
 283 <tr>
 284 <td><p><a name="ATSPI-Collection-MATCH-ALL"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_ALL</code></span></p></td>
 285 <td>
 286 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if all of the criteria are met.
 287 </td>
 288 </tr>
 289 <tr>
 290 <td><p><a name="ATSPI-Collection-MATCH-ANY"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_ANY</code></span></p></td>
 291 <td>
 292 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if any of the criteria are met.
 293 </td>
 294 </tr>
 295 <tr>
 296 <td><p><a name="ATSPI-Collection-MATCH-NONE"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_NONE</code></span></p></td>
 297 <td>
 298 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if none of the criteria are met.
 299 </td>
 300 </tr>
 301 <tr>
 302 <td><p><a name="ATSPI-Collection-MATCH-EMPTY"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_EMPTY</code></span></p></td>
 303 <td>Same as <em class="parameter"><code>ATSPI_Collection_MATCH_ALL</code></em> if
 304 the criteria is non-empty; for empty criteria this rule requires returned
 305 value to also have empty set.
 306 </td>
 307 </tr>
 308 <tr>
 309 <td><p><a name="ATSPI-Collection-MATCH-LAST-DEFINED"></a><span class="term"><code class="literal">ATSPI_Collection_MATCH_LAST_DEFINED</code></span></p></td>
 310 <td>Used only to determine the end of the
 311 enumeration.
 312 </td>
 313 </tr>
 314 </tbody>
 315 </table></div>
 316 </div>
 317 <hr>
 318 <div class="refsect2">
 319 <a name="ATSPI-MATCHTYPES-COUNT:CAPS"></a><h3>ATSPI_MATCHTYPES_COUNT</h3>
 320 <pre class="programlisting">#define ATSPI_MATCHTYPES_COUNT (5+1)
 321 </pre>
 322 <p>
 323 </p>
 324 </div>
 325 <hr>
 326 <div class="refsect2">
 327 <a name="AtspiCollectionTreeTraversalType"></a><h3>enum AtspiCollectionTreeTraversalType</h3>
 328 <pre class="programlisting">typedef enum {
 329     ATSPI_Collection_TREE_RESTRICT_CHILDREN,
 330     ATSPI_Collection_TREE_RESTRICT_SIBLING,
 331     ATSPI_Collection_TREE_INORDER,
 332     ATSPI_Collection_TREE_LAST_DEFINED,
 333 } AtspiCollectionTreeTraversalType;
 334 </pre>
 335 <p>
 336 Enumeration used by interface <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to specify
 337 restrictions on <span class="type">AtspiAccesible</span> objects to be traversed.
 338 </p>
 339 <div class="variablelist"><table border="0" class="variablelist">
 340 <colgroup>
 341 <col align="left" valign="top">
 342 <col>
 343 </colgroup>
 344 <tbody>
 345 <tr>
 346 <td><p><a name="ATSPI-Collection-TREE-RESTRICT-CHILDREN"></a><span class="term"><code class="literal">ATSPI_Collection_TREE_RESTRICT_CHILDREN</code></span></p></td>
 347 <td></td>
 348 </tr>
 349 <tr>
 350 <td><p><a name="ATSPI-Collection-TREE-RESTRICT-SIBLING"></a><span class="term"><code class="literal">ATSPI_Collection_TREE_RESTRICT_SIBLING</code></span></p></td>
 351 <td></td>
 352 </tr>
 353 <tr>
 354 <td><p><a name="ATSPI-Collection-TREE-INORDER"></a><span class="term"><code class="literal">ATSPI_Collection_TREE_INORDER</code></span></p></td>
 355 <td></td>
 356 </tr>
 357 <tr>
 358 <td><p><a name="ATSPI-Collection-TREE-LAST-DEFINED"></a><span class="term"><code class="literal">ATSPI_Collection_TREE_LAST_DEFINED</code></span></p></td>
 359 <td></td>
 360 </tr>
 361 </tbody>
 362 </table></div>
 363 </div>
 364 <hr>
 365 <div class="refsect2">
 366 <a name="ATSPI-TREETRAVERSALTYPE:CAPS"></a><h3>ATSPI_TREETRAVERSALTYPE</h3>
 367 <pre class="programlisting">#define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)
 368 </pre>
 369 <p>
 370 </p>
 371 </div>
 372 <hr>
 373 <div class="refsect2">
 374 <a name="AtspiComponentLayer"></a><h3>enum AtspiComponentLayer</h3>
 375 <pre class="programlisting">typedef enum {
 376     ATSPI_LAYER_INVALID,
 377     ATSPI_LAYER_BACKGROUND,
 378     ATSPI_LAYER_CANVAS,
 379     ATSPI_LAYER_WIDGET,
 380     ATSPI_LAYER_MDI,
 381     ATSPI_LAYER_POPUP,
 382     ATSPI_LAYER_OVERLAY,
 383     ATSPI_LAYER_WINDOW,
 384     ATSPI_LAYER_LAST_DEFINED,
 385 } AtspiComponentLayer;
 386 </pre>
 387 <p>
 388 The <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a> of an <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> instance indicates its
 389 relative stacking order with respect to the onscreen visual representation
 390 of the UI. <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>, in combination with <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> bounds
 391 information, can be used to compute the visibility of all or part of a
 392 component.  This is important in programmatic determination of
 393 region-of-interest for magnification, and in
 394 flat screen review models of the screen, as well as
 395 for other uses. Objects residing in two of the <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>
 396 categories support further z-ordering information, with respect to their
 397 peers in the same layer: namely, <em class="parameter"><code>ATSPI_LAYER_WINDOW</code></em> and
 398 <em class="parameter"><code>ATSPI_LAYER_MDI</code></em>.  Relative stacking order for other objects within the
 399 same layer is not available; the recommended heuristic is
 400 first child paints first. In other words, assume that the
 401 first siblings in the child list are subject to being overpainted by later
 402 siblings if their bounds intersect. The order of layers, from bottom to top,
 403  is: <em class="parameter"><code>ATSPI_LAYER_BACKGROUND</code></em>, <em class="parameter"><code>ATSPI_LAYER_WINDOW</code></em>, <em class="parameter"><code>ATSPI_LAYER_MDI</code></em>,
 404 <em class="parameter"><code>ATSPI_LAYER_CANVAS</code></em>, <em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>, <em class="parameter"><code>ATSPI_LAYER_POPUP</code></em>, and
 405 <em class="parameter"><code>ATSPI_LAYER_OVERLAY</code></em>.
 406 </p>
 407 <div class="variablelist"><table border="0" class="variablelist">
 408 <colgroup>
 409 <col align="left" valign="top">
 410 <col>
 411 </colgroup>
 412 <tbody>
 413 <tr>
 414 <td><p><a name="ATSPI-LAYER-INVALID:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_INVALID</code></span></p></td>
 415 <td>Indicates an error condition or uninitialized value.
 416 </td>
 417 </tr>
 418 <tr>
 419 <td><p><a name="ATSPI-LAYER-BACKGROUND:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_BACKGROUND</code></span></p></td>
 420 <td>The bottom-most layer, over which everything else
 421 is painted.        The 'desktop background' is generally in this layer.
 422 </td>
 423 </tr>
 424 <tr>
 425 <td><p><a name="ATSPI-LAYER-CANVAS:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_CANVAS</code></span></p></td>
 426 <td>The 'background' layer for most content renderers and
 427 UI <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> containers.
 428 </td>
 429 </tr>
 430 <tr>
 431 <td><p><a name="ATSPI-LAYER-WIDGET:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_WIDGET</code></span></p></td>
 432 <td>The layer in which the majority of ordinary
 433 'foreground' widgets reside.
 434 </td>
 435 </tr>
 436 <tr>
 437 <td><p><a name="ATSPI-LAYER-MDI:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_MDI</code></span></p></td>
 438 <td>A special layer between <em class="parameter"><code>ATSPI_LAYER_CANVAS</code></em> and
 439 <em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>, in which the 'pseudo windows' (e.g. the MDI frames)
 440 reside. See <a class="link" href="libatspi-atspi-component.html#atspi-component-get-mdi-z-order" title="atspi_component_get_mdi_z_order ()"><span class="type">atspi_component_get_mdi_z_order</span></a>.
 441 </td>
 442 </tr>
 443 <tr>
 444 <td><p><a name="ATSPI-LAYER-POPUP:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_POPUP</code></span></p></td>
 445 <td>A layer for popup window content, above
 446 <em class="parameter"><code>ATSPI_LAYER_WIDGET</code></em>.
 447 </td>
 448 </tr>
 449 <tr>
 450 <td><p><a name="ATSPI-LAYER-OVERLAY:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_OVERLAY</code></span></p></td>
 451 <td>The topmost layer.
 452 </td>
 453 </tr>
 454 <tr>
 455 <td><p><a name="ATSPI-LAYER-WINDOW:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_WINDOW</code></span></p></td>
 456 <td>The layer in which a toplevel window background usually
 457 resides.
 458 </td>
 459 </tr>
 460 <tr>
 461 <td><p><a name="ATSPI-LAYER-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATSPI_LAYER_LAST_DEFINED</code></span></p></td>
 462 <td>Used only to determine the end of the
 463 enumeration.
 464 </td>
 465 </tr>
 466 </tbody>
 467 </table></div>
 468 </div>
 469 <hr>
 470 <div class="refsect2">
 471 <a name="ATSPI-COMPONENTLAYER-COUNT:CAPS"></a><h3>ATSPI_COMPONENTLAYER_COUNT</h3>
 472 <pre class="programlisting">#define ATSPI_COMPONENTLAYER_COUNT (8+1)
 473 </pre>
 474 <p>
 475 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a>.
 476 </p>
 477 </div>
 478 <hr>
 479 <div class="refsect2">
 480 <a name="AtspiTextBoundaryType"></a><h3>enum AtspiTextBoundaryType</h3>
 481 <pre class="programlisting">typedef enum {
 482     ATSPI_TEXT_BOUNDARY_CHAR,
 483     ATSPI_TEXT_BOUNDARY_WORD_START,
 484     ATSPI_TEXT_BOUNDARY_WORD_END,
 485     ATSPI_TEXT_BOUNDARY_SENTENCE_START,
 486     ATSPI_TEXT_BOUNDARY_SENTENCE_END,
 487     ATSPI_TEXT_BOUNDARY_LINE_START,
 488     ATSPI_TEXT_BOUNDARY_LINE_END,
 489 } AtspiTextBoundaryType;
 490 </pre>
 491 <p>
 492 Specifies the boundary conditions determining a run of text as returned from
 493 <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-at-offset" title="atspi_text_get_text_at_offset ()"><span class="type">atspi_text_get_text_at_offset</span></a>, <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-after-offset" title="atspi_text_get_text_after_offset ()"><span class="type">atspi_text_get_text_after_offset</span></a>, and
 494 <a class="link" href="libatspi-atspi-text.html#atspi-text-get-text-before-offset" title="atspi_text_get_text_before_offset ()"><span class="type">atspi_text_get_text_before_offset</span></a>.
 495 </p>
 496 <div class="variablelist"><table border="0" class="variablelist">
 497 <colgroup>
 498 <col align="left" valign="top">
 499 <col>
 500 </colgroup>
 501 <tbody>
 502 <tr>
 503 <td><p><a name="ATSPI-TEXT-BOUNDARY-CHAR:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_CHAR</code></span></p></td>
 504 <td>An <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> instance is bounded by this
 505 character only. Start and end offsets differ by one, by definition,
 506 for this value.
 507 </td>
 508 </tr>
 509 <tr>
 510 <td><p><a name="ATSPI-TEXT-BOUNDARY-WORD-START:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_WORD_START</code></span></p></td>
 511 <td>Boundary condition is start of a word; i.e.
 512 range is from start of one word to the start of another word.
 513 </td>
 514 </tr>
 515 <tr>
 516 <td><p><a name="ATSPI-TEXT-BOUNDARY-WORD-END:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_WORD_END</code></span></p></td>
 517 <td>Boundary condition is the end of a word; i.e.
 518 range is from the end of one word to the end of another. Some locales
 519 may not distinguish between words and characters or glyphs. In particular,
 520 those locales which use wholly or partially ideographic character sets.
 521 In these cases, characters may be returned in lieu of multi-character
 522 substrings.
 523 </td>
 524 </tr>
 525 <tr>
 526 <td><p><a name="ATSPI-TEXT-BOUNDARY-SENTENCE-START:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_SENTENCE_START</code></span></p></td>
 527 <td>Boundary condition is start of a
 528 sentence, as determined by the application. Some locales or
 529 character sets may not include explicit sentence delimiters, so this
 530 boundary type can not always be honored. Some locales will return lines
 531 of text instead of grammatical sentences.
 532 </td>
 533 </tr>
 534 <tr>
 535 <td><p><a name="ATSPI-TEXT-BOUNDARY-SENTENCE-END:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_SENTENCE_END</code></span></p></td>
 536 <td>Boundary condition is end of a sentence,
 537 as determined by the application, including the sentence-delimiting
 538 character, for instance '.' Some locales or character sets may not
 539 include explicit sentence delimiters, so this boundary type can not
 540 always be honored. Some locales will return lines of text instead of
 541 grammatical sentences.
 542 </td>
 543 </tr>
 544 <tr>
 545 <td><p><a name="ATSPI-TEXT-BOUNDARY-LINE-START:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_LINE_START</code></span></p></td>
 546 <td>Boundary condition is the start of a line;
 547 i.e. range is from start of one line to the start of another.  This
 548 generally means that an end-of-line character will appear at the end of
 549 the range.
 550 </td>
 551 </tr>
 552 <tr>
 553 <td><p><a name="ATSPI-TEXT-BOUNDARY-LINE-END:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_BOUNDARY_LINE_END</code></span></p></td>
 554 <td>Boundary condition is the end of a line; i.e.
 555 range is from start of one line to the start of another.  This generally
 556 means that an end-of-line character will be the first character of the
 557 range.
 558 </td>
 559 </tr>
 560 </tbody>
 561 </table></div>
 562 </div>
 563 <hr>
 564 <div class="refsect2">
 565 <a name="ATSPI-TEXT-BOUNDARY-TYPE-COUNT:CAPS"></a><h3>ATSPI_TEXT_BOUNDARY_TYPE_COUNT</h3>
 566 <pre class="programlisting">#define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
 567 </pre>
 568 <p>
 569 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiTextBoundaryType" title="enum AtspiTextBoundaryType"><span class="type">AtspiTextBoundaryType</span></a>.
 570 </p>
 571 </div>
 572 <hr>
 573 <div class="refsect2">
 574 <a name="AtspiTextClipType"></a><h3>enum AtspiTextClipType</h3>
 575 <pre class="programlisting">typedef enum {
 576     ATSPI_TEXT_CLIP_NONE,
 577     ATSPI_TEXT_CLIP_MIN,
 578     ATSPI_TEXT_CLIP_MAX,
 579     ATSPI_TEXT_CLIP_BOTH,
 580 } AtspiTextClipType;
 581 </pre>
 582 <p>
 583 Enumeration used by interface <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> to indicate
 584 how to treat characters intersecting bounding boxes.
 585 </p>
 586 <div class="variablelist"><table border="0" class="variablelist">
 587 <colgroup>
 588 <col align="left" valign="top">
 589 <col>
 590 </colgroup>
 591 <tbody>
 592 <tr>
 593 <td><p><a name="ATSPI-TEXT-CLIP-NONE:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_CLIP_NONE</code></span></p></td>
 594 <td>No characters/glyphs are omitted.
 595 </td>
 596 </tr>
 597 <tr>
 598 <td><p><a name="ATSPI-TEXT-CLIP-MIN:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_CLIP_MIN</code></span></p></td>
 599 <td>Characters/glyphs clipped by the minimum coordinate
 600 are omitted.
 601 </td>
 602 </tr>
 603 <tr>
 604 <td><p><a name="ATSPI-TEXT-CLIP-MAX:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_CLIP_MAX</code></span></p></td>
 605 <td>Characters/glyphs which intersect the maximum
 606 coordinate are omitted.
 607 </td>
 608 </tr>
 609 <tr>
 610 <td><p><a name="ATSPI-TEXT-CLIP-BOTH:CAPS"></a><span class="term"><code class="literal">ATSPI_TEXT_CLIP_BOTH</code></span></p></td>
 611 <td>Only glyphs falling entirely within the region
 612 bounded by min and max are retained.
 613 </td>
 614 </tr>
 615 </tbody>
 616 </table></div>
 617 </div>
 618 <hr>
 619 <div class="refsect2">
 620 <a name="ATSPI-TEXT-CLIP-TYPE-COUNT:CAPS"></a><h3>ATSPI_TEXT_CLIP_TYPE_COUNT</h3>
 621 <pre class="programlisting">#define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)
 622 </pre>
 623 <p>
 624 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiTextClipType" title="enum AtspiTextClipType"><span class="type">AtspiTextClipType</span></a>.
 625 </p>
 626 </div>
 627 <hr>
 628 <div class="refsect2">
 629 <a name="AtspiStateType"></a><h3>enum AtspiStateType</h3>
 630 <pre class="programlisting">typedef enum {
 631     ATSPI_STATE_INVALID,
 632     ATSPI_STATE_ACTIVE,
 633     ATSPI_STATE_ARMED,
 634     ATSPI_STATE_BUSY,
 635     ATSPI_STATE_CHECKED,
 636     ATSPI_STATE_COLLAPSED,
 637     ATSPI_STATE_DEFUNCT,
 638     ATSPI_STATE_EDITABLE,
 639     ATSPI_STATE_ENABLED,
 640     ATSPI_STATE_EXPANDABLE,
 641     ATSPI_STATE_EXPANDED,
 642     ATSPI_STATE_FOCUSABLE,
 643     ATSPI_STATE_FOCUSED,
 644     ATSPI_STATE_HAS_TOOLTIP,
 645     ATSPI_STATE_HORIZONTAL,
 646     ATSPI_STATE_ICONIFIED,
 647     ATSPI_STATE_MODAL,
 648     ATSPI_STATE_MULTI_LINE,
 649     ATSPI_STATE_MULTISELECTABLE,
 650     ATSPI_STATE_OPAQUE,
 651     ATSPI_STATE_PRESSED,
 652     ATSPI_STATE_RESIZABLE,
 653     ATSPI_STATE_SELECTABLE,
 654     ATSPI_STATE_SELECTED,
 655     ATSPI_STATE_SENSITIVE,
 656     ATSPI_STATE_SHOWING,
 657     ATSPI_STATE_SINGLE_LINE,
 658     ATSPI_STATE_STALE,
 659     ATSPI_STATE_TRANSIENT,
 660     ATSPI_STATE_VERTICAL,
 661     ATSPI_STATE_VISIBLE,
 662     ATSPI_STATE_MANAGES_DESCENDANTS,
 663     ATSPI_STATE_INDETERMINATE,
 664     ATSPI_STATE_REQUIRED,
 665     ATSPI_STATE_TRUNCATED,
 666     ATSPI_STATE_ANIMATED,
 667     ATSPI_STATE_INVALID_ENTRY,
 668     ATSPI_STATE_SUPPORTS_AUTOCOMPLETION,
 669     ATSPI_STATE_SELECTABLE_TEXT,
 670     ATSPI_STATE_IS_DEFAULT,
 671     ATSPI_STATE_VISITED,
 672     ATSPI_STATE_LAST_DEFINED,
 673 } AtspiStateType;
 674 </pre>
 675 <p>
 676 Enumeration used by various interfaces indicating every possible state
 677 an <span class="type">AtspiAccesible</span> object can assume.
 678 </p>
 679 <div class="variablelist"><table border="0" class="variablelist">
 680 <colgroup>
 681 <col align="left" valign="top">
 682 <col>
 683 </colgroup>
 684 <tbody>
 685 <tr>
 686 <td><p><a name="ATSPI-STATE-INVALID:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_INVALID</code></span></p></td>
 687 <td>Indicates an invalid state - probably an error
 688 condition.
 689 </td>
 690 </tr>
 691 <tr>
 692 <td><p><a name="ATSPI-STATE-ACTIVE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ACTIVE</code></span></p></td>
 693 <td>Indicates a window is currently the active window, or
 694 is an active subelement within a container or table.
 695 </td>
 696 </tr>
 697 <tr>
 698 <td><p><a name="ATSPI-STATE-ARMED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ARMED</code></span></p></td>
 699 <td>Indicates that the object is armed.
 700 </td>
 701 </tr>
 702 <tr>
 703 <td><p><a name="ATSPI-STATE-BUSY:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_BUSY</code></span></p></td>
 704 <td>Indicates the current object is busy, i.e. onscreen
 705 representation is in the process of changing, or       the object is
 706 temporarily unavailable for interaction due to activity already in progress.
 707 </td>
 708 </tr>
 709 <tr>
 710 <td><p><a name="ATSPI-STATE-CHECKED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_CHECKED</code></span></p></td>
 711 <td>Indicates this object is currently checked.
 712 </td>
 713 </tr>
 714 <tr>
 715 <td><p><a name="ATSPI-STATE-COLLAPSED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_COLLAPSED</code></span></p></td>
 716 <td>Indicates this object is collapsed.
 717 </td>
 718 </tr>
 719 <tr>
 720 <td><p><a name="ATSPI-STATE-DEFUNCT:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_DEFUNCT</code></span></p></td>
 721 <td>Indicates that this object no longer has a valid
 722 backing widget        (for instance, if its peer object has been destroyed).
 723 </td>
 724 </tr>
 725 <tr>
 726 <td><p><a name="ATSPI-STATE-EDITABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_EDITABLE</code></span></p></td>
 727 <td>Indicates the user can change the contents of this
 728 object.
 729 </td>
 730 </tr>
 731 <tr>
 732 <td><p><a name="ATSPI-STATE-ENABLED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ENABLED</code></span></p></td>
 733 <td>Indicates that this object is enabled, i.e. that it
 734 currently reflects some application state. Objects that are "greyed out"
 735 may lack this state, and may lack the <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em> if direct
 736 user interaction cannot cause them to acquire <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em>.
 737 See <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em>.
 738 </td>
 739 </tr>
 740 <tr>
 741 <td><p><a name="ATSPI-STATE-EXPANDABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_EXPANDABLE</code></span></p></td>
 742 <td>Indicates this object allows progressive
 743 disclosure of its children.
 744 </td>
 745 </tr>
 746 <tr>
 747 <td><p><a name="ATSPI-STATE-EXPANDED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_EXPANDED</code></span></p></td>
 748 <td>Indicates this object is expanded.
 749 </td>
 750 </tr>
 751 <tr>
 752 <td><p><a name="ATSPI-STATE-FOCUSABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_FOCUSABLE</code></span></p></td>
 753 <td>Indicates this object can accept keyboard focus,
 754 which means all       events resulting from typing on the keyboard will
 755 normally be passed       to it when it has focus.
 756 </td>
 757 </tr>
 758 <tr>
 759 <td><p><a name="ATSPI-STATE-FOCUSED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_FOCUSED</code></span></p></td>
 760 <td>Indicates this object currently has the keyboard
 761 focus.
 762 </td>
 763 </tr>
 764 <tr>
 765 <td><p><a name="ATSPI-STATE-HAS-TOOLTIP:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_HAS_TOOLTIP</code></span></p></td>
 766 <td>Indicates that the object has an associated
 767 tooltip.
 768 </td>
 769 </tr>
 770 <tr>
 771 <td><p><a name="ATSPI-STATE-HORIZONTAL:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_HORIZONTAL</code></span></p></td>
 772 <td>Indicates the orientation of this object is
 773 horizontal.
 774 </td>
 775 </tr>
 776 <tr>
 777 <td><p><a name="ATSPI-STATE-ICONIFIED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ICONIFIED</code></span></p></td>
 778 <td>Indicates this object is minimized and is
 779 represented only by an icon.
 780 </td>
 781 </tr>
 782 <tr>
 783 <td><p><a name="ATSPI-STATE-MODAL:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_MODAL</code></span></p></td>
 784 <td>Indicates something must be done with this object
 785 before the user can interact with an object in a different window.
 786 </td>
 787 </tr>
 788 <tr>
 789 <td><p><a name="ATSPI-STATE-MULTI-LINE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_MULTI_LINE</code></span></p></td>
 790 <td>Indicates this (text) object can contain multiple
 791 lines of text.
 792 </td>
 793 </tr>
 794 <tr>
 795 <td><p><a name="ATSPI-STATE-MULTISELECTABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_MULTISELECTABLE</code></span></p></td>
 796 <td>Indicates this object allows more than one of
 797 its children to be selected at the same time, or in the case of text
 798 objects, that the object supports non-contiguous text selections.
 799 </td>
 800 </tr>
 801 <tr>
 802 <td><p><a name="ATSPI-STATE-OPAQUE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_OPAQUE</code></span></p></td>
 803 <td>Indicates this object paints every pixel within its
 804 rectangular region. It also indicates an alpha value of unity, if it
 805 supports alpha blending.
 806 </td>
 807 </tr>
 808 <tr>
 809 <td><p><a name="ATSPI-STATE-PRESSED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_PRESSED</code></span></p></td>
 810 <td>Indicates this object is currently pressed.
 811 </td>
 812 </tr>
 813 <tr>
 814 <td><p><a name="ATSPI-STATE-RESIZABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_RESIZABLE</code></span></p></td>
 815 <td>Indicates the size of this object's size is not
 816 fixed.
 817 </td>
 818 </tr>
 819 <tr>
 820 <td><p><a name="ATSPI-STATE-SELECTABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SELECTABLE</code></span></p></td>
 821 <td>Indicates this object is the child of an object
 822 that allows its children to be selected and that this child is one of
 823 those children       that can be selected.
 824 </td>
 825 </tr>
 826 <tr>
 827 <td><p><a name="ATSPI-STATE-SELECTED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SELECTED</code></span></p></td>
 828 <td>Indicates this object is the child of an object that
 829 allows its children to be selected and that this child is one of those
 830 children that has been selected.
 831 </td>
 832 </tr>
 833 <tr>
 834 <td><p><a name="ATSPI-STATE-SENSITIVE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SENSITIVE</code></span></p></td>
 835 <td>Indicates this object is sensitive, e.g. to user
 836 interaction. <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em> usually accompanies.
 837 <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em> for user-actionable controls, but may be found in the
 838 absence of <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em> if the current visible state of the control
 839 is "disconnected" from the application state.  In such cases, direct user
 840 interaction can often result in the object gaining <em class="parameter"><code>ATSPI_STATE_SENSITIVE</code></em>,
 841 for instance if a user makes an explicit selection using an object whose
 842 current state is ambiguous or undefined. See <em class="parameter"><code>ATSPI_STATE_ENABLED</code></em>,
 843 <em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em>.
 844 </td>
 845 </tr>
 846 <tr>
 847 <td><p><a name="ATSPI-STATE-SHOWING:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SHOWING</code></span></p></td>
 848 <td>Indicates this object, the object's parent, the
 849 object's parent's parent, and so on, are all 'shown' to the end-user,
 850 i.e. subject to "exposure" if blocking or obscuring objects do not
 851 interpose between this object and the top of the window stack.
 852 </td>
 853 </tr>
 854 <tr>
 855 <td><p><a name="ATSPI-STATE-SINGLE-LINE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SINGLE_LINE</code></span></p></td>
 856 <td>Indicates this (text) object can contain only a
 857 single line of text.
 858 </td>
 859 </tr>
 860 <tr>
 861 <td><p><a name="ATSPI-STATE-STALE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_STALE</code></span></p></td>
 862 <td>Indicates that the information returned for this object
 863 may no longer be synchronized with the application state.  This can occur
 864 if the object has <em class="parameter"><code>ATSPI_STATE_TRANSIENT</code></em>, and can also occur towards the
 865 end of the object peer's lifecycle.
 866 </td>
 867 </tr>
 868 <tr>
 869 <td><p><a name="ATSPI-STATE-TRANSIENT:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_TRANSIENT</code></span></p></td>
 870 <td>Indicates this object is transient.
 871 </td>
 872 </tr>
 873 <tr>
 874 <td><p><a name="ATSPI-STATE-VERTICAL:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_VERTICAL</code></span></p></td>
 875 <td>Indicates the orientation of this object is vertical;
 876 for example this state may appear on such objects as scrollbars, text
 877 objects (with vertical text flow), separators, etc.
 878 </td>
 879 </tr>
 880 <tr>
 881 <td><p><a name="ATSPI-STATE-VISIBLE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_VISIBLE</code></span></p></td>
 882 <td>Indicates this object is visible, e.g. has been
 883 explicitly marked for exposure to the user. <em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em> is no
 884 guarantee that the object is actually unobscured on the screen, only that
 885 it is 'potentially' visible, barring obstruction, being scrolled or clipped
 886 out of the field of view, or having an ancestor container that has not yet
 887 made visible. A widget is potentially onscreen if it has both
 888 <em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em> and <em class="parameter"><code>ATSPI_STATE_SHOWING</code></em>. The absence of
 889 <em class="parameter"><code>ATSPI_STATE_VISIBLE</code></em> and <em class="parameter"><code>ATSPI_STATE_SHOWING</code></em> is
 890 semantically equivalent to saying that an object is 'hidden'.
 891 </td>
 892 </tr>
 893 <tr>
 894 <td><p><a name="ATSPI-STATE-MANAGES-DESCENDANTS:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_MANAGES_DESCENDANTS</code></span></p></td>
 895 <td>Indicates that "active-descendant-changed"
 896 event is sent when children become 'active' (i.e. are selected or
 897 navigated to onscreen).  Used to prevent need to enumerate all children
 898 in very large containers, like tables. The presence of
 899 <em class="parameter"><code>ATSPI_STATE_MANAGES_DESCENDANTS</code></em> is an indication to the client that the
 900 children should not, and need not, be enumerated by the client.
 901 Objects implementing this state are expected to provide relevant state
 902 notifications to listening clients, for instance notifications of
 903 visibility changes and activation of their contained child objects, without
 904 the client having previously requested references to those children.
 905 </td>
 906 </tr>
 907 <tr>
 908 <td><p><a name="ATSPI-STATE-INDETERMINATE:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_INDETERMINATE</code></span></p></td>
 909 <td>Indicates that a check box or other boolean
 910 indicator is in a state other than checked or not checked.  This
 911 usually means that the boolean value reflected or controlled by the
 912 object does not apply consistently to the entire current context.
 913 For example, a checkbox for the "Bold" attribute of text may have
 914 <em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em> if the currently selected text contains a mixture
 915 of weight attributes. In many cases interacting with a
 916 <em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em> object will cause the context's corresponding
 917 boolean attribute to be homogenized, whereupon the object will lose
 918 <em class="parameter"><code>ATSPI_STATE_INDETERMINATE</code></em> and a corresponding state-changed event will be
 919 fired.
 920 </td>
 921 </tr>
 922 <tr>
 923 <td><p><a name="ATSPI-STATE-REQUIRED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_REQUIRED</code></span></p></td>
 924 <td>Indicates that user interaction with this object is
 925 'required' from the user, for instance before completing the
 926 processing of a form.
 927 </td>
 928 </tr>
 929 <tr>
 930 <td><p><a name="ATSPI-STATE-TRUNCATED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_TRUNCATED</code></span></p></td>
 931 <td>Indicates that an object's onscreen content
 932 is truncated, e.g. a text value in a spreadsheet cell.
 933 </td>
 934 </tr>
 935 <tr>
 936 <td><p><a name="ATSPI-STATE-ANIMATED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_ANIMATED</code></span></p></td>
 937 <td>Indicates this object's visual representation is
 938 dynamic, not static. This state may be applied to an object during an
 939 animated 'effect' and be removed from the object once its visual
 940 representation becomes static. Some applications, notably content viewers,
 941 may not be able to detect all kinds of animated content.  Therefore the
 942 absence of this state should not be taken as
 943 definitive evidence that the object's visual representation is
 944 static; this state is advisory.
 945 </td>
 946 </tr>
 947 <tr>
 948 <td><p><a name="ATSPI-STATE-INVALID-ENTRY:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_INVALID_ENTRY</code></span></p></td>
 949 <td>This object has indicated an error condition
 950 due to failure of input validation.  For instance, a form control may
 951 acquire this state in response to invalid or malformed user input.
 952 </td>
 953 </tr>
 954 <tr>
 955 <td><p><a name="ATSPI-STATE-SUPPORTS-AUTOCOMPLETION:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SUPPORTS_AUTOCOMPLETION</code></span></p></td>
 956 <td>This state indicates that the object
 957 in question implements some form of typeahead or
 958 pre-selection behavior whereby entering the first character of one or more
 959 sub-elements causes those elements to scroll into view or become
 960 selected. Subsequent character input may narrow the selection further as
 961 long as one or more sub-elements match the string. This state is normally
 962 only useful and encountered on objects that implement <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>.
 963 In some cases the typeahead behavior may result in full or partial
 964 completion of the data in the input field, in which case
 965 these input events may trigger text-changed events from the source.
 966 </td>
 967 </tr>
 968 <tr>
 969 <td><p><a name="ATSPI-STATE-SELECTABLE-TEXT:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_SELECTABLE_TEXT</code></span></p></td>
 970 <td>This state indicates that the object in
 971 question supports text selection. It should only be exposed on objects
 972 which implement the <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> interface, in order to distinguish this state
 973 from <em class="parameter"><code>ATSPI_STATE_SELECTABLE</code></em>, which infers that the object in question is a
 974 selectable child of an object which implements <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>. While
 975 similar, text selection and subelement selection are distinct operations.
 976 </td>
 977 </tr>
 978 <tr>
 979 <td><p><a name="ATSPI-STATE-IS-DEFAULT:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_IS_DEFAULT</code></span></p></td>
 980 <td>This state indicates that the object in question is
 981 the 'default' interaction object in a dialog, i.e. the one that gets
 982 activated if the user presses "Enter" when the dialog is initially
 983 posted.
 984 </td>
 985 </tr>
 986 <tr>
 987 <td><p><a name="ATSPI-STATE-VISITED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_VISITED</code></span></p></td>
 988 <td>This state indicates that the object (typically a
 989 hyperlink) has already been activated or invoked, with the result that
 990 some backing data has been downloaded or rendered.
 991 </td>
 992 </tr>
 993 <tr>
 994 <td><p><a name="ATSPI-STATE-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATSPI_STATE_LAST_DEFINED</code></span></p></td>
 995 <td>This value of the enumeration should not be used
 996 as a parameter, it indicates the number of items in the <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a>
 997 enumeration.
 998 </td>
 999 </tr>
1000 </tbody>
1001 </table></div>
1002 </div>
1003 <hr>
1004 <div class="refsect2">
1005 <a name="ATSPI-STATETYPE-COUNT:CAPS"></a><h3>ATSPI_STATETYPE_COUNT</h3>
1006 <pre class="programlisting">#define ATSPI_STATETYPE_COUNT (41+1)
1007 </pre>
1008 <p>
1009 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a>.
1010 </p>
1011 </div>
1012 <hr>
1013 <div class="refsect2">
1014 <a name="AtspiKeyEventType"></a><h3>enum AtspiKeyEventType</h3>
1015 <pre class="programlisting">typedef enum {
1016     ATSPI_KEY_PRESSED,
1017     ATSPI_KEY_RELEASED,
1018 } AtspiKeyEventType;
1019 </pre>
1020 <p>
1021 Deprecated. Should not be used.
1022 </p>
1023 <div class="variablelist"><table border="0" class="variablelist">
1024 <colgroup>
1025 <col align="left" valign="top">
1026 <col>
1027 </colgroup>
1028 <tbody>
1029 <tr>
1030 <td><p><a name="ATSPI-KEY-PRESSED:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_PRESSED</code></span></p></td>
1031 <td></td>
1032 </tr>
1033 <tr>
1034 <td><p><a name="ATSPI-KEY-RELEASED:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_RELEASED</code></span></p></td>
1035 <td></td>
1036 </tr>
1037 </tbody>
1038 </table></div>
1039 </div>
1040 <hr>
1041 <div class="refsect2">
1042 <a name="ATSPI-KEYEVENTTYPE-COUNT:CAPS"></a><h3>ATSPI_KEYEVENTTYPE_COUNT</h3>
1043 <pre class="programlisting">#define ATSPI_KEYEVENTTYPE_COUNT (1+1)
1044 </pre>
1045 <p>
1046 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiKeyEventType" title="enum AtspiKeyEventType"><span class="type">AtspiKeyEventType</span></a>.
1047 </p>
1048 </div>
1049 <hr>
1050 <div class="refsect2">
1051 <a name="AtspiEventType"></a><h3>enum AtspiEventType</h3>
1052 <pre class="programlisting">typedef enum {
1053     ATSPI_KEY_PRESSED_EVENT,
1054     ATSPI_KEY_RELEASED_EVENT,
1055     ATSPI_BUTTON_PRESSED_EVENT,
1056     ATSPI_BUTTON_RELEASED_EVENT,
1057 } AtspiEventType;
1058 </pre>
1059 <p>
1060 Enumeration used to specify the event types of interest to an
1061 <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a>, or
1062 to identify the type of an event for which notification has been sent.
1063 </p>
1064 <div class="variablelist"><table border="0" class="variablelist">
1065 <colgroup>
1066 <col align="left" valign="top">
1067 <col>
1068 </colgroup>
1069 <tbody>
1070 <tr>
1071 <td><p><a name="ATSPI-KEY-PRESSED-EVENT:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_PRESSED_EVENT</code></span></p></td>
1072 <td>Indicates that a key on a keyboard device was
1073 pressed.
1074 </td>
1075 </tr>
1076 <tr>
1077 <td><p><a name="ATSPI-KEY-RELEASED-EVENT:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_RELEASED_EVENT</code></span></p></td>
1078 <td>Indicates that a key on a keyboard device was
1079 released.
1080 </td>
1081 </tr>
1082 <tr>
1083 <td><p><a name="ATSPI-BUTTON-PRESSED-EVENT:CAPS"></a><span class="term"><code class="literal">ATSPI_BUTTON_PRESSED_EVENT</code></span></p></td>
1084 <td>Indicates that a button on a non-keyboard
1085 human interface device (HID) was pressed.
1086 </td>
1087 </tr>
1088 <tr>
1089 <td><p><a name="ATSPI-BUTTON-RELEASED-EVENT:CAPS"></a><span class="term"><code class="literal">ATSPI_BUTTON_RELEASED_EVENT</code></span></p></td>
1090 <td>Indicates that a button on a non-keyboard
1091 human interface device (HID) was released.
1092 </td>
1093 </tr>
1094 </tbody>
1095 </table></div>
1096 </div>
1097 <hr>
1098 <div class="refsect2">
1099 <a name="ATSPI-EVENTTYPE-COUNT:CAPS"></a><h3>ATSPI_EVENTTYPE_COUNT</h3>
1100 <pre class="programlisting">#define ATSPI_EVENTTYPE_COUNT (3+1)
1101 </pre>
1102 <p>
1103 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiEventType" title="enum AtspiEventType"><span class="type">AtspiEventType</span></a>.
1104 </p>
1105 </div>
1106 <hr>
1107 <div class="refsect2">
1108 <a name="AtspiKeySynthType"></a><h3>enum AtspiKeySynthType</h3>
1109 <pre class="programlisting">typedef enum {
1110     ATSPI_KEY_PRESS,
1111     ATSPI_KEY_RELEASE,
1112     ATSPI_KEY_PRESSRELEASE,
1113     ATSPI_KEY_SYM,
1114     ATSPI_KEY_STRING,
1115 } AtspiKeySynthType;
1116 </pre>
1117 <p>
1118 Enumeration used when synthesizing keyboard input via
1119 <a class="link" href="libatspi-atspi-registry.html#atspi-generate-keyboard-event" title="atspi_generate_keyboard_event ()"><span class="type">atspi_generate_keyboard_event</span></a>.
1120 </p>
1121 <div class="variablelist"><table border="0" class="variablelist">
1122 <colgroup>
1123 <col align="left" valign="top">
1124 <col>
1125 </colgroup>
1126 <tbody>
1127 <tr>
1128 <td><p><a name="ATSPI-KEY-PRESS:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_PRESS</code></span></p></td>
1129 <td>Emulates the pressing of a hardware keyboard key.
1130 </td>
1131 </tr>
1132 <tr>
1133 <td><p><a name="ATSPI-KEY-RELEASE:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_RELEASE</code></span></p></td>
1134 <td>Emulates the release of a hardware keyboard key.
1135 </td>
1136 </tr>
1137 <tr>
1138 <td><p><a name="ATSPI-KEY-PRESSRELEASE:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_PRESSRELEASE</code></span></p></td>
1139 <td>Emulates the pressing and immediate releasing
1140 of a hardware keyboard key.
1141 </td>
1142 </tr>
1143 <tr>
1144 <td><p><a name="ATSPI-KEY-SYM:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_SYM</code></span></p></td>
1145 <td>A symbolic key event is generated, without specifying a
1146 hardware key. Note: if the keysym is not present in the current keyboard
1147 map, the <span class="type">AtspiDeviceEventController</span> instance has a limited ability to
1148 generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent
1149 calls using out-of-keymap keysyms will vary from system to system, and on
1150 the number of different out-of-keymap keysyms being generated in quick
1151 succession.
1152 In practice this is rarely significant, since the keysyms of interest to
1153 AT clients and keyboard emulators are usually part of the current keymap,
1154 i.e., present on the system keyboard for the current locale (even if a
1155 physical hardware keyboard is not connected).
1156 </td>
1157 </tr>
1158 <tr>
1159 <td><p><a name="ATSPI-KEY-STRING:CAPS"></a><span class="term"><code class="literal">ATSPI_KEY_STRING</code></span></p></td>
1160 <td>A string is converted to its equivalent keyboard events
1161 and emitted. If the string consists of complex characters or composed
1162 characters which are not in the current keymap, string emission is
1163 subject to the out-of-keymap limitations described for
1164 <em class="parameter"><code>ATSPI_KEY_SYM</code></em>. In practice this limitation primarily effects
1165 Chinese and Japanese locales.
1166 </td>
1167 </tr>
1168 </tbody>
1169 </table></div>
1170 </div>
1171 <hr>
1172 <div class="refsect2">
1173 <a name="ATSPI-KEYSYNTHTYPE-COUNT:CAPS"></a><h3>ATSPI_KEYSYNTHTYPE_COUNT</h3>
1174 <pre class="programlisting">#define ATSPI_KEYSYNTHTYPE_COUNT (4+1)
1175 </pre>
1176 <p>
1177 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType"><span class="type">AtspiKeySynthType</span></a>.
1178 </p>
1179 </div>
1180 <hr>
1181 <div class="refsect2">
1182 <a name="AtspiModifierType"></a><h3>enum AtspiModifierType</h3>
1183 <pre class="programlisting">typedef enum {
1184     ATSPI_MODIFIER_SHIFT,
1185     ATSPI_MODIFIER_SHIFTLOCK,
1186     ATSPI_MODIFIER_CONTROL,
1187     ATSPI_MODIFIER_ALT,
1188     ATSPI_MODIFIER_META,
1189     ATSPI_MODIFIER_META2,
1190     ATSPI_MODIFIER_META3,
1191     ATSPI_MODIFIER_NUMLOCK = 14,
1192 } AtspiModifierType;
1193 </pre>
1194 <div class="variablelist"><table border="0" class="variablelist">
1195 <colgroup>
1196 <col align="left" valign="top">
1197 <col>
1198 </colgroup>
1199 <tbody>
1200 <tr>
1201 <td><p><a name="ATSPI-MODIFIER-SHIFT:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_SHIFT</code></span></p></td>
1202 <td>The left or right 'Shift' key.
1203 </td>
1204 </tr>
1205 <tr>
1206 <td><p><a name="ATSPI-MODIFIER-SHIFTLOCK:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_SHIFTLOCK</code></span></p></td>
1207 <td>The ShiftLock or CapsLock key.
1208 </td>
1209 </tr>
1210 <tr>
1211 <td><p><a name="ATSPI-MODIFIER-CONTROL:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_CONTROL</code></span></p></td>
1212 <td>'Control'/'Ctrl'.
1213 </td>
1214 </tr>
1215 <tr>
1216 <td><p><a name="ATSPI-MODIFIER-ALT:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_ALT</code></span></p></td>
1217 <td>The Alt key (as opposed to AltGr).
1218 </td>
1219 </tr>
1220 <tr>
1221 <td><p><a name="ATSPI-MODIFIER-META:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_META</code></span></p></td>
1222 <td>Depending on the platform, this may map to 'Window',
1223 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
1224 map to one of META, META2, META3. On X Windows platforms these META
1225 values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
1226 event having <em class="parameter"><code>ATSPI_MODIFIER_META2</code></em> means that the 'Mod2Mask' bit
1227 is set in the corresponding XEvent.
1228 </td>
1229 </tr>
1230 <tr>
1231 <td><p><a name="ATSPI-MODIFIER-META2:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_META2</code></span></p></td>
1232 <td>See <em class="parameter"><code>ATSPI_MODIFIER_META</code></em>.
1233 </td>
1234 </tr>
1235 <tr>
1236 <td><p><a name="ATSPI-MODIFIER-META3:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_META3</code></span></p></td>
1237 <td>See <em class="parameter"><code>ATSPI_MODIFIER_META</code></em>.
1238 </td>
1239 </tr>
1240 <tr>
1241 <td><p><a name="ATSPI-MODIFIER-NUMLOCK:CAPS"></a><span class="term"><code class="literal">ATSPI_MODIFIER_NUMLOCK</code></span></p></td>
1242 <td>A symbolic meta key name that is mapped by AT-SPI
1243 to the appropriate META value, for the convenience of the client.
1244 </td>
1245 </tr>
1246 </tbody>
1247 </table></div>
1248 </div>
1249 <hr>
1250 <div class="refsect2">
1251 <a name="ATSPI-MODIFIERTYPE-COUNT:CAPS"></a><h3>ATSPI_MODIFIERTYPE_COUNT</h3>
1252 <pre class="programlisting">#define ATSPI_MODIFIERTYPE_COUNT (7+1)
1253 </pre>
1254 <p>
1255 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiModifierType" title="enum AtspiModifierType"><span class="type">AtspiModifierType</span></a>.
1256 </p>
1257 </div>
1258 <hr>
1259 <div class="refsect2">
1260 <a name="AtspiRelationType"></a><h3>enum AtspiRelationType</h3>
1261 <pre class="programlisting">typedef enum {
1262     ATSPI_RELATION_NULL,
1263     ATSPI_RELATION_LABEL_FOR,
1264     ATSPI_RELATION_LABELLED_BY,
1265     ATSPI_RELATION_CONTROLLER_FOR,
1266     ATSPI_RELATION_CONTROLLED_BY,
1267     ATSPI_RELATION_MEMBER_OF,
1268     ATSPI_RELATION_TOOLTIP_FOR,
1269     ATSPI_RELATION_NODE_CHILD_OF,
1270     ATSPI_RELATION_NODE_PARENT_OF,
1271     ATSPI_RELATION_EXTENDED,
1272     ATSPI_RELATION_FLOWS_TO,
1273     ATSPI_RELATION_FLOWS_FROM,
1274     ATSPI_RELATION_SUBWINDOW_OF,
1275     ATSPI_RELATION_EMBEDS,
1276     ATSPI_RELATION_EMBEDDED_BY,
1277     ATSPI_RELATION_POPUP_FOR,
1278     ATSPI_RELATION_PARENT_WINDOW_OF,
1279     ATSPI_RELATION_DESCRIPTION_FOR,
1280     ATSPI_RELATION_DESCRIBED_BY,
1281     ATSPI_RELATION_LAST_DEFINED,
1282 } AtspiRelationType;
1283 </pre>
1284 <p>
1285 <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> specifies a relationship between objects
1286 (possibly one-to-many
1287 or many-to-one) outside of the normal parent/child hierarchical
1288 relationship. It allows better semantic       identification of how objects
1289 are associated with one another.       For instance the
1290 <em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em>
1291 relationship may be used to identify labelling information       that should
1292 accompany the accessible name property when presenting an object's content or
1293 identity       to the end user.  Similarly,
1294 <em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em> can be used
1295 to further specify the context in which a valuator is useful, and/or the
1296 other UI components which are directly effected by user interactions with
1297 the valuator. Common examples include association of scrollbars with the
1298 viewport or panel which they control.
1299 </p>
1300 <p>
1301 Enumeration used to specify
1302 the type of relation encapsulated in an <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object.
1303 </p>
1304 <div class="variablelist"><table border="0" class="variablelist">
1305 <colgroup>
1306 <col align="left" valign="top">
1307 <col>
1308 </colgroup>
1309 <tbody>
1310 <tr>
1311 <td><p><a name="ATSPI-RELATION-NULL:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_NULL</code></span></p></td>
1312 <td>Not a meaningful relationship; clients should not
1313 normally encounter this <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> value.
1314 </td>
1315 </tr>
1316 <tr>
1317 <td><p><a name="ATSPI-RELATION-LABEL-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_LABEL_FOR</code></span></p></td>
1318 <td>Object is a label for one or more other objects.
1319 </td>
1320 </tr>
1321 <tr>
1322 <td><p><a name="ATSPI-RELATION-LABELLED-BY:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_LABELLED_BY</code></span></p></td>
1323 <td>Object is labelled by one or more other
1324 objects.
1325 </td>
1326 </tr>
1327 <tr>
1328 <td><p><a name="ATSPI-RELATION-CONTROLLER-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_CONTROLLER_FOR</code></span></p></td>
1329 <td>Object is an interactive object which
1330 modifies the state, onscreen location, or other attributes of one or more
1331 target objects.
1332 </td>
1333 </tr>
1334 <tr>
1335 <td><p><a name="ATSPI-RELATION-CONTROLLED-BY:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_CONTROLLED_BY</code></span></p></td>
1336 <td>Object state, position, etc. is
1337 modified/controlled by user interaction with one or more other objects.
1338 For instance a viewport or scroll pane may be <em class="parameter"><code>ATSPI_RELATION_CONTROLLED_BY</code></em>
1339 scrollbars.
1340 </td>
1341 </tr>
1342 <tr>
1343 <td><p><a name="ATSPI-RELATION-MEMBER-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_MEMBER_OF</code></span></p></td>
1344 <td>Object has a grouping relationship (e.g. 'same
1345 group as') to one or more other objects.
1346 </td>
1347 </tr>
1348 <tr>
1349 <td><p><a name="ATSPI-RELATION-TOOLTIP-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_TOOLTIP_FOR</code></span></p></td>
1350 <td>Object is a tooltip associated with another
1351 object.
1352 </td>
1353 </tr>
1354 <tr>
1355 <td><p><a name="ATSPI-RELATION-NODE-CHILD-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_NODE_CHILD_OF</code></span></p></td>
1356 <td>Object is a child of the target.
1357 </td>
1358 </tr>
1359 <tr>
1360 <td><p><a name="ATSPI-RELATION-NODE-PARENT-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_NODE_PARENT_OF</code></span></p></td>
1361 <td>Object is a parent of the target.
1362 </td>
1363 </tr>
1364 <tr>
1365 <td><p><a name="ATSPI-RELATION-EXTENDED:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_EXTENDED</code></span></p></td>
1366 <td>Used to indicate that a relationship exists, but
1367 its type is not specified in the enumeration.
1368 </td>
1369 </tr>
1370 <tr>
1371 <td><p><a name="ATSPI-RELATION-FLOWS-TO:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_FLOWS_TO</code></span></p></td>
1372 <td>Object renders content which flows logically to
1373 another object. For instance, text in a paragraph may flow to another
1374 object which is not the 'next sibling' in the accessibility hierarchy.
1375 </td>
1376 </tr>
1377 <tr>
1378 <td><p><a name="ATSPI-RELATION-FLOWS-FROM:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_FLOWS_FROM</code></span></p></td>
1379 <td>Reciprocal of <em class="parameter"><code>ATSPI_RELATION_FLOWS_TO</code></em>.
1380 </td>
1381 </tr>
1382 <tr>
1383 <td><p><a name="ATSPI-RELATION-SUBWINDOW-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_SUBWINDOW_OF</code></span></p></td>
1384 <td>Object is visually and semantically considered
1385 a subwindow of another object, even though it is not the object's child.
1386 Useful when dealing with embedded applications and other cases where the
1387 widget hierarchy does not map cleanly to the onscreen presentation.
1388 </td>
1389 </tr>
1390 <tr>
1391 <td><p><a name="ATSPI-RELATION-EMBEDS:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_EMBEDS</code></span></p></td>
1392 <td>Similar to <em class="parameter"><code>ATSPI_RELATION_SUBWINDOW_OF</code></em>, but
1393 specifically used for cross-process embedding.
1394 </td>
1395 </tr>
1396 <tr>
1397 <td><p><a name="ATSPI-RELATION-EMBEDDED-BY:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_EMBEDDED_BY</code></span></p></td>
1398 <td>Reciprocal of <em class="parameter"><code>ATSPI_RELATION_EMBEDS</code></em>. Used to
1399 denote content rendered by embedded renderers that live in a separate process
1400 space from the embedding context.
1401 </td>
1402 </tr>
1403 <tr>
1404 <td><p><a name="ATSPI-RELATION-POPUP-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_POPUP_FOR</code></span></p></td>
1405 <td>Denotes that the object is a transient window or
1406 frame associated with another onscreen object. Similar to <em class="parameter"><code>ATSPI_TOOLTIP_FOR</code></em>,
1407 but more general. Useful for windows which are technically toplevels
1408 but which, for one or more reasons, do not explicitly cause their
1409 associated window to lose 'window focus'. Creation of an <em class="parameter"><code>ATSPI_ROLE_WINDOW</code></em>
1410 object with the <em class="parameter"><code>ATSPI_RELATION_POPUP_FOR</code></em> relation usually requires
1411 some presentation action on the part
1412 of assistive technology clients, even though the previous toplevel
1413 <em class="parameter"><code>ATSPI_ROLE_FRAME</code></em> object may still be the active window.
1414 </td>
1415 </tr>
1416 <tr>
1417 <td><p><a name="ATSPI-RELATION-PARENT-WINDOW-OF:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_PARENT_WINDOW_OF</code></span></p></td>
1418 <td>This is the reciprocal relation to
1419 <em class="parameter"><code>ATSPI_RELATION_POPUP_FOR</code></em>.
1420 </td>
1421 </tr>
1422 <tr>
1423 <td><p><a name="ATSPI-RELATION-DESCRIPTION-FOR:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_DESCRIPTION_FOR</code></span></p></td>
1424 <td>Indicates that an object provides
1425 descriptive information about another object; more verbose than
1426 <em class="parameter"><code>ATSPI_RELATION_LABEL_FOR</code></em>.
1427 </td>
1428 </tr>
1429 <tr>
1430 <td><p><a name="ATSPI-RELATION-DESCRIBED-BY:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_DESCRIBED_BY</code></span></p></td>
1431 <td>Indicates that another object provides
1432 descriptive information about this object; more verbose than
1433 <em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em>.
1434 </td>
1435 </tr>
1436 <tr>
1437 <td><p><a name="ATSPI-RELATION-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATSPI_RELATION_LAST_DEFINED</code></span></p></td>
1438 <td>Do not use as a parameter value, used to
1439 determine the size of the enumeration.
1440 </td>
1441 </tr>
1442 </tbody>
1443 </table></div>
1444 </div>
1445 <hr>
1446 <div class="refsect2">
1447 <a name="ATSPI-RELATIONTYPE-COUNT:CAPS"></a><h3>ATSPI_RELATIONTYPE_COUNT</h3>
1448 <pre class="programlisting">#define ATSPI_RELATIONTYPE_COUNT (19+1)
1449 </pre>
1450 <p>
1451 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a>.
1452 </p>
1453 </div>
1454 <hr>
1455 <div class="refsect2">
1456 <a name="AtspiRole"></a><h3>enum AtspiRole</h3>
1457 <pre class="programlisting">typedef enum {
1458     ATSPI_ROLE_INVALID,
1459     ATSPI_ROLE_ACCELERATOR_LABEL,
1460     ATSPI_ROLE_ALERT,
1461     ATSPI_ROLE_ANIMATION,
1462     ATSPI_ROLE_ARROW,
1463     ATSPI_ROLE_CALENDAR,
1464     ATSPI_ROLE_CANVAS,
1465     ATSPI_ROLE_CHECK_BOX,
1466     ATSPI_ROLE_CHECK_MENU_ITEM,
1467     ATSPI_ROLE_COLOR_CHOOSER,
1468     ATSPI_ROLE_COLUMN_HEADER,
1469     ATSPI_ROLE_COMBO_BOX,
1470     ATSPI_ROLE_DATE_EDITOR,
1471     ATSPI_ROLE_DESKTOP_ICON,
1472     ATSPI_ROLE_DESKTOP_FRAME,
1473     ATSPI_ROLE_DIAL,
1474     ATSPI_ROLE_DIALOG,
1475     ATSPI_ROLE_DIRECTORY_PANE,
1476     ATSPI_ROLE_DRAWING_AREA,
1477     ATSPI_ROLE_FILE_CHOOSER,
1478     ATSPI_ROLE_FILLER,
1479     ATSPI_ROLE_FOCUS_TRAVERSABLE,
1480     ATSPI_ROLE_FONT_CHOOSER,
1481     ATSPI_ROLE_FRAME,
1482     ATSPI_ROLE_GLASS_PANE,
1483     ATSPI_ROLE_HTML_CONTAINER,
1484     ATSPI_ROLE_ICON,
1485     ATSPI_ROLE_IMAGE,
1486     ATSPI_ROLE_INTERNAL_FRAME,
1487     ATSPI_ROLE_LABEL,
1488     ATSPI_ROLE_LAYERED_PANE,
1489     ATSPI_ROLE_LIST,
1490     ATSPI_ROLE_LIST_ITEM,
1491     ATSPI_ROLE_MENU,
1492     ATSPI_ROLE_MENU_BAR,
1493     ATSPI_ROLE_MENU_ITEM,
1494     ATSPI_ROLE_OPTION_PANE,
1495     ATSPI_ROLE_PAGE_TAB,
1496     ATSPI_ROLE_PAGE_TAB_LIST,
1497     ATSPI_ROLE_PANEL,
1498     ATSPI_ROLE_PASSWORD_TEXT,
1499     ATSPI_ROLE_POPUP_MENU,
1500     ATSPI_ROLE_PROGRESS_BAR,
1501     ATSPI_ROLE_PUSH_BUTTON,
1502     ATSPI_ROLE_RADIO_BUTTON,
1503     ATSPI_ROLE_RADIO_MENU_ITEM,
1504     ATSPI_ROLE_ROOT_PANE,
1505     ATSPI_ROLE_ROW_HEADER,
1506     ATSPI_ROLE_SCROLL_BAR,
1507     ATSPI_ROLE_SCROLL_PANE,
1508     ATSPI_ROLE_SEPARATOR,
1509     ATSPI_ROLE_SLIDER,
1510     ATSPI_ROLE_SPIN_BUTTON,
1511     ATSPI_ROLE_SPLIT_PANE,
1512     ATSPI_ROLE_STATUS_BAR,
1513     ATSPI_ROLE_TABLE,
1514     ATSPI_ROLE_TABLE_CELL,
1515     ATSPI_ROLE_TABLE_COLUMN_HEADER,
1516     ATSPI_ROLE_TABLE_ROW_HEADER,
1517     ATSPI_ROLE_TEAROFF_MENU_ITEM,
1518     ATSPI_ROLE_TERMINAL,
1519     ATSPI_ROLE_TEXT,
1520     ATSPI_ROLE_TOGGLE_BUTTON,
1521     ATSPI_ROLE_TOOL_BAR,
1522     ATSPI_ROLE_TOOL_TIP,
1523     ATSPI_ROLE_TREE,
1524     ATSPI_ROLE_TREE_TABLE,
1525     ATSPI_ROLE_UNKNOWN,
1526     ATSPI_ROLE_VIEWPORT,
1527     ATSPI_ROLE_WINDOW,
1528     ATSPI_ROLE_EXTENDED,
1529     ATSPI_ROLE_HEADER,
1530     ATSPI_ROLE_FOOTER,
1531     ATSPI_ROLE_PARAGRAPH,
1532     ATSPI_ROLE_RULER,
1533     ATSPI_ROLE_APPLICATION,
1534     ATSPI_ROLE_AUTOCOMPLETE,
1535     ATSPI_ROLE_EDITBAR,
1536     ATSPI_ROLE_EMBEDDED,
1537     ATSPI_ROLE_ENTRY,
1538     ATSPI_ROLE_CHART,
1539     ATSPI_ROLE_CAPTION,
1540     ATSPI_ROLE_DOCUMENT_FRAME,
1541     ATSPI_ROLE_HEADING,
1542     ATSPI_ROLE_PAGE,
1543     ATSPI_ROLE_SECTION,
1544     ATSPI_ROLE_REDUNDANT_OBJECT,
1545     ATSPI_ROLE_FORM,
1546     ATSPI_ROLE_LINK,
1547     ATSPI_ROLE_INPUT_METHOD_WINDOW,
1548     ATSPI_ROLE_TABLE_ROW,
1549     ATSPI_ROLE_TREE_ITEM,
1550     ATSPI_ROLE_DOCUMENT_SPREADSHEET,
1551     ATSPI_ROLE_DOCUMENT_PRESENTATION,
1552     ATSPI_ROLE_DOCUMENT_TEXT,
1553     ATSPI_ROLE_DOCUMENT_WEB,
1554     ATSPI_ROLE_DOCUMENT_EMAIL,
1555     ATSPI_ROLE_COMMENT,
1556     ATSPI_ROLE_LIST_BOX,
1557     ATSPI_ROLE_GROUPING,
1558     ATSPI_ROLE_IMAGE_MAP,
1559     ATSPI_ROLE_NOTIFICATION,
1560     ATSPI_ROLE_INFO_BAR,
1561     ATSPI_ROLE_LEVEL_BAR,
1562     ATSPI_ROLE_LAST_DEFINED,
1563 } AtspiRole;
1564 </pre>
1565 <p>
1566 Enumeration used by interface <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> to specify the role
1567 of an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.
1568 </p>
1569 <div class="variablelist"><table border="0" class="variablelist">
1570 <colgroup>
1571 <col align="left" valign="top">
1572 <col>
1573 </colgroup>
1574 <tbody>
1575 <tr>
1576 <td><p><a name="ATSPI-ROLE-INVALID:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_INVALID</code></span></p></td>
1577 <td>A role indicating an error condition, such as
1578 uninitialized Role data.
1579 </td>
1580 </tr>
1581 <tr>
1582 <td><p><a name="ATSPI-ROLE-ACCELERATOR-LABEL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ACCELERATOR_LABEL</code></span></p></td>
1583 <td>Object is a label indicating the keyboard
1584 accelerators for the parent.
1585 </td>
1586 </tr>
1587 <tr>
1588 <td><p><a name="ATSPI-ROLE-ALERT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ALERT</code></span></p></td>
1589 <td>Object is used to alert the user about something.
1590 </td>
1591 </tr>
1592 <tr>
1593 <td><p><a name="ATSPI-ROLE-ANIMATION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ANIMATION</code></span></p></td>
1594 <td>Object contains a dynamic or moving image of some
1595 kind.
1596 </td>
1597 </tr>
1598 <tr>
1599 <td><p><a name="ATSPI-ROLE-ARROW:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ARROW</code></span></p></td>
1600 <td>Object is a 2d directional indicator.
1601 </td>
1602 </tr>
1603 <tr>
1604 <td><p><a name="ATSPI-ROLE-CALENDAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CALENDAR</code></span></p></td>
1605 <td>Object contains one or more dates, usually arranged
1606 into a 2d list.
1607 </td>
1608 </tr>
1609 <tr>
1610 <td><p><a name="ATSPI-ROLE-CANVAS:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CANVAS</code></span></p></td>
1611 <td>Object that can be drawn into and is used to trap
1612 events.
1613 </td>
1614 </tr>
1615 <tr>
1616 <td><p><a name="ATSPI-ROLE-CHECK-BOX:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CHECK_BOX</code></span></p></td>
1617 <td>A choice that can be checked or unchecked and
1618 provides a separate       indicator for the current state.
1619 </td>
1620 </tr>
1621 <tr>
1622 <td><p><a name="ATSPI-ROLE-CHECK-MENU-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CHECK_MENU_ITEM</code></span></p></td>
1623 <td>A menu item that behaves like a check box. See
1624 <em class="parameter"><code>ATSPI_ROLE_CHECK_BOX</code></em>.
1625 </td>
1626 </tr>
1627 <tr>
1628 <td><p><a name="ATSPI-ROLE-COLOR-CHOOSER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_COLOR_CHOOSER</code></span></p></td>
1629 <td>A specialized dialog that lets the user choose a
1630 color.
1631 </td>
1632 </tr>
1633 <tr>
1634 <td><p><a name="ATSPI-ROLE-COLUMN-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_COLUMN_HEADER</code></span></p></td>
1635 <td>The header for a column of data.
1636 </td>
1637 </tr>
1638 <tr>
1639 <td><p><a name="ATSPI-ROLE-COMBO-BOX:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_COMBO_BOX</code></span></p></td>
1640 <td>A list of choices the user can select from.
1641 </td>
1642 </tr>
1643 <tr>
1644 <td><p><a name="ATSPI-ROLE-DATE-EDITOR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DATE_EDITOR</code></span></p></td>
1645 <td>An object which allows entry of a date.
1646 </td>
1647 </tr>
1648 <tr>
1649 <td><p><a name="ATSPI-ROLE-DESKTOP-ICON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DESKTOP_ICON</code></span></p></td>
1650 <td>An inconifed internal frame within a DESKTOP_PANE.
1651 </td>
1652 </tr>
1653 <tr>
1654 <td><p><a name="ATSPI-ROLE-DESKTOP-FRAME:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DESKTOP_FRAME</code></span></p></td>
1655 <td>A pane that supports internal frames and
1656 iconified versions of those internal frames.
1657 </td>
1658 </tr>
1659 <tr>
1660 <td><p><a name="ATSPI-ROLE-DIAL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DIAL</code></span></p></td>
1661 <td>An object that allows a value to be changed via rotating a
1662 visual element, or which displays a value via such a rotating element.
1663 </td>
1664 </tr>
1665 <tr>
1666 <td><p><a name="ATSPI-ROLE-DIALOG:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DIALOG</code></span></p></td>
1667 <td>A top level window with title bar and a border.
1668 </td>
1669 </tr>
1670 <tr>
1671 <td><p><a name="ATSPI-ROLE-DIRECTORY-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DIRECTORY_PANE</code></span></p></td>
1672 <td>A pane that allows the user to navigate through
1673 and select the contents of a directory.
1674 </td>
1675 </tr>
1676 <tr>
1677 <td><p><a name="ATSPI-ROLE-DRAWING-AREA:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DRAWING_AREA</code></span></p></td>
1678 <td>A specialized dialog that displays the files in
1679 the directory and lets the user select a file, browse a different
1680 directory, or specify a filename.
1681 </td>
1682 </tr>
1683 <tr>
1684 <td><p><a name="ATSPI-ROLE-FILE-CHOOSER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FILE_CHOOSER</code></span></p></td>
1685 <td>An object used for drawing custom user interface
1686 elements.
1687 </td>
1688 </tr>
1689 <tr>
1690 <td><p><a name="ATSPI-ROLE-FILLER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FILLER</code></span></p></td>
1691 <td>A object that fills up space in a user interface.
1692 </td>
1693 </tr>
1694 <tr>
1695 <td><p><a name="ATSPI-ROLE-FOCUS-TRAVERSABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FOCUS_TRAVERSABLE</code></span></p></td>
1696 <td>Don't use, reserved for future use.
1697 </td>
1698 </tr>
1699 <tr>
1700 <td><p><a name="ATSPI-ROLE-FONT-CHOOSER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FONT_CHOOSER</code></span></p></td>
1701 <td>Allows selection of a display font.
1702 </td>
1703 </tr>
1704 <tr>
1705 <td><p><a name="ATSPI-ROLE-FRAME:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FRAME</code></span></p></td>
1706 <td>A top level window with a title bar, border, menubar,
1707 etc.
1708 </td>
1709 </tr>
1710 <tr>
1711 <td><p><a name="ATSPI-ROLE-GLASS-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_GLASS_PANE</code></span></p></td>
1712 <td>A pane that is guaranteed to be painted on top of
1713 all panes beneath it.
1714 </td>
1715 </tr>
1716 <tr>
1717 <td><p><a name="ATSPI-ROLE-HTML-CONTAINER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_HTML_CONTAINER</code></span></p></td>
1718 <td>A document container for HTML, whose children
1719 represent the document content.
1720 </td>
1721 </tr>
1722 <tr>
1723 <td><p><a name="ATSPI-ROLE-ICON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ICON</code></span></p></td>
1724 <td>A small fixed size picture, typically used to decorate
1725 components.
1726 </td>
1727 </tr>
1728 <tr>
1729 <td><p><a name="ATSPI-ROLE-IMAGE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_IMAGE</code></span></p></td>
1730 <td>An image, typically static.
1731 </td>
1732 </tr>
1733 <tr>
1734 <td><p><a name="ATSPI-ROLE-INTERNAL-FRAME:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_INTERNAL_FRAME</code></span></p></td>
1735 <td>A frame-like object that is clipped by a desktop
1736 pane.
1737 </td>
1738 </tr>
1739 <tr>
1740 <td><p><a name="ATSPI-ROLE-LABEL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LABEL</code></span></p></td>
1741 <td>An object used to present an icon or short string in an
1742 interface.
1743 </td>
1744 </tr>
1745 <tr>
1746 <td><p><a name="ATSPI-ROLE-LAYERED-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LAYERED_PANE</code></span></p></td>
1747 <td>A specialized pane that allows its children to be
1748 drawn in layers, providing a form of stacking order.
1749 </td>
1750 </tr>
1751 <tr>
1752 <td><p><a name="ATSPI-ROLE-LIST:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LIST</code></span></p></td>
1753 <td>An object that presents a list of objects to the user and
1754 allows the user to select one or more of them.
1755 </td>
1756 </tr>
1757 <tr>
1758 <td><p><a name="ATSPI-ROLE-LIST-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LIST_ITEM</code></span></p></td>
1759 <td>An object that represents an element of a list.
1760 </td>
1761 </tr>
1762 <tr>
1763 <td><p><a name="ATSPI-ROLE-MENU:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_MENU</code></span></p></td>
1764 <td>An object usually found inside a menu bar that contains a
1765 list of actions the user can choose from.
1766 </td>
1767 </tr>
1768 <tr>
1769 <td><p><a name="ATSPI-ROLE-MENU-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_MENU_BAR</code></span></p></td>
1770 <td>An object usually drawn at the top of the primary
1771 dialog box of an application that contains a list of menus the user can
1772 choose from.
1773 </td>
1774 </tr>
1775 <tr>
1776 <td><p><a name="ATSPI-ROLE-MENU-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_MENU_ITEM</code></span></p></td>
1777 <td>An object usually contained in a menu that presents
1778 an action the user can choose.
1779 </td>
1780 </tr>
1781 <tr>
1782 <td><p><a name="ATSPI-ROLE-OPTION-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_OPTION_PANE</code></span></p></td>
1783 <td>A specialized pane whose primary use is inside a
1784 dialog.
1785 </td>
1786 </tr>
1787 <tr>
1788 <td><p><a name="ATSPI-ROLE-PAGE-TAB:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PAGE_TAB</code></span></p></td>
1789 <td>An object that is a child of a page tab list.
1790 </td>
1791 </tr>
1792 <tr>
1793 <td><p><a name="ATSPI-ROLE-PAGE-TAB-LIST:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PAGE_TAB_LIST</code></span></p></td>
1794 <td>An object that presents a series of panels (or
1795 page tabs), one at a time,through some mechanism provided by the
1796 object.
1797 </td>
1798 </tr>
1799 <tr>
1800 <td><p><a name="ATSPI-ROLE-PANEL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PANEL</code></span></p></td>
1801 <td>A generic container that is often used to group objects.
1802 </td>
1803 </tr>
1804 <tr>
1805 <td><p><a name="ATSPI-ROLE-PASSWORD-TEXT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PASSWORD_TEXT</code></span></p></td>
1806 <td>A text object uses for passwords, or other places
1807 where the text content is not shown visibly to the user.
1808 </td>
1809 </tr>
1810 <tr>
1811 <td><p><a name="ATSPI-ROLE-POPUP-MENU:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_POPUP_MENU</code></span></p></td>
1812 <td>A temporary window that is usually used to offer the
1813 user a list of choices, and then hides when the user selects one of those
1814 choices.
1815 </td>
1816 </tr>
1817 <tr>
1818 <td><p><a name="ATSPI-ROLE-PROGRESS-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PROGRESS_BAR</code></span></p></td>
1819 <td>An object used to indicate how much of a task has
1820 been completed.
1821 </td>
1822 </tr>
1823 <tr>
1824 <td><p><a name="ATSPI-ROLE-PUSH-BUTTON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PUSH_BUTTON</code></span></p></td>
1825 <td>An object the user can manipulate to tell the
1826 application to do something.
1827 </td>
1828 </tr>
1829 <tr>
1830 <td><p><a name="ATSPI-ROLE-RADIO-BUTTON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_RADIO_BUTTON</code></span></p></td>
1831 <td>A specialized check box that will cause other
1832 radio buttons in the same group to become unchecked when this one is
1833 checked.
1834 </td>
1835 </tr>
1836 <tr>
1837 <td><p><a name="ATSPI-ROLE-RADIO-MENU-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_RADIO_MENU_ITEM</code></span></p></td>
1838 <td>Object is both a menu item and a "radio button"
1839 . See <em class="parameter"><code>ATSPI_ROLE_RADIO_BUTTON</code></em>.
1840 </td>
1841 </tr>
1842 <tr>
1843 <td><p><a name="ATSPI-ROLE-ROOT-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ROOT_PANE</code></span></p></td>
1844 <td>A specialized pane that has a glass pane and a
1845 layered pane as its children.
1846 </td>
1847 </tr>
1848 <tr>
1849 <td><p><a name="ATSPI-ROLE-ROW-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ROW_HEADER</code></span></p></td>
1850 <td>The header for a row of data.
1851 </td>
1852 </tr>
1853 <tr>
1854 <td><p><a name="ATSPI-ROLE-SCROLL-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SCROLL_BAR</code></span></p></td>
1855 <td>An object usually used to allow a user to
1856 incrementally view a large amount of data by moving the bounds of a
1857 viewport along a one-dimensional axis.
1858 </td>
1859 </tr>
1860 <tr>
1861 <td><p><a name="ATSPI-ROLE-SCROLL-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SCROLL_PANE</code></span></p></td>
1862 <td>An object that allows a user to incrementally view
1863 a large amount of information. <em class="parameter"><code>ATSPI_ROLE_SCROLL_PANE</code></em> objects are usually
1864 accompanied by <em class="parameter"><code>ATSPI_ROLE_SCROLL_BAR</code></em> controllers, on which the
1865 <em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em> and <em class="parameter"><code>ATSPI_RELATION_CONTROLLED_BY</code></em>
1866 reciprocal relations are set. See  <span class="type">atspi_get_relation_set</span>.
1867 </td>
1868 </tr>
1869 <tr>
1870 <td><p><a name="ATSPI-ROLE-SEPARATOR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SEPARATOR</code></span></p></td>
1871 <td>An object usually contained in a menu to provide a
1872 visible and logical separation of the contents in a menu.
1873 </td>
1874 </tr>
1875 <tr>
1876 <td><p><a name="ATSPI-ROLE-SLIDER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SLIDER</code></span></p></td>
1877 <td>An object that allows the user to select from a bounded
1878 range.
1879 </td>
1880 </tr>
1881 <tr>
1882 <td><p><a name="ATSPI-ROLE-SPIN-BUTTON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SPIN_BUTTON</code></span></p></td>
1883 <td>An object which allows one of a set of choices to
1884 be selected, and which displays the current choice.  Unlike
1885 <em class="parameter"><code>ATSPI_ROLE_SCROLL_BAR</code></em>, <em class="parameter"><code>ATSPI_ROLE_SLIDER</code></em> objects need not control
1886 'viewport'-like objects.
1887 </td>
1888 </tr>
1889 <tr>
1890 <td><p><a name="ATSPI-ROLE-SPLIT-PANE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SPLIT_PANE</code></span></p></td>
1891 <td>A specialized panel that presents two other panels
1892 at the same time.
1893 </td>
1894 </tr>
1895 <tr>
1896 <td><p><a name="ATSPI-ROLE-STATUS-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_STATUS_BAR</code></span></p></td>
1897 <td>Object displays non-quantitative status information
1898 (c.f. <em class="parameter"><code>ATSPI_ROLE_PROGRESS_BAR</code></em>)
1899 </td>
1900 </tr>
1901 <tr>
1902 <td><p><a name="ATSPI-ROLE-TABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE</code></span></p></td>
1903 <td>An object used to repesent information in terms of rows
1904 and columns.
1905 </td>
1906 </tr>
1907 <tr>
1908 <td><p><a name="ATSPI-ROLE-TABLE-CELL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE_CELL</code></span></p></td>
1909 <td>A 'cell' or discrete child within a Table. Note:
1910 Table cells need not have <em class="parameter"><code>ATSPI_ROLE_TABLE_CELL</code></em>, other
1911 <span class="type">AtspiRoleType</span> values are valid as well.
1912 </td>
1913 </tr>
1914 <tr>
1915 <td><p><a name="ATSPI-ROLE-TABLE-COLUMN-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE_COLUMN_HEADER</code></span></p></td>
1916 <td>An object which labels a particular column
1917 in an <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a>.
1918 </td>
1919 </tr>
1920 <tr>
1921 <td><p><a name="ATSPI-ROLE-TABLE-ROW-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE_ROW_HEADER</code></span></p></td>
1922 <td>An object which labels a particular row in a
1923 <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a>. <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a> rows and columns may also be labelled via the
1924 <em class="parameter"><code>ATSPI_RELATION_LABEL_FOR</code></em>/<em class="parameter"><code>ATSPI_RELATION_LABELLED_BY</code></em> relationships.
1925 See <span class="type">atspi_get_relation_set</span>.
1926 </td>
1927 </tr>
1928 <tr>
1929 <td><p><a name="ATSPI-ROLE-TEAROFF-MENU-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TEAROFF_MENU_ITEM</code></span></p></td>
1930 <td>Object allows menu to be removed from menubar
1931 and shown in its own window.
1932 </td>
1933 </tr>
1934 <tr>
1935 <td><p><a name="ATSPI-ROLE-TERMINAL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TERMINAL</code></span></p></td>
1936 <td>An object that emulates a terminal.
1937 </td>
1938 </tr>
1939 <tr>
1940 <td><p><a name="ATSPI-ROLE-TEXT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TEXT</code></span></p></td>
1941 <td>An object that presents text to the user, of nonspecific
1942 type.
1943 </td>
1944 </tr>
1945 <tr>
1946 <td><p><a name="ATSPI-ROLE-TOGGLE-BUTTON:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TOGGLE_BUTTON</code></span></p></td>
1947 <td>A specialized push button that can be checked or
1948 unchecked, but does not procide a separate indicator for the current
1949 state.
1950 </td>
1951 </tr>
1952 <tr>
1953 <td><p><a name="ATSPI-ROLE-TOOL-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TOOL_BAR</code></span></p></td>
1954 <td>A bar or palette usually composed of push buttons or
1955 toggle buttons.
1956 </td>
1957 </tr>
1958 <tr>
1959 <td><p><a name="ATSPI-ROLE-TOOL-TIP:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TOOL_TIP</code></span></p></td>
1960 <td>An object that provides information about another
1961 object.
1962 </td>
1963 </tr>
1964 <tr>
1965 <td><p><a name="ATSPI-ROLE-TREE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TREE</code></span></p></td>
1966 <td>An object used to repsent hierarchical information to the
1967 user.
1968 </td>
1969 </tr>
1970 <tr>
1971 <td><p><a name="ATSPI-ROLE-TREE-TABLE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TREE_TABLE</code></span></p></td>
1972 <td>An object that presents both tabular and
1973 hierarchical info to the user.
1974 </td>
1975 </tr>
1976 <tr>
1977 <td><p><a name="ATSPI-ROLE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_UNKNOWN</code></span></p></td>
1978 <td>The object contains some <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> information,
1979 but its role is not known.
1980 </td>
1981 </tr>
1982 <tr>
1983 <td><p><a name="ATSPI-ROLE-VIEWPORT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_VIEWPORT</code></span></p></td>
1984 <td>An object usually used in a scroll pane, or to
1985 otherwise clip a larger object or content renderer to a specific
1986 onscreen viewport.
1987 </td>
1988 </tr>
1989 <tr>
1990 <td><p><a name="ATSPI-ROLE-WINDOW:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_WINDOW</code></span></p></td>
1991 <td>A top level window with no title or border.
1992 </td>
1993 </tr>
1994 <tr>
1995 <td><p><a name="ATSPI-ROLE-EXTENDED:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_EXTENDED</code></span></p></td>
1996 <td>means that the role for this item is known, but not
1997 included in the core enumeration.
1998 </td>
1999 </tr>
2000 <tr>
2001 <td><p><a name="ATSPI-ROLE-HEADER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_HEADER</code></span></p></td>
2002 <td>An object that serves as a document header.
2003 </td>
2004 </tr>
2005 <tr>
2006 <td><p><a name="ATSPI-ROLE-FOOTER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FOOTER</code></span></p></td>
2007 <td>An object that serves as a document footer.
2008 </td>
2009 </tr>
2010 <tr>
2011 <td><p><a name="ATSPI-ROLE-PARAGRAPH:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PARAGRAPH</code></span></p></td>
2012 <td>An object which is contains a single paragraph of
2013 text content. See also <em class="parameter"><code>ATSPI_ROLE_TEXT</code></em>.
2014 </td>
2015 </tr>
2016 <tr>
2017 <td><p><a name="ATSPI-ROLE-RULER:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_RULER</code></span></p></td>
2018 <td>An object which describes margins and tab stops, etc.
2019    for text objects which it controls (should have
2020 <em class="parameter"><code>ATSPI_RELATION_CONTROLLER_FOR</code></em> relation to such).
2021 </td>
2022 </tr>
2023 <tr>
2024 <td><p><a name="ATSPI-ROLE-APPLICATION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_APPLICATION</code></span></p></td>
2025 <td>An object corresponding to the toplevel accessible
2026 of an application, which may contain <em class="parameter"><code>ATSPI_ROLE_FRAME</code></em> objects or other
2027 accessible objects. Children of <span class="type">AccessibleDesktop</span> objects  are generally
2028 <em class="parameter"><code>ATSPI_ROLE_APPLICATION</code></em> objects.
2029 </td>
2030 </tr>
2031 <tr>
2032 <td><p><a name="ATSPI-ROLE-AUTOCOMPLETE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_AUTOCOMPLETE</code></span></p></td>
2033 <td>The object is a dialog or list containing items
2034 for insertion into an entry widget, for instance a list of words for
2035 completion of a text entry.
2036 </td>
2037 </tr>
2038 <tr>
2039 <td><p><a name="ATSPI-ROLE-EDITBAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_EDITBAR</code></span></p></td>
2040 <td>The object is an editable text object in a toolbar.
2041 </td>
2042 </tr>
2043 <tr>
2044 <td><p><a name="ATSPI-ROLE-EMBEDDED:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_EMBEDDED</code></span></p></td>
2045 <td>The object is an embedded component container.  This
2046 role is a "grouping" hint that the contained objects share a context
2047 which is different from the container in which this accessible is
2048 embedded. In particular, it is used for some kinds of document embedding,
2049 and for embedding of out-of-process component, "panel applets", etc.
2050 </td>
2051 </tr>
2052 <tr>
2053 <td><p><a name="ATSPI-ROLE-ENTRY:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_ENTRY</code></span></p></td>
2054 <td>The object is a component whose textual content may be
2055 entered or modified by the user, provided <em class="parameter"><code>ATSPI_STATE_EDITABLE</code></em> is present.
2056 A readonly <em class="parameter"><code>ATSPI_ROLE_ENTRY</code></em> object (i.e. where <em class="parameter"><code>ATSPI_STATE_EDITABLE</code></em> is
2057 not present) implies a read-only 'text field' in a form, as opposed to a
2058 title, label, or caption.
2059 </td>
2060 </tr>
2061 <tr>
2062 <td><p><a name="ATSPI-ROLE-CHART:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CHART</code></span></p></td>
2063 <td>The object is a graphical depiction of quantitative data.
2064 It may contain multiple subelements whose attributes and/or description
2065 may be queried to obtain both the  quantitative data and information about
2066 how the data is being presented. The <em class="parameter"><code>ATSPI_LABELLED_BY</code></em> relation is
2067 particularly important in interpreting objects of this type, as is the
2068 accessible description property. See <em class="parameter"><code>ATSPI_ROLE_CAPTION</code></em>.
2069 </td>
2070 </tr>
2071 <tr>
2072 <td><p><a name="ATSPI-ROLE-CAPTION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_CAPTION</code></span></p></td>
2073 <td>The object contains descriptive information, usually
2074 textual, about another user interface element such as a table, chart, or
2075 image.
2076 </td>
2077 </tr>
2078 <tr>
2079 <td><p><a name="ATSPI-ROLE-DOCUMENT-FRAME:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_FRAME</code></span></p></td>
2080 <td>The object is a visual frame or container which
2081 contains a view of document content. <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> frames may occur within
2082 another <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> instance, in which case the second  document may be
2083 said to be embedded in the containing instance.  HTML frames are often
2084 </td>
2085 </tr>
2086 <tr>
2087 <td><p><a name="ATSPI-ROLE-HEADING:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_HEADING</code></span></p></td>
2088 <td>The object serves as a heading for content which
2089 follows it in a document. The 'heading level' of the heading, if
2090 availabe,  may be obtained by       querying the object's attributes.
2091 </td>
2092 </tr>
2093 <tr>
2094 <td><p><a name="ATSPI-ROLE-PAGE:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_PAGE</code></span></p></td>
2095 <td>The object is a containing instance which encapsulates a
2096 page of information. <em class="parameter"><code>ATSPI_ROLE_PAGE</code></em> is used in documents and content which
2097 support a paginated navigation model.
2098 </td>
2099 </tr>
2100 <tr>
2101 <td><p><a name="ATSPI-ROLE-SECTION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_SECTION</code></span></p></td>
2102 <td>The object is a containing instance of document content
2103 which constitutes a particular 'logical' section of the document.  The
2104 type of content within a section, and the nature of the section division
2105 itself, may be obtained by querying the object's attributes.  Sections
2106 may be nested.
2107 </td>
2108 </tr>
2109 <tr>
2110 <td><p><a name="ATSPI-ROLE-REDUNDANT-OBJECT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_REDUNDANT_OBJECT</code></span></p></td>
2111 <td>The object is redundant with another object in
2112 the hierarchy, and is exposed for purely technical reasons.  Objects of
2113 this role should be ignored by clients, if they are encountered at all.
2114 </td>
2115 </tr>
2116 <tr>
2117 <td><p><a name="ATSPI-ROLE-FORM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_FORM</code></span></p></td>
2118 <td>The object is a containing instance of document content
2119 which has within it components with which the user can interact in order
2120 to input information; i.e. the object is a container for pushbuttons,
2121 comboboxes, text input fields, and other 'GUI' components. <em class="parameter"><code>ATSPI_ROLE_FORM</code></em>
2122 should not, in general, be used for toplevel GUI containers or dialogs,
2123 but should be reserved for 'GUI' containers which occur within document
2124 content, for instance within Web documents, presentations, or text
2125 documents.  Unlike other GUI containers and dialogs which occur inside
2126 application instances, <em class="parameter"><code>ATSPI_ROLE_FORM</code></em> containers' components are
2127 associated with the current document, rather than the current foreground
2128 application or viewer instance.
2129 </td>
2130 </tr>
2131 <tr>
2132 <td><p><a name="ATSPI-ROLE-LINK:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LINK</code></span></p></td>
2133 <td>The object is a hypertext anchor, i.e. a "link" in a
2134 hypertext document.  Such objects are distinct from 'inline'       content
2135 which may also use the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>/<a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> interfacesto indicate
2136 the range/location within a text object where an inline or embedded object
2137 lies.
2138 </td>
2139 </tr>
2140 <tr>
2141 <td><p><a name="ATSPI-ROLE-INPUT-METHOD-WINDOW:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_INPUT_METHOD_WINDOW</code></span></p></td>
2142 <td>The object is a window or similar viewport
2143 which is used to allow composition or input of a 'complex character',
2144 in other words it is an "input method window".
2145 </td>
2146 </tr>
2147 <tr>
2148 <td><p><a name="ATSPI-ROLE-TABLE-ROW:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TABLE_ROW</code></span></p></td>
2149 <td>A row in a table.
2150 </td>
2151 </tr>
2152 <tr>
2153 <td><p><a name="ATSPI-ROLE-TREE-ITEM:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_TREE_ITEM</code></span></p></td>
2154 <td>An object that represents an element of a tree.
2155 </td>
2156 </tr>
2157 <tr>
2158 <td><p><a name="ATSPI-ROLE-DOCUMENT-SPREADSHEET:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_SPREADSHEET</code></span></p></td>
2159 <td>A document frame which contains a
2160 spreadsheet.
2161 </td>
2162 </tr>
2163 <tr>
2164 <td><p><a name="ATSPI-ROLE-DOCUMENT-PRESENTATION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_PRESENTATION</code></span></p></td>
2165 <td>A document frame which contains a
2166 presentation or slide content.
2167 </td>
2168 </tr>
2169 <tr>
2170 <td><p><a name="ATSPI-ROLE-DOCUMENT-TEXT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_TEXT</code></span></p></td>
2171 <td>A document frame which contains textual content,
2172 such as found in a word processing
2173 application.
2174 </td>
2175 </tr>
2176 <tr>
2177 <td><p><a name="ATSPI-ROLE-DOCUMENT-WEB:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_WEB</code></span></p></td>
2178 <td>A document frame which contains HTML or other
2179 markup suitable for display in a web browser.
2180 </td>
2181 </tr>
2182 <tr>
2183 <td><p><a name="ATSPI-ROLE-DOCUMENT-EMAIL:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_DOCUMENT_EMAIL</code></span></p></td>
2184 <td>A document frame which contains email content
2185 to be displayed or composed either in plain text or
2186 HTML.
2187 </td>
2188 </tr>
2189 <tr>
2190 <td><p><a name="ATSPI-ROLE-COMMENT:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_COMMENT</code></span></p></td>
2191 <td>An object found within a document and designed to
2192 present a comment, note, or other annotation. In some cases, this object
2193 might not be visible until activated.
2194 </td>
2195 </tr>
2196 <tr>
2197 <td><p><a name="ATSPI-ROLE-LIST-BOX:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LIST_BOX</code></span></p></td>
2198 <td>A non-collapsible list of choices the user can
2199 select from.
2200 </td>
2201 </tr>
2202 <tr>
2203 <td><p><a name="ATSPI-ROLE-GROUPING:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_GROUPING</code></span></p></td>
2204 <td>A group of related widgets. This group typically has
2205 a label.
2206 </td>
2207 </tr>
2208 <tr>
2209 <td><p><a name="ATSPI-ROLE-IMAGE-MAP:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_IMAGE_MAP</code></span></p></td>
2210 <td>An image map object. Usually a graphic with multiple
2211 hotspots, where each hotspot can be activated resulting in the loading of
2212 another document or section of a document.
2213 </td>
2214 </tr>
2215 <tr>
2216 <td><p><a name="ATSPI-ROLE-NOTIFICATION:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_NOTIFICATION</code></span></p></td>
2217 <td>A transitory object designed to present a
2218 message to the user, typically at the desktop level rather than inside a
2219 particular application.
2220 </td>
2221 </tr>
2222 <tr>
2223 <td><p><a name="ATSPI-ROLE-INFO-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_INFO_BAR</code></span></p></td>
2224 <td>An object designed to present a message to the user
2225 within an existing window.
2226 </td>
2227 </tr>
2228 <tr>
2229 <td><p><a name="ATSPI-ROLE-LEVEL-BAR:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LEVEL_BAR</code></span></p></td>
2230 <td>A bar that serves as a level indicator to, for
2231 instance, show the strength of a password or the state of a battery.
2232 Since: 2.8
2233 </td>
2234 </tr>
2235 <tr>
2236 <td><p><a name="ATSPI-ROLE-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATSPI_ROLE_LAST_DEFINED</code></span></p></td>
2237 <td>Not a valid role, used for finding end of
2238 enumeration.
2239 </td>
2240 </tr>
2241 </tbody>
2242 </table></div>
2243 </div>
2244 <hr>
2245 <div class="refsect2">
2246 <a name="ATSPI-ROLE-COUNT:CAPS"></a><h3>ATSPI_ROLE_COUNT</h3>
2247 <pre class="programlisting">#define ATSPI_ROLE_COUNT (90+1)
2248 </pre>
2249 <p>
2250 One higher than the highest valid value of <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="type">AtspiRole</span></a>.
2251 </p>
2252 </div>
2253 </div>
2254 </div>
2255 <div class="footer">
2256 <hr>
2257           Generated by GTK-Doc V1.18.1</div>
2258 </body>
2259 </html>