1 <?xml version="1.0" encoding="UTF-8"?>
2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
8 <tp:enum name="Role" type="u">
9 <tp:enumvalue suffix="ROLE_INVALID">
11 A Role indicating an error condition, such as uninitialized Role data.
14 <tp:enumvalue suffix="ROLE_ACCELERATOR_LABEL" value="1">
16 Object is a label indicating the keyboard accelerators for the parent
19 <tp:enumvalue suffix="ROLE_ALERT" value="2">
21 Object is used to alert the user about something
24 <tp:enumvalue suffix="ROLE_ANIMATION" value="3">
26 Object contains a dynamic or moving image of some kind
29 <tp:enumvalue suffix="ROLE_ARROW" value="4">
31 Object is a 2d directional indicator
34 <tp:enumvalue suffix="ROLE_CALENDAR" value="5">
36 Object contains one or more dates, usually arranged into a 2d list
39 <tp:enumvalue suffix="ROLE_CANVAS" value="6">
41 Object that can be drawn into and is used to trap events
44 <tp:enumvalue suffix="ROLE_CHECK_BOX" value="7">
45 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
46 <p>A choice that can be checked or unchecked and provides a separate
47 indicator for the current state.</p>
50 <tp:enumvalue suffix="ROLE_CHECK_MENU_ITEM" value="8">
52 A menu item that behaves like a check box (see ROLE_CHECK_BOX)
55 <tp:enumvalue suffix="ROLE_COLOR_CHOOSER" value="9">
57 A specialized dialog that lets the user choose a color.
60 <tp:enumvalue suffix="ROLE_COLUMN_HEADER" value="10">
62 The header for a column of data
65 <tp:enumvalue suffix="ROLE_COMBO_BOX" value="11">
67 A list of choices the user can select from
70 <tp:enumvalue suffix="ROLE_DATE_EDITOR" value="12">
72 An object which allows entry of a date
75 <tp:enumvalue suffix="ROLE_DESKTOP_ICON" value="13">
77 An inconifed internal frame within a DESKTOP_PANE
80 <tp:enumvalue suffix="ROLE_DESKTOP_FRAME" value="14">
81 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
82 <p>A pane that supports internal frames and iconified versions of those
86 <tp:enumvalue suffix="ROLE_DIAL" value="15">
87 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
88 <p>An object that allows a value to be changed via rotating a visual element,
89 or which displays a value via such a rotating element. </p>
92 <tp:enumvalue suffix="ROLE_DIALOG" value="16">
94 A top level window with title bar and a border
97 <tp:enumvalue suffix="ROLE_DIRECTORY_PANE" value="17">
98 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
99 <p>A pane that allows the user to navigate through and select the contents
103 <tp:enumvalue suffix="ROLE_DRAWING_AREA" value="18">
104 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
105 <p>A specialized dialog that displays the files in the directory and lets
106 the user select a file, browse a different directory, or specify a
110 <tp:enumvalue suffix="ROLE_FILE_CHOOSER" value="19">
112 An object used for drawing custom user interface elements.
115 <tp:enumvalue suffix="ROLE_FILLER" value="20">
117 A object that fills up space in a user interface
120 <tp:enumvalue suffix="ROLE_FOCUS_TRAVERSABLE" value="21">
122 XXX Don't use, reserved for future use.
125 <tp:enumvalue suffix="ROLE_FONT_CHOOSER" value="22">
127 Allows selection of a display font
130 <tp:enumvalue suffix="ROLE_FRAME" value="23">
132 A top level window with a title bar, border, menubar, etc.
135 <tp:enumvalue suffix="ROLE_GLASS_PANE" value="24">
137 A pane that is guaranteed to be painted on top of all panes beneath it
140 <tp:enumvalue suffix="ROLE_HTML_CONTAINER" value="25">
141 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
142 <p>A document container for HTML, whose children
143 represent the document content.</p>
146 <tp:enumvalue suffix="ROLE_ICON" value="26">
148 A small fixed size picture, typically used to decorate components
151 <tp:enumvalue suffix="ROLE_IMAGE" value="27">
153 An image, typically static.
156 <tp:enumvalue suffix="ROLE_INTERNAL_FRAME" value="28">
158 A frame-like object that is clipped by a desktop pane.
161 <tp:enumvalue suffix="ROLE_LABEL" value="29">
163 An object used to present an icon or short string in an interface
166 <tp:enumvalue suffix="ROLE_LAYERED_PANE" value="30">
167 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
168 <p>A specialized pane that allows its children to be drawn in layers,
169 providing a form of stacking order.</p>
172 <tp:enumvalue suffix="ROLE_LIST" value="31">
173 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
174 <p>An object that presents a list of objects to the user and allows the
175 user to select one or more of them.</p>
178 <tp:enumvalue suffix="ROLE_LIST_ITEM" value="32">
180 An object that represents an element of a list.
183 <tp:enumvalue suffix="ROLE_MENU" value="33">
184 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
185 <p>An object usually found inside a menu bar that contains a list of
186 actions the user can choose from.</p>
189 <tp:enumvalue suffix="ROLE_MENU_BAR" value="34">
190 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
191 <p>An object usually drawn at the top of the primary dialog box of an
192 application that contains a list of menus the user can choose from.</p>
195 <tp:enumvalue suffix="ROLE_MENU_ITEM" value="35">
196 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
197 <p>An object usually contained in a menu that presents an action the
201 <tp:enumvalue suffix="ROLE_OPTION_PANE" value="36">
203 A specialized pane whose primary use is inside a DIALOG
206 <tp:enumvalue suffix="ROLE_PAGE_TAB" value="37">
208 An object that is a child of a page tab list
211 <tp:enumvalue suffix="ROLE_PAGE_TAB_LIST" value="38">
212 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
213 <p>An object that presents a series of panels (or page tabs), one at a time,
214 through some mechanism provided by the object.</p>
217 <tp:enumvalue suffix="ROLE_PANEL" value="39">
219 A generic container that is often used to group objects.
222 <tp:enumvalue suffix="ROLE_PASSWORD_TEXT" value="40">
223 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
224 <p>A text object uses for passwords, or other places where the text
225 content is not shown visibly to the user.</p>
228 <tp:enumvalue suffix="ROLE_POPUP_MENU" value="41">
229 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
230 <p>A temporary window that is usually used to offer the user a list of
231 choices, and then hides when the user selects one of those choices.</p>
234 <tp:enumvalue suffix="ROLE_PROGRESS_BAR" value="42">
236 An object used to indicate how much of a task has been completed.
239 <tp:enumvalue suffix="ROLE_PUSH_BUTTON" value="43">
240 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
241 <p>An object the user can manipulate to tell the application to do
245 <tp:enumvalue suffix="ROLE_RADIO_BUTTON" value="44">
246 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
247 <p>A specialized check box that will cause other radio buttons in the
248 same group to become uncghecked when this one is checked.</p>
251 <tp:enumvalue suffix="ROLE_RADIO_MENU_ITEM" value="45">
253 Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON)
256 <tp:enumvalue suffix="ROLE_ROOT_PANE" value="46">
257 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
258 <p>A specialized pane that has a glass pane and a layered pane as its
262 <tp:enumvalue suffix="ROLE_ROW_HEADER" value="47">
264 The header for a row of data
267 <tp:enumvalue suffix="ROLE_SCROLL_BAR" value="48">
268 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
269 <p>An object usually used to allow a user to incrementally view a large
270 amount of data by moving the bounds of a viewport along a one-dimensional axis.</p>
273 <tp:enumvalue suffix="ROLE_SCROLL_PANE" value="49">
274 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
275 <p>An object that allows a user to incrementally view a large amount
276 of information. ROLE_SCROLL_PANE objects are usually accompanied by
277 ROLE_SCROLL_BAR controllers, on which the RELATION_CONTROLLER_FOR and
278 RELATION_CONTROLLED_BY reciprocal relations are set; \see
279 Accessibility::RelationSet.</p>
282 <tp:enumvalue suffix="ROLE_SEPARATOR" value="50">
283 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
284 <p>An object usually contained in a menu to provide a visible and
285 logical separation of the contents in a menu.</p>
288 <tp:enumvalue suffix="ROLE_SLIDER" value="51">
290 An object that allows the user to select from a bounded range
293 <tp:enumvalue suffix="ROLE_SPIN_BUTTON" value="52">
294 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
295 <p>An object which allows one of a set of choices to be selected,
296 and which displays the current choice. Unlike ROLE_SCROLL_BAR,
297 ROLE_SLIDER objects need not control 'viewport'-like objects.</p>
300 <tp:enumvalue suffix="ROLE_SPLIT_PANE" value="53">
302 A specialized panel that presents two other panels at the same time.
305 <tp:enumvalue suffix="ROLE_STATUS_BAR" value="54">
307 Object displays non-quantitative status information (c.f. ROLE_PROGRESS_BAR)
310 <tp:enumvalue suffix="ROLE_TABLE" value="55">
312 An object used to repesent information in terms of rows and columns.
315 <tp:enumvalue suffix="ROLE_TABLE_CELL" value="56">
316 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
317 <p>A 'cell' or discrete child within a Table. \note Table cells need not have ROLE_TABLE_CELL,
318 other RoleType values are valid as well. </p>
321 <tp:enumvalue suffix="ROLE_TABLE_COLUMN_HEADER" value="57">
323 An object which labels a particular column in a Table.
326 <tp:enumvalue suffix="ROLE_TABLE_ROW_HEADER" value="58">
327 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
328 <p>An object which labels a particular row in a Table. Table rows and columns may also be
329 labelled via the RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships;
330 \see Accessibility::RelationSet. </p>
333 <tp:enumvalue suffix="ROLE_TEAROFF_MENU_ITEM" value="59">
335 Object allows menu to be removed from menubar and shown in its own window.
338 <tp:enumvalue suffix="ROLE_TERMINAL" value="60">
340 An object that emulates a terminal
343 <tp:enumvalue suffix="ROLE_TEXT" value="61">
345 An object that presents text to the user, of nonspecific type.
348 <tp:enumvalue suffix="ROLE_TOGGLE_BUTTON" value="62">
349 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
350 <p>A specialized push button that can be checked or unchecked, but does
351 not procide a separate indicator for the current state.</p>
354 <tp:enumvalue suffix="ROLE_TOOL_BAR" value="63">
356 A bar or palette usually composed of push buttons or toggle buttons
359 <tp:enumvalue suffix="ROLE_TOOL_TIP" value="64">
361 An object that provides information about another object
364 <tp:enumvalue suffix="ROLE_TREE" value="65">
366 An object used to repsent hierarchical information to the user.
369 <tp:enumvalue suffix="ROLE_TREE_TABLE" value="66">
371 An object that presents both tabular and hierarchical info to the user
374 <tp:enumvalue suffix="ROLE_UNKNOWN" value="67">
375 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
376 <p>The object contains some Accessible information, but its role is
380 <tp:enumvalue suffix="ROLE_VIEWPORT" value="68">
381 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
382 <p>An object usually used in a scroll pane, or to otherwise clip a larger object or
383 content renderer to a specific onscreen viewport. </p>
386 <tp:enumvalue suffix="ROLE_WINDOW" value="69">
388 A ¨top level window¨ with no title or border.
391 <tp:enumvalue suffix="ROLE_EXTENDED" value="70">
392 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
393 <p>means that the role for this item is known, but not included in the
394 core enumeration </p>
397 <tp:enumvalue suffix="ROLE_HEADER" value="71">
399 An object that serves as a document header.
402 <tp:enumvalue suffix="ROLE_FOOTER" value="72">
404 An object that serves as a document footer.
407 <tp:enumvalue suffix="ROLE_PARAGRAPH" value="73">
409 An object which is contains a single paragraph of text content. \see also ROLE_TEXT.
412 <tp:enumvalue suffix="ROLE_RULER" value="74">
413 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
414 <p>An object which describes margins and tab stops, etc.
415 for text objects which it controls
416 (should have CONTROLLER_FOR relation to such). </p>
419 <tp:enumvalue suffix="ROLE_APPLICATION" value="75">
420 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
421 <p>An object corresponding to the toplevel accessible of an
422 application, which may contain ROLE_FRAME objects or other
423 accessible objects. Children of AccessibleDesktop objects
424 are generally ROLE_APPLICATION objects.</p>
427 <tp:enumvalue suffix="ROLE_AUTOCOMPLETE" value="76">
428 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
429 <p>The object is a dialog or list containing items for insertion
430 into an entry widget, for instance a list of words for completion
434 <tp:enumvalue suffix="ROLE_EDITBAR" value="77">
436 The object is an editable text object in a toolbar.
439 <tp:enumvalue suffix="ROLE_EMBEDDED" value="78">
440 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
441 <p>The object is an embedded component container. This role is a
442 "grouping" hint that the contained objects share a context which is
443 different from the container in which this accessible is embedded.
444 In particular, it is used for some kinds of document embedding, and
445 for embedding of out-of-process component, "panel applets", etc.</p>
448 <tp:enumvalue suffix="ROLE_ENTRY" value="79">
449 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
450 <p>The object is a component whose textual content may be entered or modified by the user,
451 provided STATE_EDITABLE is present.
452 @note a readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) implies a
453 read-only ¨text field¨ in a form, as opposed to a title, label, or caption. </p>
455 <p>@since AT-SPI 1.7.0</p>
458 <tp:enumvalue suffix="ROLE_CHART" value="80">
459 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
460 <p>The object is a graphical depiction of quantitative data. It may contain multiple
461 subelements whose attributes and/or description may be queried to obtain both the
462 quantitative data and information about how the data is being presented.
463 The LABELLED_BY relation is particularly important in interpreting objects of this type,
464 as is the accessible-description property.
465 @see ROLE_CAPTION </p>
467 <p>@since AT-SPI 1.7.0</p>
470 <tp:enumvalue suffix="ROLE_CAPTION" value="81">
471 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
472 <p>The object contains descriptive information, usually textual, about another user interface
473 element such as a table, chart, or image. </p>
475 <p>@since AT-SPI 1.7.0</p>
478 <tp:enumvalue suffix="ROLE_DOCUMENT_FRAME" value="82">
479 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
480 <p>The object is a visual frame or container which contains a view of document content.
481 Document frames may occur within another Document instance, in which case the second
482 document may be said to be embedded in the containing instance. HTML frames are
483 often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement
484 the Document interface. </p>
486 <p>@since AT-SPI 1.7.0</p>
489 <tp:enumvalue suffix="ROLE_HEADING" value="83">
490 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
491 <p>The object serves as a heading for content which follows it in a document.
492 The 'heading level' of the heading, if availabe, may be obtained by
493 querying the object's attributes. </p>
495 <p>@since AT-SPI 1.7.0</p>
498 <tp:enumvalue suffix="ROLE_PAGE" value="84">
499 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
500 <p>The object is a containing instance which encapsulates a page of
501 information. ROLE_PAGE is used in documents and content which support
502 a paginated navigation model. </p>
504 <p>@since AT-SPI 1.7.0</p>
507 <tp:enumvalue suffix="ROLE_SECTION" value="85">
508 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
509 <p>The object is a containing instance of document content which constitutes
510 a particular 'logical' section of the document. The type of content within
511 a section, and the nature of the section division itself, may be obtained
512 by querying the object's attributes. Sections may be nested. </p>
514 <p>@since AT-SPI 1.7.0</p>
517 <tp:enumvalue suffix="ROLE_REDUNDANT_OBJECT" value="86">
518 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
519 <p>The object is redundant with another object in the hierarchy,
520 and is exposed for purely technical reasons. Objects of this role
521 should be ignored by clients, if they are encountered at all. </p>
523 <p>@since AT-SPI 1.7.6</p>
526 <tp:enumvalue suffix="ROLE_FORM" value="87">
527 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
528 <p>The object is a containing instance of document content which
529 has within it components with which the user can interact in order to
530 input information; i.e. the object is a container for pushbuttons,
531 comboboxes, text input fields, and other 'GUI' components.
532 ROLE_FORM should not, in general, be used for toplevel GUI containers
533 or dialogs, but should be reserved for 'GUI' containers which occur within
534 document content, for instance within Web documents, presentations, or
535 text documents. Unlike other GUI containers and dialogs which occur inside
536 application instances, ROLE_FORM containers' components are associated with
537 the current document, rather than the current foreground application or
538 viewer instance. </p>
540 <p>@since AT-SPI 1.7.6</p>
543 <tp:enumvalue suffix="ROLE_LINK" value="88">
544 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
545 <p>The object is a hypertext anchor, i.e. a "link" in a
546 hypertext document. Such objects are distinct from 'inline'
547 content which may also use the Hypertext/Hyperlink interfaces
548 to indicate the range/location within a text object where
549 an inline or embedded object lies. </p>
551 <p>@since AT-SPI 1.7.6</p>
554 <tp:enumvalue suffix="ROLE_INPUT_METHOD_WINDOW" value="89">
555 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
556 <p>The object is a window or similar viewport which is used
557 to allow composition or input of a 'complex character',
558 in other words it is an "input method window." </p>
560 <p>@since AT-SPI 1.7.6</p>
563 <tp:enumvalue suffix="ROLE_LAST_DEFINED" value="90">
565 not a valid role, used for finding end of enumeration.