/usr/share/gtk-doc/html/at-spi-cspi/at-spi-cspi-AccessibleComponent-Interface.html is in at-spi-doc 1.32.0-1ubuntu1.
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 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AccessibleComponent Interface</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
<link rel="up" href="spi-component.html" title="Subinterface Methods">
<link rel="prev" href="at-spi-cspi-AccessibleAction-Interface.html" title="AccessibleAction Interface">
<link rel="next" href="at-spi-cspi-AccessibleDocument-Interface.html" title="AccessibleDocument Interface">
<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="at-spi-cspi-AccessibleAction-Interface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="spi-component.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">AT-SPI C Bindings Reference Manual</th>
<td><a accesskey="n" href="at-spi-cspi-AccessibleDocument-Interface.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#at-spi-cspi-AccessibleComponent-Interface.synopsis" class="shortcut">Top</a>
|
<a href="#at-spi-cspi-AccessibleComponent-Interface.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="at-spi-cspi-AccessibleComponent-Interface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="at-spi-cspi-AccessibleComponent-Interface.top_of_page"></a>AccessibleComponent Interface</span></h2>
<p>AccessibleComponent Interface — An interface implemented by objects which occupy area on screen.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="at-spi-cspi-AccessibleComponent-Interface.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType">AccessibleCoordType</a>;
enum <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponentLayer" title="enum AccessibleComponentLayer">AccessibleComponentLayer</a>;
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-ref" title="AccessibleComponent_ref ()">AccessibleComponent_ref</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-unref" title="AccessibleComponent_unref ()">AccessibleComponent_unref</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-contains" title="AccessibleComponent_contains ()">AccessibleComponent_contains</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> y</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType"><span class="type">AccessibleCoordType</span></a> ctype</code></em>);
<a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="returnvalue">Accessible</span></a> * <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-getAccessibleAtPoint" title="AccessibleComponent_getAccessibleAtPoint ()">AccessibleComponent_getAccessibleAtPoint</a>
(<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> y</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType"><span class="type">AccessibleCoordType</span></a> ctype</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-getExtents" title="AccessibleComponent_getExtents ()">AccessibleComponent_getExtents</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *y</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *width</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *height</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType"><span class="type">AccessibleCoordType</span></a> ctype</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-getPosition" title="AccessibleComponent_getPosition ()">AccessibleComponent_getPosition</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *y</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType"><span class="type">AccessibleCoordType</span></a> ctype</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-getSize" title="AccessibleComponent_getSize ()">AccessibleComponent_getSize</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *width</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *height</code></em>);
<a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponentLayer" title="enum AccessibleComponentLayer"><span class="returnvalue">AccessibleComponentLayer</span></a> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-getLayer" title="AccessibleComponent_getLayer ()">AccessibleComponent_getLayer</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);
<span class="returnvalue">short</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-getMDIZOrder" title="AccessibleComponent_getMDIZOrder ()">AccessibleComponent_getMDIZOrder</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-grabFocus" title="AccessibleComponent_grabFocus ()">AccessibleComponent_grabFocus</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);
<span class="returnvalue">double</span> <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-getAlpha" title="AccessibleComponent_getAlpha ()">AccessibleComponent_getAlpha</a> (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleComponent-Interface.description"></a><h2>Description</h2>
<p>
The Component interface is implemented by objects which are visible, or are
potentially visible, onscreen. The interface exposes onscreen bounds, the
approximate "layer" in which the object resides, sometimes including z-order
information, and allows objects to explicitly be told to request focus.
</p>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleComponent-Interface.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AccessibleCoordType"></a><h3>enum AccessibleCoordType</h3>
<pre class="programlisting">typedef enum {
SPI_COORD_TYPE_SCREEN,
SPI_COORD_TYPE_WINDOW
} AccessibleCoordType;
</pre>
<p>
Specifies how xy coordinates are to be interpreted. Used by functions such
as <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponent-getPosition" title="AccessibleComponent_getPosition ()"><code class="function">AccessibleComponent_getPosition()</code></a> and <a class="link" href="at-spi-cspi-AccessibleText-Interface.html#AccessibleText-getCharacterExtents" title="AccessibleText_getCharacterExtents ()"><code class="function">AccessibleText_getCharacterExtents()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="SPI-COORD-TYPE-SCREEN:CAPS"></a><span class="term"><code class="literal">SPI_COORD_TYPE_SCREEN</code></span></p></td>
<td>specifies xy coordinates relative to the screen
</td>
</tr>
<tr>
<td><p><a name="SPI-COORD-TYPE-WINDOW:CAPS"></a><span class="term"><code class="literal">SPI_COORD_TYPE_WINDOW</code></span></p></td>
<td>specifies xy coordinates relative to an object's
top-level window
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponentLayer"></a><h3>enum AccessibleComponentLayer</h3>
<pre class="programlisting">typedef enum {
SPI_LAYER_INVALID,
SPI_LAYER_BACKGROUND,
SPI_LAYER_CANVAS,
SPI_LAYER_WIDGET,
SPI_LAYER_MDI,
SPI_LAYER_POPUP,
SPI_LAYER_OVERLAY,
SPI_LAYER_WINDOW,
SPI_LAYER_LAST_DEFINED
} AccessibleComponentLayer;
</pre>
<p>
Describes the layer of a component.
</p>
<p>
These enumerated "layer values" are used when determining which UI
rendering layer a component is drawn into, which can help in making
determinations of when components occlude one another.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="SPI-LAYER-INVALID:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_INVALID</code></span></p></td>
<td>The layer cannot be determined or is somehow undefined.
</td>
</tr>
<tr>
<td><p><a name="SPI-LAYER-BACKGROUND:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_BACKGROUND</code></span></p></td>
<td>Component belongs to the destop background.
</td>
</tr>
<tr>
<td><p><a name="SPI-LAYER-CANVAS:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_CANVAS</code></span></p></td>
<td>Component is a canvas backdrop or drawing area.
</td>
</tr>
<tr>
<td><p><a name="SPI-LAYER-WIDGET:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_WIDGET</code></span></p></td>
<td>Component is a 'normal' widget.
</td>
</tr>
<tr>
<td><p><a name="SPI-LAYER-MDI:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_MDI</code></span></p></td>
<td>Component is drawn in the MDI layer and may have valid
Z-information relative to other MDI-layer components.
</td>
</tr>
<tr>
<td><p><a name="SPI-LAYER-POPUP:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_POPUP</code></span></p></td>
<td>Component is in the popup layer, above other widgets and
MDI components.
</td>
</tr>
<tr>
<td><p><a name="SPI-LAYER-OVERLAY:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_OVERLAY</code></span></p></td>
<td>Component is in the overlay plane - this value is reserved
for future use.
</td>
</tr>
<tr>
<td><p><a name="SPI-LAYER-WINDOW:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_WINDOW</code></span></p></td>
<td>Component is in the window layer and have valid Z-information
relative to other window-layer components.
</td>
</tr>
<tr>
<td><p><a name="SPI-LAYER-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">SPI_LAYER_LAST_DEFINED</code></span></p></td>
<td>Used to determine the last valid value in the enum,
should not be encountered.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-ref"></a><h3>AccessibleComponent_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleComponent_ref (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);</pre>
<p>
Increment the reference count for an <span class="type">AccessibleComponent</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to an object implementing <span class="type">AccessibleComponent</span> on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-unref"></a><h3>AccessibleComponent_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleComponent_unref (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);</pre>
<p>
Decrement the reference count for an <span class="type">AccessibleComponent</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the object implementing <span class="type">AccessibleComponent</span> on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-contains"></a><h3>AccessibleComponent_contains ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleComponent_contains (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> y</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType"><span class="type">AccessibleCoordType</span></a> ctype</code></em>);</pre>
<p>
Query whether a given <span class="type">AccessibleComponent</span> contains a particular point.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleComponent</span> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>a <span class="type">long</span> specifying the x coordinate in question.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>a <span class="type">long</span> specifying the y coordinate in question.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
<td>the desired coordinate system of the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>)
(e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">TRUE</span> if the specified component contains the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>),
otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-getAccessibleAtPoint"></a><h3>AccessibleComponent_getAccessibleAtPoint ()</h3>
<pre class="programlisting"><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="returnvalue">Accessible</span></a> * AccessibleComponent_getAccessibleAtPoint
(<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> y</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType"><span class="type">AccessibleCoordType</span></a> ctype</code></em>);</pre>
<p>
Get the accessible child at a given coordinate within an <span class="type">AccessibleComponent</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleComponent</span> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>a <span class="type">long</span> specifying the x coordinate of the point in question.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>a <span class="type">long</span> specifying the y coordinate of the point in question.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
<td>the coordinate system of the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>)
(e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to an <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> child of the specified component which
contains the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>), or NULL of no child contains the point.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-getExtents"></a><h3>AccessibleComponent_getExtents ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleComponent_getExtents (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *y</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *width</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *height</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType"><span class="type">AccessibleCoordType</span></a> ctype</code></em>);</pre>
<p>
Get the bounding box of the specified <span class="type">AccessibleComponent</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleComponent</span> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>a pointer to a <span class="type">long</span> into which the minimum x coordinate will be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>a pointer to a <span class="type">long</span> into which the minimum y coordinate will be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>a pointer to a <span class="type">long</span> into which the x extents (width) will be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>a pointer to a <span class="type">long</span> into which the y extents (height) will be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
<td>the desired coordinate system into which to return the results,
(e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-getPosition"></a><h3>AccessibleComponent_getPosition ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleComponent_getPosition (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *x</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *y</code></em>,
<em class="parameter"><code><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleCoordType" title="enum AccessibleCoordType"><span class="type">AccessibleCoordType</span></a> ctype</code></em>);</pre>
<p>
Get the minimum x and y coordinates of the specified <span class="type">AccessibleComponent</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleComponent</span> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>a pointer to a <span class="type">long</span> into which the minimum x coordinate will be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>a pointer to a <span class="type">long</span> into which the minimum y coordinate will be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ctype</code></em> :</span></p></td>
<td>the desired coordinate system into which to return the results,
(e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-getSize"></a><h3>AccessibleComponent_getSize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleComponent_getSize (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *width</code></em>,
<em class="parameter"><code>long <span class="type">int</span> *height</code></em>);</pre>
<p>
Get the size of the specified <span class="type">AccessibleComponent</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleComponent</span> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>a pointer to a <span class="type">long</span> into which the x extents (width) will be returned.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>a pointer to a <span class="type">long</span> into which the y extents (height) will be returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-getLayer"></a><h3>AccessibleComponent_getLayer ()</h3>
<pre class="programlisting"><a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponentLayer" title="enum AccessibleComponentLayer"><span class="returnvalue">AccessibleComponentLayer</span></a> AccessibleComponent_getLayer (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);</pre>
<p>
Query which layer the component is painted into, to help determine its
visibility in terms of stacking order.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleComponent</span> to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="at-spi-cspi-AccessibleComponent-Interface.html#AccessibleComponentLayer" title="enum AccessibleComponentLayer"><span class="type">AccessibleComponentLayer</span></a> into which this component is painted.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-getMDIZOrder"></a><h3>AccessibleComponent_getMDIZOrder ()</h3>
<pre class="programlisting"><span class="returnvalue">short</span> AccessibleComponent_getMDIZOrder (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);</pre>
<p>
Query the z stacking order of a component which is in the MDI or window
layer. (Bigger z-order numbers mean nearer the top)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleComponent</span> to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a short integer indicating the stacking order of the component
in the MDI layer, or -1 if the component is not in the MDI layer.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-grabFocus"></a><h3>AccessibleComponent_grabFocus ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleComponent_grabFocus (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);</pre>
<p>
Attempt to set the keyboard input focus to the specified
<span class="type">AccessibleComponent</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleComponent</span> on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleComponent-getAlpha"></a><h3>AccessibleComponent_getAlpha ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> AccessibleComponent_getAlpha (<em class="parameter"><code><span class="type">AccessibleComponent</span> *obj</code></em>);</pre>
<p>
Get the opacity/alpha value of a component, if alpha blending is in use.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>The <span class="type">AccessibleComponent</span> to be queried.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the opacity value of a component, as a double between 0.0 and 1.0.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|