Imported version 2.7.91
[platform/core/uifw/at-spi2-core.git] / doc / libatspi / tmpl / atspi-constants.sgml
1 <!-- ##### SECTION Title ##### -->
2 atspi-constants
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Constant definitions needed by multiple interfaces.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 Constant definitions needed by multiple interfaces.
10 </para>
11
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
14
15 </para>
16
17 <!-- ##### SECTION Stability_Level ##### -->
18
19
20 <!-- ##### SECTION Image ##### -->
21
22
23 <!-- ##### ENUM AtspiLocaleType ##### -->
24 <para>
25
26 </para>
27
28 @ATSPI_LOCALE_TYPE_MESSAGES: 
29 @ATSPI_LOCALE_TYPE_COLLATE: 
30 @ATSPI_LOCALE_TYPE_CTYPE: 
31 @ATSPI_LOCALE_TYPE_MONETARY: 
32 @ATSPI_LOCALE_TYPE_NUMERIC: 
33 @ATSPI_LOCALE_TYPE_TIME: 
34
35 <!-- ##### MACRO ATSPI_LOCALE_TYPE ##### -->
36 <para>
37
38 </para>
39
40
41
42 <!-- ##### ENUM AtspiCoordType ##### -->
43 <para>
44
45 </para>
46
47 @ATSPI_COORD_TYPE_SCREEN: 
48 @ATSPI_COORD_TYPE_WINDOW: 
49
50 <!-- ##### MACRO ATSPI_COORD_TYPE_COUNT ##### -->
51 <para>
52
53 </para>
54
55
56
57 <!-- ##### ENUM AtspiCollectionSortOrder ##### -->
58 <para>
59
60 </para>
61
62 @ATSPI_Collection_SORT_ORDER_INVALID: 
63 @ATSPI_Collection_SORT_ORDER_CANONICAL: 
64 @ATSPI_Collection_SORT_ORDER_FLOW: 
65 @ATSPI_Collection_SORT_ORDER_TAB: 
66 @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL: 
67 @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW: 
68 @ATSPI_Collection_SORT_ORDER_REVERSE_TAB: 
69 @ATSPI_Collection_SORT_ORDER_LAST_DEFINED: 
70
71 <!-- ##### MACRO ATSPI_SORTORDER_COUNT ##### -->
72 <para>
73
74 </para>
75
76
77
78 <!-- ##### ENUM AtspiCollectionMatchType ##### -->
79 <para>
80
81 </para>
82
83 @ATSPI_Collection_MATCH_INVALID: 
84 @ATSPI_Collection_MATCH_ALL: 
85 @ATSPI_Collection_MATCH_ANY: 
86 @ATSPI_Collection_MATCH_NONE: 
87 @ATSPI_Collection_MATCH_EMPTY: 
88 @ATSPI_Collection_MATCH_LAST_DEFINED: 
89
90 <!-- ##### MACRO ATSPI_MATCHTYPES_COUNT ##### -->
91 <para>
92
93 </para>
94
95
96
97 <!-- ##### ENUM AtspiCollectionTreeTraversalType ##### -->
98 <para>
99
100 </para>
101
102 @ATSPI_Collection_TREE_RESTRICT_CHILDREN: 
103 @ATSPI_Collection_TREE_RESTRICT_SIBLING: 
104 @ATSPI_Collection_TREE_INORDER: 
105 @ATSPI_Collection_TREE_LAST_DEFINED: 
106
107 <!-- ##### MACRO ATSPI_TREETRAVERSALTYPE ##### -->
108 <para>
109
110 </para>
111
112
113
114 <!-- ##### ENUM AtspiComponentLayer ##### -->
115 <para>
116
117 </para>
118
119 @ATSPI_LAYER_INVALID: 
120 @ATSPI_LAYER_BACKGROUND: 
121 @ATSPI_LAYER_CANVAS: 
122 @ATSPI_LAYER_WIDGET: 
123 @ATSPI_LAYER_MDI: 
124 @ATSPI_LAYER_POPUP: 
125 @ATSPI_LAYER_OVERLAY: 
126 @ATSPI_LAYER_WINDOW: 
127 @ATSPI_LAYER_LAST_DEFINED: 
128
129 <!-- ##### MACRO ATSPI_COMPONENTLAYER_COUNT ##### -->
130 <para>
131
132 </para>
133
134
135
136 <!-- ##### ENUM AtspiTextBoundaryType ##### -->
137 <para>
138
139 </para>
140
141 @ATSPI_TEXT_BOUNDARY_CHAR: 
142 @ATSPI_TEXT_BOUNDARY_WORD_START: 
143 @ATSPI_TEXT_BOUNDARY_WORD_END: 
144 @ATSPI_TEXT_BOUNDARY_SENTENCE_START: 
145 @ATSPI_TEXT_BOUNDARY_SENTENCE_END: 
146 @ATSPI_TEXT_BOUNDARY_LINE_START: 
147 @ATSPI_TEXT_BOUNDARY_LINE_END: 
148
149 <!-- ##### MACRO ATSPI_TEXT_BOUNDARY_TYPE_COUNT ##### -->
150 <para>
151
152 </para>
153
154
155
156 <!-- ##### ENUM AtspiTextClipType ##### -->
157 <para>
158
159 </para>
160
161 @ATSPI_TEXT_CLIP_NONE: 
162 @ATSPI_TEXT_CLIP_MIN: 
163 @ATSPI_TEXT_CLIP_MAX: 
164 @ATSPI_TEXT_CLIP_BOTH: 
165
166 <!-- ##### MACRO ATSPI_TEXT_CLIP_TYPE_COUNT ##### -->
167 <para>
168
169 </para>
170
171
172
173 <!-- ##### ENUM AtspiStateType ##### -->
174 <para>
175
176 </para>
177
178 @ATSPI_STATE_INVALID: 
179 @ATSPI_STATE_ACTIVE: 
180 @ATSPI_STATE_ARMED: 
181 @ATSPI_STATE_BUSY: 
182 @ATSPI_STATE_CHECKED: 
183 @ATSPI_STATE_COLLAPSED: 
184 @ATSPI_STATE_DEFUNCT: 
185 @ATSPI_STATE_EDITABLE: 
186 @ATSPI_STATE_ENABLED: 
187 @ATSPI_STATE_EXPANDABLE: 
188 @ATSPI_STATE_EXPANDED: 
189 @ATSPI_STATE_FOCUSABLE: 
190 @ATSPI_STATE_FOCUSED: 
191 @ATSPI_STATE_HAS_TOOLTIP: 
192 @ATSPI_STATE_HORIZONTAL: 
193 @ATSPI_STATE_ICONIFIED: 
194 @ATSPI_STATE_MODAL: 
195 @ATSPI_STATE_MULTI_LINE: 
196 @ATSPI_STATE_MULTISELECTABLE: 
197 @ATSPI_STATE_OPAQUE: 
198 @ATSPI_STATE_PRESSED: 
199 @ATSPI_STATE_RESIZABLE: 
200 @ATSPI_STATE_SELECTABLE: 
201 @ATSPI_STATE_SELECTED: 
202 @ATSPI_STATE_SENSITIVE: 
203 @ATSPI_STATE_SHOWING: 
204 @ATSPI_STATE_SINGLE_LINE: 
205 @ATSPI_STATE_STALE: 
206 @ATSPI_STATE_TRANSIENT: 
207 @ATSPI_STATE_VERTICAL: 
208 @ATSPI_STATE_VISIBLE: 
209 @ATSPI_STATE_MANAGES_DESCENDANTS: 
210 @ATSPI_STATE_INDETERMINATE: 
211 @ATSPI_STATE_REQUIRED: 
212 @ATSPI_STATE_TRUNCATED: 
213 @ATSPI_STATE_ANIMATED: 
214 @ATSPI_STATE_INVALID_ENTRY: 
215 @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: 
216 @ATSPI_STATE_SELECTABLE_TEXT: 
217 @ATSPI_STATE_IS_DEFAULT: 
218 @ATSPI_STATE_VISITED: 
219 @ATSPI_STATE_LAST_DEFINED: 
220
221 <!-- ##### MACRO ATSPI_STATETYPE_COUNT ##### -->
222 <para>
223
224 </para>
225
226
227
228 <!-- ##### ENUM AtspiKeyEventType ##### -->
229 <para>
230
231 </para>
232
233 @ATSPI_KEY_PRESSED: 
234 @ATSPI_KEY_RELEASED: 
235
236 <!-- ##### MACRO ATSPI_KEYEVENTTYPE_COUNT ##### -->
237 <para>
238
239 </para>
240
241
242
243 <!-- ##### ENUM AtspiEventType ##### -->
244 <para>
245
246 </para>
247
248 @ATSPI_KEY_PRESSED_EVENT: 
249 @ATSPI_KEY_RELEASED_EVENT: 
250 @ATSPI_BUTTON_PRESSED_EVENT: 
251 @ATSPI_BUTTON_RELEASED_EVENT: 
252
253 <!-- ##### MACRO ATSPI_EVENTTYPE_COUNT ##### -->
254 <para>
255
256 </para>
257
258
259
260 <!-- ##### ENUM AtspiKeySynthType ##### -->
261 <para>
262
263 </para>
264
265 @ATSPI_KEY_PRESS: 
266 @ATSPI_KEY_RELEASE: 
267 @ATSPI_KEY_PRESSRELEASE: 
268 @ATSPI_KEY_SYM: 
269 @ATSPI_KEY_STRING: 
270
271 <!-- ##### MACRO ATSPI_KEYSYNTHTYPE_COUNT ##### -->
272 <para>
273
274 </para>
275
276
277
278 <!-- ##### ENUM AtspiModifierType ##### -->
279 <para>
280
281 </para>
282
283 @ATSPI_MODIFIER_SHIFT: 
284 @ATSPI_MODIFIER_SHIFTLOCK: 
285 @ATSPI_MODIFIER_CONTROL: 
286 @ATSPI_MODIFIER_ALT: 
287 @ATSPI_MODIFIER_META: 
288 @ATSPI_MODIFIER_META2: 
289 @ATSPI_MODIFIER_META3: 
290 @ATSPI_MODIFIER_NUMLOCK: 
291
292 <!-- ##### MACRO ATSPI_MODIFIERTYPE_COUNT ##### -->
293 <para>
294
295 </para>
296
297
298
299 <!-- ##### ENUM AtspiRelationType ##### -->
300 <para>
301
302 </para>
303
304 @ATSPI_RELATION_NULL: 
305 @ATSPI_RELATION_LABEL_FOR: 
306 @ATSPI_RELATION_LABELLED_BY: 
307 @ATSPI_RELATION_CONTROLLER_FOR: 
308 @ATSPI_RELATION_CONTROLLED_BY: 
309 @ATSPI_RELATION_MEMBER_OF: 
310 @ATSPI_RELATION_TOOLTIP_FOR: 
311 @ATSPI_RELATION_NODE_CHILD_OF: 
312 @ATSPI_RELATION_NODE_PARENT_OF: 
313 @ATSPI_RELATION_EXTENDED: 
314 @ATSPI_RELATION_FLOWS_TO: 
315 @ATSPI_RELATION_FLOWS_FROM: 
316 @ATSPI_RELATION_SUBWINDOW_OF: 
317 @ATSPI_RELATION_EMBEDS: 
318 @ATSPI_RELATION_EMBEDDED_BY: 
319 @ATSPI_RELATION_POPUP_FOR: 
320 @ATSPI_RELATION_PARENT_WINDOW_OF: 
321 @ATSPI_RELATION_DESCRIPTION_FOR: 
322 @ATSPI_RELATION_DESCRIBED_BY: 
323 @ATSPI_RELATION_LAST_DEFINED: 
324
325 <!-- ##### MACRO ATSPI_RELATIONTYPE_COUNT ##### -->
326 <para>
327
328 </para>
329
330
331
332 <!-- ##### ENUM AtspiRole ##### -->
333 <para>
334
335 </para>
336
337 @ATSPI_ROLE_INVALID: 
338 @ATSPI_ROLE_ACCELERATOR_LABEL: 
339 @ATSPI_ROLE_ALERT: 
340 @ATSPI_ROLE_ANIMATION: 
341 @ATSPI_ROLE_ARROW: 
342 @ATSPI_ROLE_CALENDAR: 
343 @ATSPI_ROLE_CANVAS: 
344 @ATSPI_ROLE_CHECK_BOX: 
345 @ATSPI_ROLE_CHECK_MENU_ITEM: 
346 @ATSPI_ROLE_COLOR_CHOOSER: 
347 @ATSPI_ROLE_COLUMN_HEADER: 
348 @ATSPI_ROLE_COMBO_BOX: 
349 @ATSPI_ROLE_DATE_EDITOR: 
350 @ATSPI_ROLE_DESKTOP_ICON: 
351 @ATSPI_ROLE_DESKTOP_FRAME: 
352 @ATSPI_ROLE_DIAL: 
353 @ATSPI_ROLE_DIALOG: 
354 @ATSPI_ROLE_DIRECTORY_PANE: 
355 @ATSPI_ROLE_DRAWING_AREA: 
356 @ATSPI_ROLE_FILE_CHOOSER: 
357 @ATSPI_ROLE_FILLER: 
358 @ATSPI_ROLE_FOCUS_TRAVERSABLE: 
359 @ATSPI_ROLE_FONT_CHOOSER: 
360 @ATSPI_ROLE_FRAME: 
361 @ATSPI_ROLE_GLASS_PANE: 
362 @ATSPI_ROLE_HTML_CONTAINER: 
363 @ATSPI_ROLE_ICON: 
364 @ATSPI_ROLE_IMAGE: 
365 @ATSPI_ROLE_INTERNAL_FRAME: 
366 @ATSPI_ROLE_LABEL: 
367 @ATSPI_ROLE_LAYERED_PANE: 
368 @ATSPI_ROLE_LIST: 
369 @ATSPI_ROLE_LIST_ITEM: 
370 @ATSPI_ROLE_MENU: 
371 @ATSPI_ROLE_MENU_BAR: 
372 @ATSPI_ROLE_MENU_ITEM: 
373 @ATSPI_ROLE_OPTION_PANE: 
374 @ATSPI_ROLE_PAGE_TAB: 
375 @ATSPI_ROLE_PAGE_TAB_LIST: 
376 @ATSPI_ROLE_PANEL: 
377 @ATSPI_ROLE_PASSWORD_TEXT: 
378 @ATSPI_ROLE_POPUP_MENU: 
379 @ATSPI_ROLE_PROGRESS_BAR: 
380 @ATSPI_ROLE_PUSH_BUTTON: 
381 @ATSPI_ROLE_RADIO_BUTTON: 
382 @ATSPI_ROLE_RADIO_MENU_ITEM: 
383 @ATSPI_ROLE_ROOT_PANE: 
384 @ATSPI_ROLE_ROW_HEADER: 
385 @ATSPI_ROLE_SCROLL_BAR: 
386 @ATSPI_ROLE_SCROLL_PANE: 
387 @ATSPI_ROLE_SEPARATOR: 
388 @ATSPI_ROLE_SLIDER: 
389 @ATSPI_ROLE_SPIN_BUTTON: 
390 @ATSPI_ROLE_SPLIT_PANE: 
391 @ATSPI_ROLE_STATUS_BAR: 
392 @ATSPI_ROLE_TABLE: 
393 @ATSPI_ROLE_TABLE_CELL: 
394 @ATSPI_ROLE_TABLE_COLUMN_HEADER: 
395 @ATSPI_ROLE_TABLE_ROW_HEADER: 
396 @ATSPI_ROLE_TEAROFF_MENU_ITEM: 
397 @ATSPI_ROLE_TERMINAL: 
398 @ATSPI_ROLE_TEXT: 
399 @ATSPI_ROLE_TOGGLE_BUTTON: 
400 @ATSPI_ROLE_TOOL_BAR: 
401 @ATSPI_ROLE_TOOL_TIP: 
402 @ATSPI_ROLE_TREE: 
403 @ATSPI_ROLE_TREE_TABLE: 
404 @ATSPI_ROLE_UNKNOWN: 
405 @ATSPI_ROLE_VIEWPORT: 
406 @ATSPI_ROLE_WINDOW: 
407 @ATSPI_ROLE_EXTENDED: 
408 @ATSPI_ROLE_HEADER: 
409 @ATSPI_ROLE_FOOTER: 
410 @ATSPI_ROLE_PARAGRAPH: 
411 @ATSPI_ROLE_RULER: 
412 @ATSPI_ROLE_APPLICATION: 
413 @ATSPI_ROLE_AUTOCOMPLETE: 
414 @ATSPI_ROLE_EDITBAR: 
415 @ATSPI_ROLE_EMBEDDED: 
416 @ATSPI_ROLE_ENTRY: 
417 @ATSPI_ROLE_CHART: 
418 @ATSPI_ROLE_CAPTION: 
419 @ATSPI_ROLE_DOCUMENT_FRAME: 
420 @ATSPI_ROLE_HEADING: 
421 @ATSPI_ROLE_PAGE: 
422 @ATSPI_ROLE_SECTION: 
423 @ATSPI_ROLE_REDUNDANT_OBJECT: 
424 @ATSPI_ROLE_FORM: 
425 @ATSPI_ROLE_LINK: 
426 @ATSPI_ROLE_INPUT_METHOD_WINDOW: 
427 @ATSPI_ROLE_TABLE_ROW: 
428 @ATSPI_ROLE_TREE_ITEM: 
429 @ATSPI_ROLE_DOCUMENT_SPREADSHEET: 
430 @ATSPI_ROLE_DOCUMENT_PRESENTATION: 
431 @ATSPI_ROLE_DOCUMENT_TEXT: 
432 @ATSPI_ROLE_DOCUMENT_WEB: 
433 @ATSPI_ROLE_DOCUMENT_EMAIL: 
434 @ATSPI_ROLE_COMMENT: 
435 @ATSPI_ROLE_LIST_BOX: 
436 @ATSPI_ROLE_GROUPING: 
437 @ATSPI_ROLE_IMAGE_MAP: 
438 @ATSPI_ROLE_NOTIFICATION: 
439 @ATSPI_ROLE_INFO_BAR: 
440 @ATSPI_ROLE_LEVEL_BAR: 
441 @ATSPI_ROLE_LAST_DEFINED: 
442
443 <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
444 <para>
445
446 </para>
447
448
449