/usr/share/gtk-doc/html/libatspi/libatspi-atspi-types.html is in at-spi2-doc 2.4.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-types</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="libatspi-atspi-registry.html" title="atspi-registry">
<link rel="next" href="libatspi-atspi-constants.html" title="atspi-constants">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libatspi-atspi-registry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libatspi Reference Manual</th>
<td><a accesskey="n" href="libatspi-atspi-constants.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libatspi-atspi-types.synopsis" class="shortcut">Top</a>
|
<a href="#libatspi-atspi-types.description" class="shortcut">Description</a>
|
<a href="#libatspi-atspi-types.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libatspi-atspi-types.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#libatspi-atspi-types.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-types"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-types.top_of_page"></a>atspi-types</span></h2>
<p>atspi-types — Type definitions needed by multiple interfaces.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-types.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiAccessible"></a><a name="AtspiAction"></a><a name="AtspiCollection"></a><a name="AtspiComponent"></a><a name="AtspiDocument"></a><a name="AtspiEditableText"></a><a name="AtspiHyperlink"></a><a name="AtspiHypertext"></a><a name="AtspiImage"></a><a name="AtspiSelection"></a><a name="AtspiTable"></a><a name="AtspiText"></a><a name="AtspiValue"></a><a name="AtspiKeyDefinition"></a><a name="AtspiEvent"></a><pre class="synopsis"> <a class="link" href="AtspiAccessible.html#AtspiAccessible-struct" title="AtspiAccessible">AtspiAccessible</a>;
<a class="link" href="libatspi-atspi-types.html#AtspiAction-struct" title="AtspiAction">AtspiAction</a>;
<a class="link" href="libatspi-atspi-collection.html#AtspiCollection-struct" title="AtspiCollection">AtspiCollection</a>;
<a class="link" href="libatspi-atspi-component.html#AtspiComponent-struct" title="AtspiComponent">AtspiComponent</a>;
<a class="link" href="libatspi-atspi-document.html#AtspiDocument-struct" title="AtspiDocument">AtspiDocument</a>;
<a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText-struct" title="AtspiEditableText">AtspiEditableText</a>;
<a class="link" href="AtspiHyperlink.html#AtspiHyperlink-struct" title="AtspiHyperlink">AtspiHyperlink</a>;
<a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext-struct" title="AtspiHypertext">AtspiHypertext</a>;
<a class="link" href="libatspi-atspi-image.html#AtspiImage-struct" title="AtspiImage">AtspiImage</a>;
<a class="link" href="libatspi-atspi-selection.html#AtspiSelection-struct" title="AtspiSelection">AtspiSelection</a>;
<a class="link" href="libatspi-atspi-table.html#AtspiTable-struct" title="AtspiTable">AtspiTable</a>;
<a class="link" href="libatspi-atspi-text.html#AtspiText-struct" title="AtspiText">AtspiText</a>;
<a class="link" href="libatspi-atspi-value.html#AtspiValue-struct" title="AtspiValue">AtspiValue</a>;
typedef <a class="link" href="libatspi-atspi-types.html#AtspiControllerEventMask" title="AtspiControllerEventMask">AtspiControllerEventMask</a>;
typedef <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType">AtspiKeyMaskType</a>;
typedef <a class="link" href="libatspi-atspi-types.html#AtspiKeyEventMask" title="AtspiKeyEventMask">AtspiKeyEventMask</a>;
typedef <a class="link" href="libatspi-atspi-types.html#AtspiDeviceEventMask" title="AtspiDeviceEventMask">AtspiDeviceEventMask</a>;
struct <a class="link" href="libatspi-atspi-types.html#AtspiDeviceEvent" title="struct AtspiDeviceEvent">AtspiDeviceEvent</a>;
struct <a class="link" href="libatspi-atspi-types.html#AtspiEventListenerMode" title="struct AtspiEventListenerMode">AtspiEventListenerMode</a>;
struct <a class="link" href="libatspi-atspi-types.html#AtspiKeyDefinition-struct" title="struct AtspiKeyDefinition">AtspiKeyDefinition</a>;
struct <a class="link" href="libatspi-atspi-types.html#AtspiEvent-struct" title="struct AtspiEvent">AtspiEvent</a>;
#define <a class="link" href="libatspi-atspi-types.html#ATSPI-TYPE-EVENT:CAPS" title="ATSPI_TYPE_EVENT">ATSPI_TYPE_EVENT</a>
typedef <a class="link" href="libatspi-atspi-types.html#AtspiKeystrokeListener" title="AtspiKeystrokeListener">AtspiKeystrokeListener</a>;
enum <a class="link" href="libatspi-atspi-types.html#AtspiKeyListenerSyncType" title="enum AtspiKeyListenerSyncType">AtspiKeyListenerSyncType</a>;
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-types.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="AtspiObject.html" title="AtspiObject">AtspiObject</a>
+----AtspiAccessible
</pre>
<pre class="synopsis">
GInterface
+----AtspiAction
</pre>
<pre class="synopsis">
GInterface
+----AtspiCollection
</pre>
<pre class="synopsis">
GInterface
+----AtspiComponent
</pre>
<pre class="synopsis">
GInterface
+----AtspiDocument
</pre>
<pre class="synopsis">
GInterface
+----AtspiEditableText
</pre>
<pre class="synopsis">
GObject
+----<a class="link" href="AtspiObject.html" title="AtspiObject">AtspiObject</a>
+----AtspiHyperlink
</pre>
<pre class="synopsis">
GInterface
+----AtspiHypertext
</pre>
<pre class="synopsis">
GInterface
+----AtspiImage
</pre>
<pre class="synopsis">
GInterface
+----AtspiSelection
</pre>
<pre class="synopsis">
GInterface
+----AtspiTable
</pre>
<pre class="synopsis">
GInterface
+----AtspiText
</pre>
<pre class="synopsis">
GInterface
+----AtspiValue
</pre>
<pre class="synopsis">
GBoxed
+----AtspiKeyDefinition
</pre>
<pre class="synopsis">
GBoxed
+----AtspiEvent
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-types.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
AtspiAccessible implements
<a class="link" href="libatspi-atspi-types.html#AtspiAction">AtspiAction</a>, <a class="link" href="libatspi-atspi-collection.html#AtspiCollection">AtspiCollection</a>, <a class="link" href="libatspi-atspi-component.html#AtspiComponent">AtspiComponent</a>, <a class="link" href="libatspi-atspi-document.html#AtspiDocument">AtspiDocument</a>, <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText">AtspiEditableText</a>, <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext">AtspiHypertext</a>, <a class="link" href="libatspi-atspi-image.html#AtspiImage">AtspiImage</a>, <a class="link" href="libatspi-atspi-selection.html#AtspiSelection">AtspiSelection</a>, <a class="link" href="libatspi-atspi-table.html#AtspiTable">AtspiTable</a>, <a class="link" href="libatspi-atspi-text.html#AtspiText">AtspiText</a> and <a class="link" href="libatspi-atspi-value.html#AtspiValue">AtspiValue</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-types.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiAction is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiCollection is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiComponent is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiDocument is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiEditableText is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiHypertext is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiImage is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiSelection is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiTable is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiText is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
<p>
AtspiValue is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-types.description"></a><h2>Description</h2>
<p>
Type definitions needed by multiple interfaces.
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-types.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiAccessible-struct"></a><h3>AtspiAccessible</h3>
<pre class="programlisting">typedef struct _AtspiAccessible AtspiAccessible;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiAction-struct"></a><h3>AtspiAction</h3>
<pre class="programlisting">typedef struct _AtspiAction AtspiAction;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiCollection-struct"></a><h3>AtspiCollection</h3>
<pre class="programlisting">typedef struct _AtspiCollection AtspiCollection;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiComponent-struct"></a><h3>AtspiComponent</h3>
<pre class="programlisting">typedef struct _AtspiComponent AtspiComponent;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiDocument-struct"></a><h3>AtspiDocument</h3>
<pre class="programlisting">typedef struct _AtspiDocument AtspiDocument;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiEditableText-struct"></a><h3>AtspiEditableText</h3>
<pre class="programlisting">typedef struct _AtspiEditableText AtspiEditableText;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiHyperlink-struct"></a><h3>AtspiHyperlink</h3>
<pre class="programlisting">typedef struct _AtspiHyperlink AtspiHyperlink;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiHypertext-struct"></a><h3>AtspiHypertext</h3>
<pre class="programlisting">typedef struct _AtspiHypertext AtspiHypertext;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiImage-struct"></a><h3>AtspiImage</h3>
<pre class="programlisting">typedef struct _AtspiImage AtspiImage;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiSelection-struct"></a><h3>AtspiSelection</h3>
<pre class="programlisting">typedef struct _AtspiSelection AtspiSelection;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiTable-struct"></a><h3>AtspiTable</h3>
<pre class="programlisting">typedef struct _AtspiTable AtspiTable;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiText-struct"></a><h3>AtspiText</h3>
<pre class="programlisting">typedef struct _AtspiText AtspiText;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiValue-struct"></a><h3>AtspiValue</h3>
<pre class="programlisting">typedef struct _AtspiValue AtspiValue;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiControllerEventMask"></a><h3>AtspiControllerEventMask</h3>
<pre class="programlisting">typedef guint AtspiControllerEventMask;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiKeyMaskType"></a><h3>AtspiKeyMaskType</h3>
<pre class="programlisting">typedef guint AtspiKeyMaskType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiKeyEventMask"></a><h3>AtspiKeyEventMask</h3>
<pre class="programlisting">typedef guint AtspiKeyEventMask;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiDeviceEventMask"></a><h3>AtspiDeviceEventMask</h3>
<pre class="programlisting">typedef guint AtspiDeviceEventMask;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiDeviceEvent"></a><h3>struct AtspiDeviceEvent</h3>
<pre class="programlisting">struct AtspiDeviceEvent {
AtspiEventType type;
guint id;
gushort hw_code;
gushort modifiers;
guint timestamp;
gchar * event_string;
gboolean is_text;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiEventListenerMode"></a><h3>struct AtspiEventListenerMode</h3>
<pre class="programlisting">struct AtspiEventListenerMode {
gboolean synchronous;
gboolean preemptive;
gboolean global;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiKeyDefinition-struct"></a><h3>struct AtspiKeyDefinition</h3>
<pre class="programlisting">struct AtspiKeyDefinition {
gint keycode;
gint keysym;
gchar *keystring;
gint unused;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiEvent-struct"></a><h3>struct AtspiEvent</h3>
<pre class="programlisting">struct AtspiEvent {
gchar *type;
AtspiAccessible *source;
gint detail1;
gint detail2;
GValue any_data;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-TYPE-EVENT:CAPS"></a><h3>ATSPI_TYPE_EVENT</h3>
<pre class="programlisting">#define ATSPI_TYPE_EVENT (atspi_event_get_type ())
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiKeystrokeListener"></a><h3>AtspiKeystrokeListener</h3>
<pre class="programlisting">typedef void AtspiKeystrokeListener;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiKeyListenerSyncType"></a><h3>enum AtspiKeyListenerSyncType</h3>
<pre class="programlisting">typedef enum {
ATSPI_KEYLISTENER_NOSYNC = 0,
ATSPI_KEYLISTENER_SYNCHRONOUS = 1,
ATSPI_KEYLISTENER_CANCONSUME = 2,
ATSPI_KEYLISTENER_ALL_WINDOWS = 4
} AtspiKeyListenerSyncType;
</pre>
<p>
Specifies the type of a key listener event.
The values above can and should be bitwise-'OR'-ed
together, observing the compatibility limitations specified in the description of
each value. For instance, <a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-ALL-WINDOWS:CAPS"><span class="type">ATSPI_KEYLISTENER_ALL_WINDOWS</span></a> | <a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-CANCONSUME:CAPS"><span class="type">ATSPI_KEYLISTENER_CANCONSUME</span></a> is
a commonly used combination which gives the AT complete control over the delivery of matching
events. However, such filters should be used sparingly as they may have a negative impact on
system performance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="ATSPI-KEYLISTENER-NOSYNC:CAPS"></a><span class="term"><code class="literal">ATSPI_KEYLISTENER_NOSYNC</code></span></p></td>
<td>Events may be delivered asynchronously,
which means in some cases they may already have been delivered to the
application before the AT client receives the notification.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-KEYLISTENER-SYNCHRONOUS:CAPS"></a><span class="term"><code class="literal">ATSPI_KEYLISTENER_SYNCHRONOUS</code></span></p></td>
<td>Events are delivered synchronously, before the
currently focussed application sees them.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-KEYLISTENER-CANCONSUME:CAPS"></a><span class="term"><code class="literal">ATSPI_KEYLISTENER_CANCONSUME</code></span></p></td>
<td>Events may be consumed by the AT client. Presumes and
requires <a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-SYNCHRONOUS:CAPS"><span class="type">ATSPI_KEYLISTENER_SYNCHRONOUS</span></a>, incompatible with <a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-NOSYNC:CAPS"><span class="type">ATSPI_KEYLISTENER_NOSYNC</span></a>.
</td>
</tr>
<tr>
<td><p><a name="ATSPI-KEYLISTENER-ALL-WINDOWS:CAPS"></a><span class="term"><code class="literal">ATSPI_KEYLISTENER_ALL_WINDOWS</code></span></p></td>
<td>Events are received not from the application toolkit layer, but
from the device driver or windowing system subsystem; such notifications are 'global' in the
sense that they are not broken or defeated by applications that participate poorly
in the accessibility APIs, or not at all; however because of the intrusive nature of
such snooping, it can have side-effects on certain older platforms. If unconditional
event notifications, even when inaccessible or "broken" applications have focus, are not
required, it may be best to avoid this enum value/flag.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|