1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
3 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
5 <tp:copyright>Copyright 2001 Sun Microsystems Inc.</tp:copyright>
6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
7 <p>This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.</p>
12 <p>This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.</p>
17 <p>You should have received a copy of the GNU Library General Public
18 License along with this library; if not, write to the
19 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.</p>
22 <tp:enum name="Role" type="u">
23 <tp:enumvalue suffix="ROLE_INVALID">
25 A Role indicating an error condition, such as uninitialized Role data.
28 <tp:enumvalue suffix="ROLE_ACCELERATOR_LABEL" value="1">
30 Object is a label indicating the keyboard accelerators for the parent
33 <tp:enumvalue suffix="ROLE_ALERT" value="2">
35 Object is used to alert the user about something
38 <tp:enumvalue suffix="ROLE_ANIMATION" value="3">
40 Object contains a dynamic or moving image of some kind
43 <tp:enumvalue suffix="ROLE_ARROW" value="4">
45 Object is a 2d directional indicator
48 <tp:enumvalue suffix="ROLE_CALENDAR" value="5">
50 Object contains one or more dates, usually arranged into a 2d list
53 <tp:enumvalue suffix="ROLE_CANVAS" value="6">
55 Object that can be drawn into and is used to trap events
58 <tp:enumvalue suffix="ROLE_CHECK_BOX" value="7">
59 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
60 <p>A choice that can be checked or unchecked and provides a separate
61 indicator for the current state.</p>
64 <tp:enumvalue suffix="ROLE_CHECK_MENU_ITEM" value="8">
66 A menu item that behaves like a check box (see ROLE_CHECK_BOX)
69 <tp:enumvalue suffix="ROLE_COLOR_CHOOSER" value="9">
71 A specialized dialog that lets the user choose a color.
74 <tp:enumvalue suffix="ROLE_COLUMN_HEADER" value="10">
76 The header for a column of data
79 <tp:enumvalue suffix="ROLE_COMBO_BOX" value="11">
81 A list of choices the user can select from
84 <tp:enumvalue suffix="ROLE_DATE_EDITOR" value="12">
86 An object which allows entry of a date
89 <tp:enumvalue suffix="ROLE_DESKTOP_ICON" value="13">
91 An inconifed internal frame within a DESKTOP_PANE
94 <tp:enumvalue suffix="ROLE_DESKTOP_FRAME" value="14">
95 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
96 <p>A pane that supports internal frames and iconified versions of those
100 <tp:enumvalue suffix="ROLE_DIAL" value="15">
101 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
102 <p>An object that allows a value to be changed via rotating a visual element,
103 or which displays a value via such a rotating element. </p>
106 <tp:enumvalue suffix="ROLE_DIALOG" value="16">
108 A top level window with title bar and a border
111 <tp:enumvalue suffix="ROLE_DIRECTORY_PANE" value="17">
112 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
113 <p>A pane that allows the user to navigate through and select the contents
117 <tp:enumvalue suffix="ROLE_DRAWING_AREA" value="18">
118 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
119 <p>A specialized dialog that displays the files in the directory and lets
120 the user select a file, browse a different directory, or specify a
124 <tp:enumvalue suffix="ROLE_FILE_CHOOSER" value="19">
126 An object used for drawing custom user interface elements.
129 <tp:enumvalue suffix="ROLE_FILLER" value="20">
131 A object that fills up space in a user interface
134 <tp:enumvalue suffix="ROLE_FOCUS_TRAVERSABLE" value="21">
136 XXX Don't use, reserved for future use.
139 <tp:enumvalue suffix="ROLE_FONT_CHOOSER" value="22">
141 Allows selection of a display font
144 <tp:enumvalue suffix="ROLE_FRAME" value="23">
146 A top level window with a title bar, border, menubar, etc.
149 <tp:enumvalue suffix="ROLE_GLASS_PANE" value="24">
151 A pane that is guaranteed to be painted on top of all panes beneath it
154 <tp:enumvalue suffix="ROLE_HTML_CONTAINER" value="25">
155 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
156 <p>A document container for HTML, whose children
157 represent the document content.</p>
160 <tp:enumvalue suffix="ROLE_ICON" value="26">
162 A small fixed size picture, typically used to decorate components
165 <tp:enumvalue suffix="ROLE_IMAGE" value="27">
167 An image, typically static.
170 <tp:enumvalue suffix="ROLE_INTERNAL_FRAME" value="28">
172 A frame-like object that is clipped by a desktop pane.
175 <tp:enumvalue suffix="ROLE_LABEL" value="29">
177 An object used to present an icon or short string in an interface
180 <tp:enumvalue suffix="ROLE_LAYERED_PANE" value="30">
181 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
182 <p>A specialized pane that allows its children to be drawn in layers,
183 providing a form of stacking order.</p>
186 <tp:enumvalue suffix="ROLE_LIST" value="31">
187 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
188 <p>An object that presents a list of objects to the user and allows the
189 user to select one or more of them.</p>
192 <tp:enumvalue suffix="ROLE_LIST_ITEM" value="32">
194 An object that represents an element of a list.
197 <tp:enumvalue suffix="ROLE_MENU" value="33">
198 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
199 <p>An object usually found inside a menu bar that contains a list of
200 actions the user can choose from.</p>
203 <tp:enumvalue suffix="ROLE_MENU_BAR" value="34">
204 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
205 <p>An object usually drawn at the top of the primary dialog box of an
206 application that contains a list of menus the user can choose from.</p>
209 <tp:enumvalue suffix="ROLE_MENU_ITEM" value="35">
210 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
211 <p>An object usually contained in a menu that presents an action the
215 <tp:enumvalue suffix="ROLE_OPTION_PANE" value="36">
217 A specialized pane whose primary use is inside a DIALOG
220 <tp:enumvalue suffix="ROLE_PAGE_TAB" value="37">
222 An object that is a child of a page tab list
225 <tp:enumvalue suffix="ROLE_PAGE_TAB_LIST" value="38">
226 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
227 <p>An object that presents a series of panels (or page tabs), one at a time,
228 through some mechanism provided by the object.</p>
231 <tp:enumvalue suffix="ROLE_PANEL" value="39">
233 A generic container that is often used to group objects.
236 <tp:enumvalue suffix="ROLE_PASSWORD_TEXT" value="40">
237 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
238 <p>A text object uses for passwords, or other places where the text
239 content is not shown visibly to the user.</p>
242 <tp:enumvalue suffix="ROLE_POPUP_MENU" value="41">
243 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
244 <p>A temporary window that is usually used to offer the user a list of
245 choices, and then hides when the user selects one of those choices.</p>
248 <tp:enumvalue suffix="ROLE_PROGRESS_BAR" value="42">
250 An object used to indicate how much of a task has been completed.
253 <tp:enumvalue suffix="ROLE_PUSH_BUTTON" value="43">
254 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
255 <p>An object the user can manipulate to tell the application to do
259 <tp:enumvalue suffix="ROLE_RADIO_BUTTON" value="44">
260 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
261 <p>A specialized check box that will cause other radio buttons in the
262 same group to become uncghecked when this one is checked.</p>
265 <tp:enumvalue suffix="ROLE_RADIO_MENU_ITEM" value="45">
267 Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON)
270 <tp:enumvalue suffix="ROLE_ROOT_PANE" value="46">
271 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
272 <p>A specialized pane that has a glass pane and a layered pane as its
276 <tp:enumvalue suffix="ROLE_ROW_HEADER" value="47">
278 The header for a row of data
281 <tp:enumvalue suffix="ROLE_SCROLL_BAR" value="48">
282 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
283 <p>An object usually used to allow a user to incrementally view a large
284 amount of data by moving the bounds of a viewport along a one-dimensional axis.</p>
287 <tp:enumvalue suffix="ROLE_SCROLL_PANE" value="49">
288 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
289 <p>An object that allows a user to incrementally view a large amount
290 of information. ROLE_SCROLL_PANE objects are usually accompanied by
291 ROLE_SCROLL_BAR controllers, on which the RELATION_CONTROLLER_FOR and
292 RELATION_CONTROLLED_BY reciprocal relations are set; \see
293 Accessibility::RelationSet.</p>
296 <tp:enumvalue suffix="ROLE_SEPARATOR" value="50">
297 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
298 <p>An object usually contained in a menu to provide a visible and
299 logical separation of the contents in a menu.</p>
302 <tp:enumvalue suffix="ROLE_SLIDER" value="51">
304 An object that allows the user to select from a bounded range
307 <tp:enumvalue suffix="ROLE_SPIN_BUTTON" value="52">
308 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
309 <p>An object which allows one of a set of choices to be selected,
310 and which displays the current choice. Unlike ROLE_SCROLL_BAR,
311 ROLE_SLIDER objects need not control 'viewport'-like objects.</p>
314 <tp:enumvalue suffix="ROLE_SPLIT_PANE" value="53">
316 A specialized panel that presents two other panels at the same time.
319 <tp:enumvalue suffix="ROLE_STATUS_BAR" value="54">
321 Object displays non-quantitative status information (c.f. ROLE_PROGRESS_BAR)
324 <tp:enumvalue suffix="ROLE_TABLE" value="55">
326 An object used to repesent information in terms of rows and columns.
329 <tp:enumvalue suffix="ROLE_TABLE_CELL" value="56">
330 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
331 <p>A 'cell' or discrete child within a Table. \note Table cells need not have ROLE_TABLE_CELL,
332 other RoleType values are valid as well. </p>
335 <tp:enumvalue suffix="ROLE_TABLE_COLUMN_HEADER" value="57">
337 An object which labels a particular column in a Table.
340 <tp:enumvalue suffix="ROLE_TABLE_ROW_HEADER" value="58">
341 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
342 <p>An object which labels a particular row in a Table. Table rows and columns may also be
343 labelled via the RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships;
344 \see Accessibility::RelationSet. </p>
347 <tp:enumvalue suffix="ROLE_TEAROFF_MENU_ITEM" value="59">
349 Object allows menu to be removed from menubar and shown in its own window.
352 <tp:enumvalue suffix="ROLE_TERMINAL" value="60">
354 An object that emulates a terminal
357 <tp:enumvalue suffix="ROLE_TEXT" value="61">
359 An object that presents text to the user, of nonspecific type.
362 <tp:enumvalue suffix="ROLE_TOGGLE_BUTTON" value="62">
363 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
364 <p>A specialized push button that can be checked or unchecked, but does
365 not procide a separate indicator for the current state.</p>
368 <tp:enumvalue suffix="ROLE_TOOL_BAR" value="63">
370 A bar or palette usually composed of push buttons or toggle buttons
373 <tp:enumvalue suffix="ROLE_TOOL_TIP" value="64">
375 An object that provides information about another object
378 <tp:enumvalue suffix="ROLE_TREE" value="65">
380 An object used to repsent hierarchical information to the user.
383 <tp:enumvalue suffix="ROLE_TREE_TABLE" value="66">
385 An object that presents both tabular and hierarchical info to the user
388 <tp:enumvalue suffix="ROLE_UNKNOWN" value="67">
389 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
390 <p>The object contains some Accessible information, but its role is
394 <tp:enumvalue suffix="ROLE_VIEWPORT" value="68">
395 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
396 <p>An object usually used in a scroll pane, or to otherwise clip a larger object or
397 content renderer to a specific onscreen viewport. </p>
400 <tp:enumvalue suffix="ROLE_WINDOW" value="69">
402 A ¨top level window¨ with no title or border.
405 <tp:enumvalue suffix="ROLE_EXTENDED" value="70">
406 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
407 <p>means that the role for this item is known, but not included in the
408 core enumeration </p>
411 <tp:enumvalue suffix="ROLE_HEADER" value="71">
413 An object that serves as a document header.
416 <tp:enumvalue suffix="ROLE_FOOTER" value="72">
418 An object that serves as a document footer.
421 <tp:enumvalue suffix="ROLE_PARAGRAPH" value="73">
423 An object which is contains a single paragraph of text content. \see also ROLE_TEXT.
426 <tp:enumvalue suffix="ROLE_RULER" value="74">
427 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
428 <p>An object which describes margins and tab stops, etc.
429 for text objects which it controls
430 (should have CONTROLLER_FOR relation to such). </p>
433 <tp:enumvalue suffix="ROLE_APPLICATION" value="75">
434 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
435 <p>An object corresponding to the toplevel accessible of an
436 application, which may contain ROLE_FRAME objects or other
437 accessible objects. Children of AccessibleDesktop objects
438 are generally ROLE_APPLICATION objects.</p>
441 <tp:enumvalue suffix="ROLE_AUTOCOMPLETE" value="76">
442 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
443 <p>The object is a dialog or list containing items for insertion
444 into an entry widget, for instance a list of words for completion
448 <tp:enumvalue suffix="ROLE_EDITBAR" value="77">
450 The object is an editable text object in a toolbar.
453 <tp:enumvalue suffix="ROLE_EMBEDDED" value="78">
454 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
455 <p>The object is an embedded component container. This role is a
456 "grouping" hint that the contained objects share a context which is
457 different from the container in which this accessible is embedded.
458 In particular, it is used for some kinds of document embedding, and
459 for embedding of out-of-process component, "panel applets", etc.</p>
462 <tp:enumvalue suffix="ROLE_ENTRY" value="79">
463 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
464 <p>The object is a component whose textual content may be entered or modified by the user,
465 provided STATE_EDITABLE is present.
466 @note a readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) implies a
467 read-only ¨text field¨ in a form, as opposed to a title, label, or caption. </p>
469 <p>@since AT-SPI 1.7.0</p>
472 <tp:enumvalue suffix="ROLE_CHART" value="80">
473 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
474 <p>The object is a graphical depiction of quantitative data. It may contain multiple
475 subelements whose attributes and/or description may be queried to obtain both the
476 quantitative data and information about how the data is being presented.
477 The LABELLED_BY relation is particularly important in interpreting objects of this type,
478 as is the accessible-description property.
479 @see ROLE_CAPTION </p>
481 <p>@since AT-SPI 1.7.0</p>
484 <tp:enumvalue suffix="ROLE_CAPTION" value="81">
485 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
486 <p>The object contains descriptive information, usually textual, about another user interface
487 element such as a table, chart, or image. </p>
489 <p>@since AT-SPI 1.7.0</p>
492 <tp:enumvalue suffix="ROLE_DOCUMENT_FRAME" value="82">
493 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
494 <p>The object is a visual frame or container which contains a view of document content.
495 Document frames may occur within another Document instance, in which case the second
496 document may be said to be embedded in the containing instance. HTML frames are
497 often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement
498 the Document interface. </p>
500 <p>@since AT-SPI 1.7.0</p>
503 <tp:enumvalue suffix="ROLE_HEADING" value="83">
504 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
505 <p>The object serves as a heading for content which follows it in a document.
506 The 'heading level' of the heading, if availabe, may be obtained by
507 querying the object's attributes. </p>
509 <p>@since AT-SPI 1.7.0</p>
512 <tp:enumvalue suffix="ROLE_PAGE" value="84">
513 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
514 <p>The object is a containing instance which encapsulates a page of
515 information. ROLE_PAGE is used in documents and content which support
516 a paginated navigation model. </p>
518 <p>@since AT-SPI 1.7.0</p>
521 <tp:enumvalue suffix="ROLE_SECTION" value="85">
522 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
523 <p>The object is a containing instance of document content which constitutes
524 a particular 'logical' section of the document. The type of content within
525 a section, and the nature of the section division itself, may be obtained
526 by querying the object's attributes. Sections may be nested. </p>
528 <p>@since AT-SPI 1.7.0</p>
531 <tp:enumvalue suffix="ROLE_REDUNDANT_OBJECT" value="86">
532 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
533 <p>The object is redundant with another object in the hierarchy,
534 and is exposed for purely technical reasons. Objects of this role
535 should be ignored by clients, if they are encountered at all. </p>
537 <p>@since AT-SPI 1.7.6</p>
540 <tp:enumvalue suffix="ROLE_FORM" value="87">
541 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
542 <p>The object is a containing instance of document content which
543 has within it components with which the user can interact in order to
544 input information; i.e. the object is a container for pushbuttons,
545 comboboxes, text input fields, and other 'GUI' components.
546 ROLE_FORM should not, in general, be used for toplevel GUI containers
547 or dialogs, but should be reserved for 'GUI' containers which occur within
548 document content, for instance within Web documents, presentations, or
549 text documents. Unlike other GUI containers and dialogs which occur inside
550 application instances, ROLE_FORM containers' components are associated with
551 the current document, rather than the current foreground application or
552 viewer instance. </p>
554 <p>@since AT-SPI 1.7.6</p>
557 <tp:enumvalue suffix="ROLE_LINK" value="88">
558 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
559 <p>The object is a hypertext anchor, i.e. a "link" in a
560 hypertext document. Such objects are distinct from 'inline'
561 content which may also use the Hypertext/Hyperlink interfaces
562 to indicate the range/location within a text object where
563 an inline or embedded object lies. </p>
565 <p>@since AT-SPI 1.7.6</p>
568 <tp:enumvalue suffix="ROLE_INPUT_METHOD_WINDOW" value="89">
569 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
570 <p>The object is a window or similar viewport which is used
571 to allow composition or input of a 'complex character',
572 in other words it is an "input method window." </p>
574 <p>@since AT-SPI 1.7.6</p>
577 <tp:enumvalue suffix="ROLE_LAST_DEFINED" value="90">
579 not a valid role, used for finding end of enumeration.