← Back to branch summary

~ubuntu-branches/ubuntu/lucid/at-spi/lucid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/cspi/xml/spi_component.xml

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2010-07-02 15:50:32 UTC
  • mfrom: (1.2.1 upstream) (0.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20100702155032-mw7vioq2owm3a809
Tags: 1.30.1-0ubuntu1
https://launchpad.net/bugs/600906
* New upstream release (LP: #600906)
  -  Fixes GNOME bugzilla #538680, collection.getMatchesTo() seems to ignore
     the count.
  - Updated translations:

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/xml/spi_component.xml
1
 
<refentry id="at-spi-cspi-AccessibleComponent-Interface">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="at-spi-cspi-AccessibleComponent-Interface.top_of_page">AccessibleComponent Interface</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>AT-SPI-CSPI Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>AccessibleComponent Interface</refname>
10
 
<refpurpose>An interface implemented by objects which occupy area on screen.</refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="at-spi-cspi-AccessibleComponent-Interface.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
enum                <link linkend="AccessibleCoordType">AccessibleCoordType</link>;
18
 
enum                <link linkend="AccessibleComponentLayer">AccessibleComponentLayer</link>;
19
 
<link linkend="void">void</link>                <link linkend="AccessibleComponent-ref">AccessibleComponent_ref</link>             (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);
20
 
<link linkend="void">void</link>                <link linkend="AccessibleComponent-unref">AccessibleComponent_unref</link>           (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);
21
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleComponent-contains">AccessibleComponent_contains</link>        (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
22
 
                                                         long <link linkend="int">int</link> x,
23
 
                                                         long <link linkend="int">int</link> y,
24
 
                                                         <link linkend="AccessibleCoordType">AccessibleCoordType</link> ctype);
25
 
<link linkend="Accessible">Accessible</link> *        <link linkend="AccessibleComponent-getAccessibleAtPoint">AccessibleComponent_getAccessibleAtPoint</link>
26
 
                                                        (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
27
 
                                                         long <link linkend="int">int</link> x,
28
 
                                                         long <link linkend="int">int</link> y,
29
 
                                                         <link linkend="AccessibleCoordType">AccessibleCoordType</link> ctype);
30
 
<link linkend="void">void</link>                <link linkend="AccessibleComponent-getExtents">AccessibleComponent_getExtents</link>      (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
31
 
                                                         long <link linkend="int">int</link> *x,
32
 
                                                         long <link linkend="int">int</link> *y,
33
 
                                                         long <link linkend="int">int</link> *width,
34
 
                                                         long <link linkend="int">int</link> *height,
35
 
                                                         <link linkend="AccessibleCoordType">AccessibleCoordType</link> ctype);
36
 
<link linkend="void">void</link>                <link linkend="AccessibleComponent-getPosition">AccessibleComponent_getPosition</link>     (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
37
 
                                                         long <link linkend="int">int</link> *x,
38
 
                                                         long <link linkend="int">int</link> *y,
39
 
                                                         <link linkend="AccessibleCoordType">AccessibleCoordType</link> ctype);
40
 
<link linkend="void">void</link>                <link linkend="AccessibleComponent-getSize">AccessibleComponent_getSize</link>         (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
41
 
                                                         long <link linkend="int">int</link> *width,
42
 
                                                         long <link linkend="int">int</link> *height);
43
 
<link linkend="AccessibleComponentLayer">AccessibleComponentLayer</link>  <link linkend="AccessibleComponent-getLayer">AccessibleComponent_getLayer</link>  (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);
44
 
<link linkend="short">short</link>               <link linkend="AccessibleComponent-getMDIZOrder">AccessibleComponent_getMDIZOrder</link>    (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);
45
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleComponent-grabFocus">AccessibleComponent_grabFocus</link>       (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);
46
 
<link linkend="double">double</link>              <link linkend="AccessibleComponent-getAlpha">AccessibleComponent_getAlpha</link>        (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);
47
 
</synopsis>
48
 
</refsynopsisdiv>
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
<refsect1 id="at-spi-cspi-AccessibleComponent-Interface.description" role="desc">
59
 
<title role="desc.title">Description</title>
60
 
<para>
61
 
The Component interface is implemented by objects which are visible, or are
62
 
potentially visible, onscreen.  The interface exposes onscreen bounds, the
63
 
approximate "layer" in which the object resides, sometimes including z-order
64
 
information, and allows objects to explicitly be told to request focus.
65
 
</para>
66
 
</refsect1>
67
 
 
68
 
<refsect1 id="at-spi-cspi-AccessibleComponent-Interface.details" role="details">
69
 
<title role="details.title">Details</title>
70
 
<refsect2 id="AccessibleCoordType" role="enum">
71
 
<title>enum AccessibleCoordType</title>
72
 
<indexterm zone="AccessibleCoordType"><primary sortas="AccessibleCoordType">AccessibleCoordType</primary></indexterm><programlisting>typedef enum {
73
 
  SPI_COORD_TYPE_SCREEN,
74
 
  SPI_COORD_TYPE_WINDOW
75
 
} AccessibleCoordType;
76
 
</programlisting>
77
 
<para>
78
 
Specifies how xy coordinates are to be interpreted. Used by functions such
79
 
as <link linkend="AccessibleComponent-getPosition"><function>AccessibleComponent_getPosition()</function></link> and <link linkend="AccessibleText-getCharacterExtents"><function>AccessibleText_getCharacterExtents()</function></link></para>
80
 
<para>
81
 
</para><variablelist role="enum">
82
 
<varlistentry id="SPI-COORD-TYPE-SCREEN--CAPS" role="constant">
83
 
<term><literal>SPI_COORD_TYPE_SCREEN</literal></term>
84
 
<listitem><simpara> specifies xy coordinates relative to the screen
85
 
</simpara></listitem>
86
 
</varlistentry>
87
 
<varlistentry id="SPI-COORD-TYPE-WINDOW--CAPS" role="constant">
88
 
<term><literal>SPI_COORD_TYPE_WINDOW</literal></term>
89
 
<listitem><simpara> specifies xy coordinates relative to an object's
90
 
top-level window
91
 
</simpara></listitem>
92
 
</varlistentry>
93
 
</variablelist></refsect2>
94
 
<refsect2 id="AccessibleComponentLayer" role="enum">
95
 
<title>enum AccessibleComponentLayer</title>
96
 
<indexterm zone="AccessibleComponentLayer"><primary sortas="AccessibleComponentLayer">AccessibleComponentLayer</primary></indexterm><programlisting>typedef enum {
97
 
    SPI_LAYER_INVALID,
98
 
    SPI_LAYER_BACKGROUND,
99
 
    SPI_LAYER_CANVAS,
100
 
    SPI_LAYER_WIDGET,
101
 
    SPI_LAYER_MDI,
102
 
    SPI_LAYER_POPUP,
103
 
    SPI_LAYER_OVERLAY,
104
 
    SPI_LAYER_WINDOW,
105
 
    SPI_LAYER_LAST_DEFINED      
106
 
} AccessibleComponentLayer;
107
 
</programlisting>
108
 
<para>
109
 
Describes the layer of a component.
110
 
</para>
111
 
<para>
112
 
These enumerated "layer values" are used when determining which UI
113
 
rendering layer a component is drawn into, which can help in making
114
 
determinations of when components occlude one another.</para>
115
 
<para>
116
 
</para><variablelist role="enum">
117
 
<varlistentry id="SPI-LAYER-INVALID--CAPS" role="constant">
118
 
<term><literal>SPI_LAYER_INVALID</literal></term>
119
 
<listitem><simpara> The layer cannot be determined or is somehow undefined.
120
 
</simpara></listitem>
121
 
</varlistentry>
122
 
<varlistentry id="SPI-LAYER-BACKGROUND--CAPS" role="constant">
123
 
<term><literal>SPI_LAYER_BACKGROUND</literal></term>
124
 
<listitem><simpara> Component belongs to the destop background.
125
 
</simpara></listitem>
126
 
</varlistentry>
127
 
<varlistentry id="SPI-LAYER-CANVAS--CAPS" role="constant">
128
 
<term><literal>SPI_LAYER_CANVAS</literal></term>
129
 
<listitem><simpara> Component is a canvas backdrop or drawing area.
130
 
</simpara></listitem>
131
 
</varlistentry>
132
 
<varlistentry id="SPI-LAYER-WIDGET--CAPS" role="constant">
133
 
<term><literal>SPI_LAYER_WIDGET</literal></term>
134
 
<listitem><simpara> Component is a 'normal' widget.
135
 
</simpara></listitem>
136
 
</varlistentry>
137
 
<varlistentry id="SPI-LAYER-MDI--CAPS" role="constant">
138
 
<term><literal>SPI_LAYER_MDI</literal></term>
139
 
<listitem><simpara> Component is drawn in the MDI layer and may have valid
140
 
                        Z-information relative to other MDI-layer components.
141
 
</simpara></listitem>
142
 
</varlistentry>
143
 
<varlistentry id="SPI-LAYER-POPUP--CAPS" role="constant">
144
 
<term><literal>SPI_LAYER_POPUP</literal></term>
145
 
<listitem><simpara> Component is in the popup layer, above other widgets and
146
 
                        MDI components.
147
 
</simpara></listitem>
148
 
</varlistentry>
149
 
<varlistentry id="SPI-LAYER-OVERLAY--CAPS" role="constant">
150
 
<term><literal>SPI_LAYER_OVERLAY</literal></term>
151
 
<listitem><simpara> Component is in the overlay plane - this value is reserved
152
 
                        for future use.
153
 
</simpara></listitem>
154
 
</varlistentry>
155
 
<varlistentry id="SPI-LAYER-WINDOW--CAPS" role="constant">
156
 
<term><literal>SPI_LAYER_WINDOW</literal></term>
157
 
<listitem><simpara> Component is in the window layer and have valid Z-information
158
 
                  relative to other window-layer components.
159
 
</simpara></listitem>
160
 
</varlistentry>
161
 
<varlistentry id="SPI-LAYER-LAST-DEFINED--CAPS" role="constant">
162
 
<term><literal>SPI_LAYER_LAST_DEFINED</literal></term>
163
 
<listitem><simpara> Used to determine the last valid value in the enum,
164
 
                        should not be encountered.      
165
 
</simpara></listitem>
166
 
</varlistentry>
167
 
</variablelist></refsect2>
168
 
<refsect2 id="AccessibleComponent-ref" role="function">
169
 
<title>AccessibleComponent_ref ()</title>
170
 
<indexterm zone="AccessibleComponent-ref"><primary sortas="AccessibleComponent_ref">AccessibleComponent_ref</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleComponent_ref             (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);</programlisting>
171
 
<para>
172
 
Increment the reference count for an <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link>.</para>
173
 
<para>
174
 
</para><variablelist role="params">
175
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
176
 
<listitem><simpara> a pointer to an object implementing <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> on which to operate.
177
 
</simpara></listitem></varlistentry>
178
 
</variablelist></refsect2>
179
 
<refsect2 id="AccessibleComponent-unref" role="function">
180
 
<title>AccessibleComponent_unref ()</title>
181
 
<indexterm zone="AccessibleComponent-unref"><primary sortas="AccessibleComponent_unref">AccessibleComponent_unref</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleComponent_unref           (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);</programlisting>
182
 
<para>
183
 
Decrement the reference count for an <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link>.</para>
184
 
<para>
185
 
</para><variablelist role="params">
186
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
187
 
<listitem><simpara> a pointer to the object implementing <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> on which to operate.
188
 
</simpara></listitem></varlistentry>
189
 
</variablelist></refsect2>
190
 
<refsect2 id="AccessibleComponent-contains" role="function">
191
 
<title>AccessibleComponent_contains ()</title>
192
 
<indexterm zone="AccessibleComponent-contains"><primary sortas="AccessibleComponent_contains">AccessibleComponent_contains</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleComponent_contains        (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
193
 
                                                         long <link linkend="int">int</link> x,
194
 
                                                         long <link linkend="int">int</link> y,
195
 
                                                         <link linkend="AccessibleCoordType">AccessibleCoordType</link> ctype);</programlisting>
196
 
<para>
197
 
Query whether a given <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> contains a particular point.</para>
198
 
<para>
199
 
</para><variablelist role="params">
200
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
201
 
<listitem><simpara> a pointer to the <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> to query.
202
 
</simpara></listitem></varlistentry>
203
 
<varlistentry><term><parameter>x</parameter>&#160;:</term>
204
 
<listitem><simpara> a <link linkend="long"><type>long</type></link> specifying the x coordinate in question.
205
 
</simpara></listitem></varlistentry>
206
 
<varlistentry><term><parameter>y</parameter>&#160;:</term>
207
 
<listitem><simpara> a <link linkend="long"><type>long</type></link> specifying the y coordinate in question.
208
 
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><parameter>ctype</parameter>&#160;:</term>
210
 
<listitem><simpara> the desired coordinate system of the point (<parameter>x</parameter>, <parameter>y</parameter>)
211
 
        (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
212
 
</simpara></listitem></varlistentry>
213
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the specified component contains the point (<parameter>x</parameter>, <parameter>y</parameter>),
214
 
         otherwise <link linkend="FALSE--CAPS"><type>FALSE</type></link>.
215
 
</simpara></listitem></varlistentry>
216
 
</variablelist></refsect2>
217
 
<refsect2 id="AccessibleComponent-getAccessibleAtPoint" role="function">
218
 
<title>AccessibleComponent_getAccessibleAtPoint ()</title>
219
 
<indexterm zone="AccessibleComponent-getAccessibleAtPoint"><primary sortas="AccessibleComponent_getAccessibleAtPoint">AccessibleComponent_getAccessibleAtPoint</primary></indexterm><programlisting><link linkend="Accessible">Accessible</link> *        AccessibleComponent_getAccessibleAtPoint
220
 
                                                        (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
221
 
                                                         long <link linkend="int">int</link> x,
222
 
                                                         long <link linkend="int">int</link> y,
223
 
                                                         <link linkend="AccessibleCoordType">AccessibleCoordType</link> ctype);</programlisting>
224
 
<para>
225
 
Get the accessible child at a given coordinate within an <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link>.</para>
226
 
<para>
227
 
</para><variablelist role="params">
228
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
229
 
<listitem><simpara> a pointer to the <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> to query.
230
 
</simpara></listitem></varlistentry>
231
 
<varlistentry><term><parameter>x</parameter>&#160;:</term>
232
 
<listitem><simpara> a <link linkend="long"><type>long</type></link> specifying the x coordinate of the point in question.
233
 
</simpara></listitem></varlistentry>
234
 
<varlistentry><term><parameter>y</parameter>&#160;:</term>
235
 
<listitem><simpara> a <link linkend="long"><type>long</type></link> specifying the y coordinate of the point in question.
236
 
</simpara></listitem></varlistentry>
237
 
<varlistentry><term><parameter>ctype</parameter>&#160;:</term>
238
 
<listitem><simpara> the coordinate system of the point (<parameter>x</parameter>, <parameter>y</parameter>)
239
 
        (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
240
 
</simpara></listitem></varlistentry>
241
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to an <link linkend="Accessible"><type>Accessible</type></link> child of the specified component which
242
 
         contains the point (<parameter>x</parameter>, <parameter>y</parameter>), or NULL of no child contains the point.
243
 
</simpara></listitem></varlistentry>
244
 
</variablelist></refsect2>
245
 
<refsect2 id="AccessibleComponent-getExtents" role="function">
246
 
<title>AccessibleComponent_getExtents ()</title>
247
 
<indexterm zone="AccessibleComponent-getExtents"><primary sortas="AccessibleComponent_getExtents">AccessibleComponent_getExtents</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleComponent_getExtents      (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
248
 
                                                         long <link linkend="int">int</link> *x,
249
 
                                                         long <link linkend="int">int</link> *y,
250
 
                                                         long <link linkend="int">int</link> *width,
251
 
                                                         long <link linkend="int">int</link> *height,
252
 
                                                         <link linkend="AccessibleCoordType">AccessibleCoordType</link> ctype);</programlisting>
253
 
<para>
254
 
Get the bounding box of the specified <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link>.</para>
255
 
<para>
256
 
</para><variablelist role="params">
257
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
258
 
<listitem><simpara> a pointer to the <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> to query.
259
 
</simpara></listitem></varlistentry>
260
 
<varlistentry><term><parameter>x</parameter>&#160;:</term>
261
 
<listitem><simpara> a pointer to a <link linkend="long"><type>long</type></link> into which the minimum x coordinate will be returned.
262
 
</simpara></listitem></varlistentry>
263
 
<varlistentry><term><parameter>y</parameter>&#160;:</term>
264
 
<listitem><simpara> a pointer to a <link linkend="long"><type>long</type></link> into which the minimum y coordinate will be returned.
265
 
</simpara></listitem></varlistentry>
266
 
<varlistentry><term><parameter>width</parameter>&#160;:</term>
267
 
<listitem><simpara> a pointer to a <link linkend="long"><type>long</type></link> into which the x extents (width) will be returned.
268
 
</simpara></listitem></varlistentry>
269
 
<varlistentry><term><parameter>height</parameter>&#160;:</term>
270
 
<listitem><simpara> a pointer to a <link linkend="long"><type>long</type></link> into which the y extents (height) will be returned.
271
 
</simpara></listitem></varlistentry>
272
 
<varlistentry><term><parameter>ctype</parameter>&#160;:</term>
273
 
<listitem><simpara> the desired coordinate system into which to return the results,
274
 
        (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
275
 
</simpara></listitem></varlistentry>
276
 
</variablelist></refsect2>
277
 
<refsect2 id="AccessibleComponent-getPosition" role="function">
278
 
<title>AccessibleComponent_getPosition ()</title>
279
 
<indexterm zone="AccessibleComponent-getPosition"><primary sortas="AccessibleComponent_getPosition">AccessibleComponent_getPosition</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleComponent_getPosition     (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
280
 
                                                         long <link linkend="int">int</link> *x,
281
 
                                                         long <link linkend="int">int</link> *y,
282
 
                                                         <link linkend="AccessibleCoordType">AccessibleCoordType</link> ctype);</programlisting>
283
 
<para>
284
 
Get the minimum x and y coordinates of the specified <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link>.</para>
285
 
<para>
286
 
</para><variablelist role="params">
287
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
288
 
<listitem><simpara> a pointer to the <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> to query.
289
 
</simpara></listitem></varlistentry>
290
 
<varlistentry><term><parameter>x</parameter>&#160;:</term>
291
 
<listitem><simpara> a pointer to a <link linkend="long"><type>long</type></link> into which the minimum x coordinate will be returned.
292
 
</simpara></listitem></varlistentry>
293
 
<varlistentry><term><parameter>y</parameter>&#160;:</term>
294
 
<listitem><simpara> a pointer to a <link linkend="long"><type>long</type></link> into which the minimum y coordinate will be returned.
295
 
</simpara></listitem></varlistentry>
296
 
<varlistentry><term><parameter>ctype</parameter>&#160;:</term>
297
 
<listitem><simpara> the desired coordinate system into which to return the results,
298
 
        (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
299
 
</simpara></listitem></varlistentry>
300
 
</variablelist></refsect2>
301
 
<refsect2 id="AccessibleComponent-getSize" role="function">
302
 
<title>AccessibleComponent_getSize ()</title>
303
 
<indexterm zone="AccessibleComponent-getSize"><primary sortas="AccessibleComponent_getSize">AccessibleComponent_getSize</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleComponent_getSize         (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj,
304
 
                                                         long <link linkend="int">int</link> *width,
305
 
                                                         long <link linkend="int">int</link> *height);</programlisting>
306
 
<para>
307
 
Get the size of the specified <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link>.</para>
308
 
<para>
309
 
</para><variablelist role="params">
310
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
311
 
<listitem><simpara> a pointer to the <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> to query.
312
 
</simpara></listitem></varlistentry>
313
 
<varlistentry><term><parameter>width</parameter>&#160;:</term>
314
 
<listitem><simpara> a pointer to a <link linkend="long"><type>long</type></link> into which the x extents (width) will be returned.
315
 
</simpara></listitem></varlistentry>
316
 
<varlistentry><term><parameter>height</parameter>&#160;:</term>
317
 
<listitem><simpara> a pointer to a <link linkend="long"><type>long</type></link> into which the y extents (height) will be returned.
318
 
</simpara></listitem></varlistentry>
319
 
</variablelist></refsect2>
320
 
<refsect2 id="AccessibleComponent-getLayer" role="function">
321
 
<title>AccessibleComponent_getLayer ()</title>
322
 
<indexterm zone="AccessibleComponent-getLayer"><primary sortas="AccessibleComponent_getLayer">AccessibleComponent_getLayer</primary></indexterm><programlisting><link linkend="AccessibleComponentLayer">AccessibleComponentLayer</link>  AccessibleComponent_getLayer  (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);</programlisting>
323
 
<para>
324
 
Query which layer the component is painted into, to help determine its 
325
 
     visibility in terms of stacking order.</para>
326
 
<para>
327
 
</para><variablelist role="params">
328
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
329
 
<listitem><simpara> a pointer to the <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> to query.
330
 
</simpara></listitem></varlistentry>
331
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the <link linkend="AccessibleComponentLayer"><type>AccessibleComponentLayer</type></link> into which this component is painted.
332
 
</simpara></listitem></varlistentry>
333
 
</variablelist></refsect2>
334
 
<refsect2 id="AccessibleComponent-getMDIZOrder" role="function">
335
 
<title>AccessibleComponent_getMDIZOrder ()</title>
336
 
<indexterm zone="AccessibleComponent-getMDIZOrder"><primary sortas="AccessibleComponent_getMDIZOrder">AccessibleComponent_getMDIZOrder</primary></indexterm><programlisting><link linkend="short">short</link>               AccessibleComponent_getMDIZOrder    (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);</programlisting>
337
 
<para>
338
 
Query the z stacking order of a component which is in the MDI or window
339
 
      layer. (Bigger z-order numbers mean nearer the top)</para>
340
 
<para>
341
 
</para><variablelist role="params">
342
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
343
 
<listitem><simpara> a pointer to the <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> to query.
344
 
</simpara></listitem></varlistentry>
345
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a short integer indicating the stacking order of the component 
346
 
      in the MDI layer, or -1 if the component is not in the MDI layer.
347
 
</simpara></listitem></varlistentry>
348
 
</variablelist></refsect2>
349
 
<refsect2 id="AccessibleComponent-grabFocus" role="function">
350
 
<title>AccessibleComponent_grabFocus ()</title>
351
 
<indexterm zone="AccessibleComponent-grabFocus"><primary sortas="AccessibleComponent_grabFocus">AccessibleComponent_grabFocus</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleComponent_grabFocus       (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);</programlisting>
352
 
<para>
353
 
Attempt to set the keyboard input focus to the specified
354
 
        <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link>.</para>
355
 
<para>
356
 
</para><variablelist role="params">
357
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
358
 
<listitem><simpara> a pointer to the <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> on which to operate.
359
 
</simpara></listitem></varlistentry>
360
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if successful, <link linkend="FALSE--CAPS"><type>FALSE</type></link> otherwise.
361
 
 
362
 
</simpara></listitem></varlistentry>
363
 
</variablelist></refsect2>
364
 
<refsect2 id="AccessibleComponent-getAlpha" role="function">
365
 
<title>AccessibleComponent_getAlpha ()</title>
366
 
<indexterm zone="AccessibleComponent-getAlpha"><primary sortas="AccessibleComponent_getAlpha">AccessibleComponent_getAlpha</primary></indexterm><programlisting><link linkend="double">double</link>              AccessibleComponent_getAlpha        (<link linkend="AccessibleComponent">AccessibleComponent</link> *obj);</programlisting>
367
 
<para>
368
 
Get the opacity/alpha value of a component, if alpha blending is in use.</para>
369
 
<para>
370
 
</para><variablelist role="params">
371
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
372
 
<listitem><simpara> The <link linkend="AccessibleComponent"><type>AccessibleComponent</type></link> to be queried.
373
 
</simpara></listitem></varlistentry>
374
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the opacity value of a component, as a double between 0.0 and 1.0. 
375
 
</simpara></listitem></varlistentry>
376
 
</variablelist></refsect2>
377
 
 
378
 
</refsect1>
379
 
 
380
 
 
381
 
 
382
 
 
383
 
</refentry>