1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>atspi-component: libatspi Reference Manual</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-hypertext.html" title="atspi-hypertext">
10
<link rel="next" href="libatspi-atspi-registry.html" title="atspi-registry">
11
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
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="5"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#libatspi-atspi-component.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#libatspi-atspi-component.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
20
<a href="#libatspi-atspi-component.implementations" class="shortcut">Known Implementations</a></span>
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24
<td><a accesskey="p" href="libatspi-atspi-hypertext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25
<td><a accesskey="n" href="libatspi-atspi-registry.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27
<div class="refentry">
28
<a name="libatspi-atspi-component"></a><div class="titlepage"></div>
29
<div class="refnamediv"><table width="100%"><tr>
31
<h2><span class="refentrytitle"><a name="libatspi-atspi-component.top_of_page"></a>atspi-component</span></h2>
32
<p>atspi-component — An interface implemented by objects which have onscreen visual
35
<td class="gallery_image" valign="top" align="right"></td>
37
<div class="refsect1">
38
<a name="libatspi-atspi-component.functions"></a><h2>Functions</h2>
39
<div class="informaltable"><table width="100%" border="0">
41
<col width="150px" class="functions_return">
42
<col class="functions_name">
46
<td class="define_keyword">#define</td>
47
<td class="function_name"><a class="link" href="libatspi-atspi-component.html#ATSPI-TYPE-RECT:CAPS" title="ATSPI_TYPE_RECT">ATSPI_TYPE_RECT</a></td>
50
<td class="function_type">
51
<a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *
53
<td class="function_name">
54
<a class="link" href="libatspi-atspi-component.html#atspi-rect-copy" title="atspi_rect_copy ()">atspi_rect_copy</a> <span class="c_punctuation">()</span>
58
<td class="define_keyword">#define</td>
59
<td class="function_name"><a class="link" href="libatspi-atspi-component.html#ATSPI-TYPE-POINT:CAPS" title="ATSPI_TYPE_POINT">ATSPI_TYPE_POINT</a></td>
62
<td class="function_type">
63
<span class="returnvalue">GType</span>
65
<td class="function_name">
66
<a class="link" href="libatspi-atspi-component.html#atspi-point-get-type" title="atspi_point_get_type ()">atspi_point_get_type</a> <span class="c_punctuation">()</span>
70
<td class="function_type">
71
<a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *
73
<td class="function_name">
74
<a class="link" href="libatspi-atspi-component.html#atspi-point-copy" title="atspi_point_copy ()">atspi_point_copy</a> <span class="c_punctuation">()</span>
78
<td class="function_type">
79
<span class="returnvalue">GType</span>
81
<td class="function_name">
82
<a class="link" href="libatspi-atspi-component.html#atspi-component-get-type" title="atspi_component_get_type ()">atspi_component_get_type</a> <span class="c_punctuation">()</span>
86
<td class="function_type">
87
<span class="returnvalue">gboolean</span>
89
<td class="function_name">
90
<a class="link" href="libatspi-atspi-component.html#atspi-component-contains" title="atspi_component_contains ()">atspi_component_contains</a> <span class="c_punctuation">()</span>
94
<td class="function_type">
95
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
97
<td class="function_name">
98
<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> <span class="c_punctuation">()</span>
102
<td class="function_type">
103
<a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *
105
<td class="function_name">
106
<a class="link" href="libatspi-atspi-component.html#atspi-component-get-extents" title="atspi_component_get_extents ()">atspi_component_get_extents</a> <span class="c_punctuation">()</span>
110
<td class="function_type">
111
<a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *
113
<td class="function_name">
114
<a class="link" href="libatspi-atspi-component.html#atspi-component-get-position" title="atspi_component_get_position ()">atspi_component_get_position</a> <span class="c_punctuation">()</span>
118
<td class="function_type">
119
<a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *
121
<td class="function_name">
122
<a class="link" href="libatspi-atspi-component.html#atspi-component-get-size" title="atspi_component_get_size ()">atspi_component_get_size</a> <span class="c_punctuation">()</span>
126
<td class="function_type">
127
<a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="returnvalue">AtspiComponentLayer</span></a>
129
<td class="function_name">
130
<a class="link" href="libatspi-atspi-component.html#atspi-component-get-layer" title="atspi_component_get_layer ()">atspi_component_get_layer</a> <span class="c_punctuation">()</span>
134
<td class="function_type">
135
<span class="returnvalue">gshort</span>
137
<td class="function_name">
138
<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> <span class="c_punctuation">()</span>
142
<td class="function_type">
143
<span class="returnvalue">gboolean</span>
145
<td class="function_name">
146
<a class="link" href="libatspi-atspi-component.html#atspi-component-grab-focus" title="atspi_component_grab_focus ()">atspi_component_grab_focus</a> <span class="c_punctuation">()</span>
150
<td class="function_type">
151
<span class="returnvalue">gdouble</span>
153
<td class="function_name">
154
<a class="link" href="libatspi-atspi-component.html#atspi-component-get-alpha" title="atspi_component_get_alpha ()">atspi_component_get_alpha</a> <span class="c_punctuation">()</span>
160
<a name="AtspiRect"></a><a name="AtspiPoint"></a><a name="AtspiComponent"></a><div class="refsect1">
161
<a name="libatspi-atspi-component.other"></a><h2>Types and Values</h2>
162
<div class="informaltable"><table width="100%" border="0">
164
<col width="150px" class="name">
165
<col class="description">
169
<td class="datatype_keyword">struct</td>
170
<td class="function_name"><a class="link" href="libatspi-atspi-component.html#AtspiRect-struct" title="struct AtspiRect">AtspiRect</a></td>
173
<td class="datatype_keyword">struct</td>
174
<td class="function_name"><a class="link" href="libatspi-atspi-component.html#AtspiPoint-struct" title="struct AtspiPoint">AtspiPoint</a></td>
177
<td class="datatype_keyword"> </td>
178
<td class="function_name"><a class="link" href="libatspi-atspi-component.html#AtspiComponent-struct" title="AtspiComponent">AtspiComponent</a></td>
183
<div class="refsect1">
184
<a name="libatspi-atspi-component.object-hierarchy"></a><h2>Object Hierarchy</h2>
185
<pre class="screen"> <a href="/opt/gnome/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
186
<span class="lineart">├──</span> AtspiPoint
187
<span class="lineart">╰──</span> AtspiRect
188
<a href="/opt/gnome/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
189
<span class="lineart">╰──</span> AtspiComponent
192
<div class="refsect1">
193
<a name="libatspi-atspi-component.implementations"></a><h2>Known Implementations</h2>
195
AtspiComponent is implemented by
196
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
198
<div class="refsect1">
199
<a name="libatspi-atspi-component.description"></a><h2>Description</h2>
201
The Component interface is implemented by objects which occupy on-screen
202
space, e.g. objects which have onscreen visual representations. The methods
203
in Component allow clients to identify where the objects lie in the onscreen
204
coordinate system, their relative size, stacking order, and position. It
205
also provides a mechanism whereby keyboard focus may be transferred to
206
specific user interface elements programmatically. This is a 2D API.
207
Coordinates of 3D objects are projected into the 2-dimensional screen view
208
for purposes of this interface.
211
<div class="refsect1">
212
<a name="libatspi-atspi-component.functions_details"></a><h2>Functions</h2>
213
<div class="refsect2">
214
<a name="ATSPI-TYPE-RECT:CAPS"></a><h3>ATSPI_TYPE_RECT</h3>
215
<pre class="programlisting">#define ATSPI_TYPE_RECT (atspi_rect_get_type ())
217
<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>
220
<div class="refsect2">
221
<a name="atspi-rect-copy"></a><h3>atspi_rect_copy ()</h3>
222
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *
223
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>
228
<div class="refsect2">
229
<a name="ATSPI-TYPE-POINT:CAPS"></a><h3>ATSPI_TYPE_POINT</h3>
230
<pre class="programlisting">#define ATSPI_TYPE_POINT (atspi_point_get_type ())
232
<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>
235
<div class="refsect2">
236
<a name="atspi-point-get-type"></a><h3>atspi_point_get_type ()</h3>
237
<pre class="programlisting"><span class="returnvalue">GType</span>
238
atspi_point_get_type ();</pre>
243
<div class="refsect2">
244
<a name="atspi-point-copy"></a><h3>atspi_point_copy ()</h3>
245
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *
246
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>
251
<div class="refsect2">
252
<a name="atspi-component-get-type"></a><h3>atspi_component_get_type ()</h3>
253
<pre class="programlisting"><span class="returnvalue">GType</span>
254
atspi_component_get_type ();</pre>
259
<div class="refsect2">
260
<a name="atspi-component-contains"></a><h3>atspi_component_contains ()</h3>
261
<pre class="programlisting"><span class="returnvalue">gboolean</span>
262
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>,
263
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
264
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
265
<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>,
266
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
267
<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>
268
<div class="refsect3">
269
<a name="id-1.2.22.11.8.5"></a><h4>Parameters</h4>
270
<div class="informaltable"><table width="100%" border="0">
272
<col width="150px" class="parameters_name">
273
<col class="parameters_description">
274
<col width="200px" class="parameters_annotations">
278
<td class="parameter_name"><p>obj</p></td>
279
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</p></td>
280
<td class="parameter_annotations"> </td>
283
<td class="parameter_name"><p>x</p></td>
284
<td class="parameter_description"><p>a <span class="type">gint</span> specifying the x coordinate in question.</p></td>
285
<td class="parameter_annotations"> </td>
288
<td class="parameter_name"><p>y</p></td>
289
<td class="parameter_description"><p>a <span class="type">gint</span> specifying the y coordinate in question.</p></td>
290
<td class="parameter_annotations"> </td>
293
<td class="parameter_name"><p>ctype</p></td>
294
<td class="parameter_description"><p>the desired coordinate system of the point (<em class="parameter"><code>x</code></em>
295
, <em class="parameter"><code>y</code></em>
297
(e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).</p></td>
298
<td class="parameter_annotations"> </td>
303
<div class="refsect3">
304
<a name="id-1.2.22.11.8.6"></a><h4>Returns</h4>
305
<p> <span class="type">TRUE</span> if the specified component contains the point (<em class="parameter"><code>x</code></em>
306
, <em class="parameter"><code>y</code></em>
308
<span class="type">FALSE</span> otherwise.</p>
312
<div class="refsect2">
313
<a name="atspi-component-get-accessible-at-point"></a><h3>atspi_component_get_accessible_at_point ()</h3>
314
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
315
atspi_component_get_accessible_at_point
316
(<em class="parameter"><code><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> *obj</code></em>,
317
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
318
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
319
<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>,
320
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
321
<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>
322
<div class="refsect3">
323
<a name="id-1.2.22.11.9.5"></a><h4>Parameters</h4>
324
<div class="informaltable"><table width="100%" border="0">
326
<col width="150px" class="parameters_name">
327
<col class="parameters_description">
328
<col width="200px" class="parameters_annotations">
332
<td class="parameter_name"><p>obj</p></td>
333
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</p></td>
334
<td class="parameter_annotations"> </td>
337
<td class="parameter_name"><p>x</p></td>
338
<td class="parameter_description"><p>a <span class="type">gint</span> specifying the x coordinate of the point in question.</p></td>
339
<td class="parameter_annotations"> </td>
342
<td class="parameter_name"><p>y</p></td>
343
<td class="parameter_description"><p>a <span class="type">gint</span> specifying the y coordinate of the point in question.</p></td>
344
<td class="parameter_annotations"> </td>
347
<td class="parameter_name"><p>ctype</p></td>
348
<td class="parameter_description"><p>the coordinate system of the point (<em class="parameter"><code>x</code></em>
349
, <em class="parameter"><code>y</code></em>
351
(e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</p></td>
352
<td class="parameter_annotations"> </td>
357
<div class="refsect3">
358
<a name="id-1.2.22.11.9.6"></a><h4>Returns</h4>
360
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> child of the specified component which
361
contains the point (<em class="parameter"><code>x</code></em>
362
, <em class="parameter"><code>y</code></em>
363
), or NULL if no child contains
365
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
369
<div class="refsect2">
370
<a name="atspi-component-get-extents"></a><h3>atspi_component_get_extents ()</h3>
371
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="returnvalue">AtspiRect</span></a> *
372
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>,
373
<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>,
374
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
375
<p>Gets the bounding box of the specified <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.</p>
376
<div class="refsect3">
377
<a name="id-1.2.22.11.10.5"></a><h4>Parameters</h4>
378
<div class="informaltable"><table width="100%" border="0">
380
<col width="150px" class="parameters_name">
381
<col class="parameters_description">
382
<col width="200px" class="parameters_annotations">
386
<td class="parameter_name"><p>obj</p></td>
387
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</p></td>
388
<td class="parameter_annotations"> </td>
391
<td class="parameter_name"><p>ctype</p></td>
392
<td class="parameter_description"><p>the desired coordinate system into which to return the results,
393
(e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</p></td>
394
<td class="parameter_annotations"> </td>
399
<div class="refsect3">
400
<a name="id-1.2.22.11.10.6"></a><h4>Returns</h4>
401
<p> An <a class="link" href="libatspi-atspi-component.html#AtspiRect"><span class="type">AtspiRect</span></a> giving the accessible's extents.</p>
405
<div class="refsect2">
406
<a name="atspi-component-get-position"></a><h3>atspi_component_get_position ()</h3>
407
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *
408
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>,
409
<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>,
410
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
411
<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>
412
<div class="refsect3">
413
<a name="id-1.2.22.11.11.5"></a><h4>Parameters</h4>
414
<div class="informaltable"><table width="100%" border="0">
416
<col width="150px" class="parameters_name">
417
<col class="parameters_description">
418
<col width="200px" class="parameters_annotations">
422
<td class="parameter_name"><p>obj</p></td>
423
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</p></td>
424
<td class="parameter_annotations"> </td>
427
<td class="parameter_name"><p>ctype</p></td>
428
<td class="parameter_description"><p>the desired coordinate system into which to return the results,
429
(e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).</p></td>
430
<td class="parameter_annotations"> </td>
435
<div class="refsect3">
436
<a name="id-1.2.22.11.11.6"></a><h4>Returns</h4>
437
<p> 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>
442
<div class="refsect2">
443
<a name="atspi-component-get-size"></a><h3>atspi_component_get_size ()</h3>
444
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiPoint"><span class="returnvalue">AtspiPoint</span></a> *
445
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>,
446
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
447
<p>Gets the size of the specified <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.</p>
448
<div class="refsect3">
449
<a name="id-1.2.22.11.12.5"></a><h4>Parameters</h4>
450
<div class="informaltable"><table width="100%" border="0">
452
<col width="150px" class="parameters_name">
453
<col class="parameters_description">
454
<col width="200px" class="parameters_annotations">
457
<td class="parameter_name"><p>obj</p></td>
458
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</p></td>
459
<td class="parameter_annotations"> </td>
463
<div class="refsect3">
464
<a name="id-1.2.22.11.12.6"></a><h4>Returns</h4>
465
<p> 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>
470
<div class="refsect2">
471
<a name="atspi-component-get-layer"></a><h3>atspi_component_get_layer ()</h3>
472
<pre class="programlisting"><a class="link" href="libatspi-atspi-constants.html#AtspiComponentLayer" title="enum AtspiComponentLayer"><span class="returnvalue">AtspiComponentLayer</span></a>
473
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>,
474
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
475
<p>Queries which layer the component is painted into, to help determine its
476
visibility in terms of stacking order.</p>
477
<div class="refsect3">
478
<a name="id-1.2.22.11.13.5"></a><h4>Parameters</h4>
479
<div class="informaltable"><table width="100%" border="0">
481
<col width="150px" class="parameters_name">
482
<col class="parameters_description">
483
<col width="200px" class="parameters_annotations">
486
<td class="parameter_name"><p>obj</p></td>
487
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</p></td>
488
<td class="parameter_annotations"> </td>
492
<div class="refsect3">
493
<a name="id-1.2.22.11.13.6"></a><h4>Returns</h4>
494
<p> 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.</p>
498
<div class="refsect2">
499
<a name="atspi-component-get-mdi-z-order"></a><h3>atspi_component_get_mdi_z_order ()</h3>
500
<pre class="programlisting"><span class="returnvalue">gshort</span>
501
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>,
502
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
503
<p>Queries the z stacking order of a component which is in the MDI or window
504
layer. (Bigger z-order numbers mean nearer the top)</p>
505
<div class="refsect3">
506
<a name="id-1.2.22.11.14.5"></a><h4>Parameters</h4>
507
<div class="informaltable"><table width="100%" border="0">
509
<col width="150px" class="parameters_name">
510
<col class="parameters_description">
511
<col width="200px" class="parameters_annotations">
514
<td class="parameter_name"><p>obj</p></td>
515
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to query.</p></td>
516
<td class="parameter_annotations"> </td>
520
<div class="refsect3">
521
<a name="id-1.2.22.11.14.6"></a><h4>Returns</h4>
522
<p> a <span class="type">gshort</span> indicating the stacking order of the component
523
in the MDI layer, or -1 if the component is not in the MDI layer.</p>
527
<div class="refsect2">
528
<a name="atspi-component-grab-focus"></a><h3>atspi_component_grab_focus ()</h3>
529
<pre class="programlisting"><span class="returnvalue">gboolean</span>
530
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>,
531
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
532
<p>Attempts to set the keyboard input focus to the specified
533
<a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>.</p>
534
<div class="refsect3">
535
<a name="id-1.2.22.11.15.5"></a><h4>Parameters</h4>
536
<div class="informaltable"><table width="100%" border="0">
538
<col width="150px" class="parameters_name">
539
<col class="parameters_description">
540
<col width="200px" class="parameters_annotations">
543
<td class="parameter_name"><p>obj</p></td>
544
<td class="parameter_description"><p>a pointer to the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> on which to operate.</p></td>
545
<td class="parameter_annotations"> </td>
549
<div class="refsect3">
550
<a name="id-1.2.22.11.15.6"></a><h4>Returns</h4>
551
<p> <span class="type">TRUE</span> if successful, <span class="type">FALSE</span> otherwise.</p>
555
<div class="refsect2">
556
<a name="atspi-component-get-alpha"></a><h3>atspi_component_get_alpha ()</h3>
557
<pre class="programlisting"><span class="returnvalue">gdouble</span>
558
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>,
559
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
560
<p>Gets the opacity/alpha value of a component, if alpha blending is in use.</p>
561
<div class="refsect3">
562
<a name="id-1.2.22.11.16.5"></a><h4>Parameters</h4>
563
<div class="informaltable"><table width="100%" border="0">
565
<col width="150px" class="parameters_name">
566
<col class="parameters_description">
567
<col width="200px" class="parameters_annotations">
570
<td class="parameter_name"><p>obj</p></td>
571
<td class="parameter_description"><p>The <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> to be queried.</p></td>
572
<td class="parameter_annotations"> </td>
576
<div class="refsect3">
577
<a name="id-1.2.22.11.16.6"></a><h4>Returns</h4>
578
<p> the opacity value of a component, as a <span class="type">gdouble</span> between 0.0 and 1.0. </p>
582
<div class="refsect1">
583
<a name="libatspi-atspi-component.other_details"></a><h2>Types and Values</h2>
584
<div class="refsect2">
585
<a name="AtspiRect-struct"></a><h3>struct AtspiRect</h3>
586
<pre class="programlisting">struct AtspiRect {
597
<div class="refsect2">
598
<a name="AtspiPoint-struct"></a><h3>struct AtspiPoint</h3>
599
<pre class="programlisting">struct AtspiPoint {
608
<div class="refsect2">
609
<a name="AtspiComponent-struct"></a><h3>AtspiComponent</h3>
610
<pre class="programlisting">typedef struct _AtspiComponent AtspiComponent;</pre>
617
<hr>Generated by GTK-Doc V1.24.1</div>
b'\\ No newline at end of file'
added
removed
doc/libatspi/html/libatspi-atspi-component.html
