Docs tweaks.
[platform/core/uifw/at-spi2-atk.git] / docs / reference / cspi / tmpl / spi_component.sgml
1 <!-- ##### SECTION Title ##### -->
2 AccessibleComponent Interface
3
4 <!-- ##### SECTION Short_Description ##### -->
5 An interface implemented by objects which occupy area on screen.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 The Component interface is implemented by objects which are visible, or are
10 potentially visible, onscreen.  The interface exposes onscreen bounds, the
11 approximate "layer" in which the object resides, sometimes including z-order
12 information, and allows objects to explicitly be told to request focus.
13 </para>
14
15 <!-- ##### SECTION See_Also ##### -->
16 <para>
17
18 </para>
19
20 <!-- ##### SECTION Stability_Level ##### -->
21
22
23 <!-- ##### ENUM AccessibleCoordType ##### -->
24 <para>
25
26 </para>
27
28 @SPI_COORD_TYPE_SCREEN: 
29 @SPI_COORD_TYPE_WINDOW: 
30
31 <!-- ##### ENUM AccessibleComponentLayer ##### -->
32 <para>
33
34 </para>
35
36 @SPI_LAYER_INVALID: 
37 @SPI_LAYER_BACKGROUND: 
38 @SPI_LAYER_CANVAS: 
39 @SPI_LAYER_WIDGET: 
40 @SPI_LAYER_MDI: 
41 @SPI_LAYER_POPUP: 
42 @SPI_LAYER_OVERLAY: 
43 @SPI_LAYER_WINDOW: 
44 @SPI_LAYER_LAST_DEFINED: 
45
46 <!-- ##### FUNCTION AccessibleComponent_ref ##### -->
47 <para>
48
49 </para>
50
51 @obj: 
52
53
54 <!-- ##### FUNCTION AccessibleComponent_unref ##### -->
55 <para>
56
57 </para>
58
59 @obj: 
60
61
62 <!-- ##### FUNCTION AccessibleComponent_contains ##### -->
63 <para>
64
65 </para>
66
67 @obj: 
68 @x: 
69 @y: 
70 @ctype: 
71 @Returns: 
72
73
74 <!-- ##### FUNCTION AccessibleComponent_getAccessibleAtPoint ##### -->
75 <para>
76
77 </para>
78
79 @obj: 
80 @x: 
81 @y: 
82 @ctype: 
83 @Returns: 
84
85
86 <!-- ##### FUNCTION AccessibleComponent_getExtents ##### -->
87 <para>
88
89 </para>
90
91 @obj: 
92 @x: 
93 @y: 
94 @width: 
95 @height: 
96 @ctype: 
97
98
99 <!-- ##### FUNCTION AccessibleComponent_getPosition ##### -->
100 <para>
101
102 </para>
103
104 @obj: 
105 @x: 
106 @y: 
107 @ctype: 
108
109
110 <!-- ##### FUNCTION AccessibleComponent_getSize ##### -->
111 <para>
112
113 </para>
114
115 @obj: 
116 @width: 
117 @height: 
118
119
120 <!-- ##### FUNCTION AccessibleComponent_getLayer ##### -->
121 <para>
122
123 </para>
124
125 @obj: 
126 @Returns: 
127
128
129 <!-- ##### FUNCTION AccessibleComponent_getMDIZOrder ##### -->
130 <para>
131
132 </para>
133
134 @obj: 
135 @Returns: 
136
137
138 <!-- ##### FUNCTION AccessibleComponent_grabFocus ##### -->
139 <para>
140
141 </para>
142
143 @obj: 
144 @Returns: 
145
146
147 <!-- ##### FUNCTION AccessibleComponent_getAlpha ##### -->
148 <para>
149
150 </para>
151
152 @obj: 
153 @Returns: 
154
155