This file is indexed.

/usr/share/gtk-doc/html/libatspi/libatspi-atspi-component.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
442
443
444
445
446
447
448
449
450
451
452
453
454
<!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-component</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-hypertext.html" title="atspi-hypertext">
<link rel="next" href="libatspi-atspi-registry.html" title="atspi-registry">
<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-hypertext.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-registry.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-component.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libatspi-atspi-component.description" class="shortcut">Description</a>
                   | 
                  <a href="#libatspi-atspi-component.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libatspi-atspi-component.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-component"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-component.top_of_page"></a>atspi-component</span></h2>
<p>atspi-component —  An interface implemented by objects which have onscreen visual
 representations.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-component.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiRect"></a><a name="AtspiPoint"></a><a name="AtspiComponent"></a><pre class="synopsis">struct              <a class="link" href="libatspi-atspi-component.html#AtspiRect-struct" title="struct AtspiRect">AtspiRect</a>;
#define             <a class="link" href="libatspi-atspi-component.html#ATSPI-TYPE-RECT:CAPS" title="ATSPI_TYPE_RECT">ATSPI_TYPE_RECT</a>
<a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         <a class="link" href="libatspi-atspi-component.html#atspi-rect-copy" title="atspi_rect_copy ()">atspi_rect_copy</a>                     (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> *src</code></em>);
struct              <a class="link" href="libatspi-atspi-component.html#AtspiPoint-struct" title="struct AtspiPoint">AtspiPoint</a>;
#define             <a class="link" href="libatspi-atspi-component.html#ATSPI-TYPE-POINT:CAPS" title="ATSPI_TYPE_POINT">ATSPI_TYPE_POINT</a>
<span class="returnvalue">GType</span>               <a class="link" href="libatspi-atspi-component.html#atspi-point-get-type" title="atspi_point_get_type ()">atspi_point_get_type</a>                ();
<a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        <a class="link" href="libatspi-atspi-component.html#atspi-point-copy" title="atspi_point_copy ()">atspi_point_copy</a>                    (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> *src</code></em>);
<span class="returnvalue">GType</span>               <a class="link" href="libatspi-atspi-component.html#atspi-component-get-type" title="atspi_component_get_type ()">atspi_component_get_type</a>            ();
                    <a class="link" href="libatspi-atspi-component.html#AtspiComponent-struct" title="AtspiComponent">AtspiComponent</a>;
<span class="returnvalue">gboolean</span>            <a class="link" href="libatspi-atspi-component.html#atspi-component-contains" title="atspi_component_contains ()">atspi_component_contains</a>            (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> x</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> y</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *   <a class="link" href="libatspi-atspi-component.html#atspi-component-get-accessible-at-point" title="atspi_component_get_accessible_at_point ()">atspi_component_get_accessible_at_point</a>
                                                        (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> x</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> y</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         <a class="link" href="libatspi-atspi-component.html#atspi-component-get-extents" title="atspi_component_get_extents ()">atspi_component_get_extents</a>         (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        <a class="link" href="libatspi-atspi-component.html#atspi-component-get-position" title="atspi_component_get_position ()">atspi_component_get_position</a>        (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        <a class="link" href="libatspi-atspi-component.html#atspi-component-get-size" title="atspi_component_get_size ()">atspi_component_get_size</a>            (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="returnvalue">AtspiComponentLayer</span></a> <a class="link" href="libatspi-atspi-component.html#atspi-component-get-layer" title="atspi_component_get_layer ()">atspi_component_get_layer</a>           (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gshort</span>              <a class="link" href="libatspi-atspi-component.html#atspi-component-get-mdi-z-order" title="atspi_component_get_mdi_z_order ()">atspi_component_get_mdi_z_order</a>     (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libatspi-atspi-component.html#atspi-component-grab-focus" title="atspi_component_grab_focus ()">atspi_component_grab_focus</a>          (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gdouble</span>             <a class="link" href="libatspi-atspi-component.html#atspi-component-get-alpha" title="atspi_component_get_alpha ()">atspi_component_get_alpha</a>           (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-component.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GBoxed
   +----AtspiRect
</pre>
<pre class="synopsis">
  GBoxed
   +----AtspiPoint
</pre>
<pre class="synopsis">
  GInterface
   +----AtspiComponent
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-component.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiComponent is implemented by
 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-component.description"></a><h2>Description</h2>
<p>
  The Component interface is implemented by objects which occupy on-screen
  space, e.g. objects which have onscreen visual representations. The methods
  in Component allow clients to identify where the objects lie in the onscreen
  coordinate system, their relative size, stacking order, and position. It
  also provides a mechanism whereby keyboard focus may be transferred to
  specific user interface elements programmatically.  This is a 2D API.
  Coordinates of 3D objects are projected into the 2-dimensional screen view
  for purposes of this interface.
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-component.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiRect-struct"></a><h3>struct AtspiRect</h3>
<pre class="programlisting">struct AtspiRect {
  gint x;
  gint y;
  gint width;
  gint height;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-TYPE-RECT:CAPS"></a><h3>ATSPI_TYPE_RECT</h3>
<pre class="programlisting">#define ATSPI_TYPE_RECT (atspi_rect_get_type ())
</pre>
<p>
The <span class="type">GType</span> for a boxed type holding a <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-rect-copy"></a><h3>atspi_rect_copy ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         atspi_rect_copy                     (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> *src</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiPoint-struct"></a><h3>struct AtspiPoint</h3>
<pre class="programlisting">struct AtspiPoint {
  gint x;
  gint y;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="ATSPI-TYPE-POINT:CAPS"></a><h3>ATSPI_TYPE_POINT</h3>
<pre class="programlisting">#define ATSPI_TYPE_POINT (atspi_point_get_type ())
</pre>
<p>
The <span class="type">GType</span> for a boxed type holding a <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-point-get-type"></a><h3>atspi_point_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>               atspi_point_get_type                ();</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-point-copy"></a><h3>atspi_point_copy ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        atspi_point_copy                    (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> *src</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-component-get-type"></a><h3>atspi_component_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>               atspi_component_get_type            ();</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="atspi-component-contains"></a><h3>atspi_component_contains ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atspi_component_contains            (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> x</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> y</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Queries whether a given <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> 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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> 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">gint</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">gint</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. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).</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 the specified component contains the point (<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>),
<span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-component-get-accessible-at-point"></a><h3>atspi_component_get_accessible_at_point ()</h3>
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *   atspi_component_get_accessible_at_point
                                                        (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> x</code></em>,
                                                         <em class="parameter"><code><span class="type">gint</span> y</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the accessible child at a given coordinate within an <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
</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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> 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">gint</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">gint</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. ATSPI_COORD_TYPE_WINDOW, ATSPI_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="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</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 if
no child contains the point. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-component-get-extents"></a><h3>atspi_component_get_extents ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *         atspi_component_get_extents         (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the bounding box of the specified <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
</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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</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. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> giving the accessible's extents.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-component-get-position"></a><h3>atspi_component_get_position ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        atspi_component_get_position        (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCoordType" title="enum AtspiCoordType"><span class="type">AtspiCoordType</span></a> ctype</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the minimum x and y coordinates of the specified <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
</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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</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. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> giving the <em class="parameter"><code>obj</code></em>'s position.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-component-get-size"></a><h3>atspi_component_get_size ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *        atspi_component_get_size            (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the size of the specified <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
</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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="type">AtspiPoint</span></a> giving the <em class="parameter"><code>obj</code></em>'s size.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-component-get-layer"></a><h3>atspi_component_get_layer ()</h3>
<pre class="programlisting"><a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="returnvalue">AtspiComponentLayer</span></a> atspi_component_get_layer           (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Queries 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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> 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="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="type">AtspiComponentLayer</span></a> into which this component is painted.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-component-get-mdi-z-order"></a><h3>atspi_component_get_mdi_z_order ()</h3>
<pre class="programlisting"><span class="returnvalue">gshort</span>              atspi_component_get_mdi_z_order     (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Queries 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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <span class="type">gshort</span> 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="atspi-component-grab-focus"></a><h3>atspi_component_grab_focus ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            atspi_component_grab_focus          (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Attempts to set the keyboard input focus to the specified
        <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.
</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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> 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="atspi-component-get-alpha"></a><h3>atspi_component_get_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>             atspi_component_get_alpha           (<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets 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 <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> 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 <span class="type">gdouble</span> 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>