From 46764a3795ea7fa05b2ea4efa30d239c62b1999c Mon Sep 17 00:00:00 2001 From: Mike Gorse Date: Thu, 17 Apr 2008 16:44:22 -0400 Subject: [PATCH] Re-add Accessibility_Role.xml and Accessibility_State.xml --- xml/Accessibility.xml | 2 + xml/Accessibility_Role.xml | 583 ++++++++++++++++++++++++++++++++++++++++++++ xml/Accessibility_State.xml | 397 ++++++++++++++++++++++++++++++ xml/Makefile.am | 2 + 4 files changed, 984 insertions(+) create mode 100644 xml/Accessibility_Role.xml create mode 100644 xml/Accessibility_State.xml diff --git a/xml/Accessibility.xml b/xml/Accessibility.xml index 090b016..99bd824 100644 --- a/xml/Accessibility.xml +++ b/xml/Accessibility.xml @@ -98,12 +98,14 @@ Boston, MA 02111-1307, USA.

+ + diff --git a/xml/Accessibility_Role.xml b/xml/Accessibility_Role.xml new file mode 100644 index 0000000..373baa2 --- /dev/null +++ b/xml/Accessibility_Role.xml @@ -0,0 +1,583 @@ + + +AT-SPI - Assistive Technology Service Provider Interface +Copyright 2008 Novell, Inc. +Copyright 2001 Sun Microsystems Inc. + +

This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version.

+ +

This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details.

+ +

You should have received a copy of the GNU Library General Public + License along with this library; if not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA.

+ + + + + A Role indicating an error condition, such as uninitialized Role data. + + + + + Object is a label indicating the keyboard accelerators for the parent + + + + + Object is used to alert the user about something + + + + + Object contains a dynamic or moving image of some kind + + + + + Object is a 2d directional indicator + + + + + Object contains one or more dates, usually arranged into a 2d list + + + + + Object that can be drawn into and is used to trap events + + + + +

A choice that can be checked or unchecked and provides a separate + indicator for the current state.

+ + + + + A menu item that behaves like a check box (see ROLE_CHECK_BOX) + + + + + A specialized dialog that lets the user choose a color. + + + + + The header for a column of data + + + + + A list of choices the user can select from + + + + + An object which allows entry of a date + + + + + An inconifed internal frame within a DESKTOP_PANE + + + + +

A pane that supports internal frames and iconified versions of those + internal frames.

+ + + + +

An object that allows a value to be changed via rotating a visual element, + or which displays a value via such a rotating element.

+ + + + + A top level window with title bar and a border + + + + +

A pane that allows the user to navigate through and select the contents + of a directory

+ + + + +

A specialized dialog that displays the files in the directory and lets + the user select a file, browse a different directory, or specify a + filename.

+ + + + + An object used for drawing custom user interface elements. + + + + + A object that fills up space in a user interface + + + + + XXX Don't use, reserved for future use. + + + + + Allows selection of a display font + + + + + A top level window with a title bar, border, menubar, etc. + + + + + A pane that is guaranteed to be painted on top of all panes beneath it + + + + +

A document container for HTML, whose children + represent the document content.

+ + + + + A small fixed size picture, typically used to decorate components + + + + + An image, typically static. + + + + + A frame-like object that is clipped by a desktop pane. + + + + + An object used to present an icon or short string in an interface + + + + +

A specialized pane that allows its children to be drawn in layers, + providing a form of stacking order.

+ + + + +

An object that presents a list of objects to the user and allows the + user to select one or more of them.

+ + + + + An object that represents an element of a list. + + + + +

An object usually found inside a menu bar that contains a list of + actions the user can choose from.

+ + + + +

An object usually drawn at the top of the primary dialog box of an + application that contains a list of menus the user can choose from.

+ + + + +

An object usually contained in a menu that presents an action the + user can choose.

+ + + + + A specialized pane whose primary use is inside a DIALOG + + + + + An object that is a child of a page tab list + + + + +

An object that presents a series of panels (or page tabs), one at a time, + through some mechanism provided by the object.

+ + + + + A generic container that is often used to group objects. + + + + +

A text object uses for passwords, or other places where the text + content is not shown visibly to the user.

+ + + + +

A temporary window that is usually used to offer the user a list of + choices, and then hides when the user selects one of those choices.

+ + + + + An object used to indicate how much of a task has been completed. + + + + +

An object the user can manipulate to tell the application to do + something.

+ + + + +

A specialized check box that will cause other radio buttons in the + same group to become uncghecked when this one is checked.

+ + + + + Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON) + + + + +

A specialized pane that has a glass pane and a layered pane as its + children.

+ + + + + The header for a row of data + + + + +

An object usually used to allow a user to incrementally view a large + amount of data by moving the bounds of a viewport along a one-dimensional axis.

+ + + + +

An object that allows a user to incrementally view a large amount + of information. ROLE_SCROLL_PANE objects are usually accompanied by + ROLE_SCROLL_BAR controllers, on which the RELATION_CONTROLLER_FOR and + RELATION_CONTROLLED_BY reciprocal relations are set; \see + Accessibility::RelationSet.

+ + + + +

An object usually contained in a menu to provide a visible and + logical separation of the contents in a menu.

+ + + + + An object that allows the user to select from a bounded range + + + + +

An object which allows one of a set of choices to be selected, + and which displays the current choice. Unlike ROLE_SCROLL_BAR, + ROLE_SLIDER objects need not control 'viewport'-like objects.

+ + + + + A specialized panel that presents two other panels at the same time. + + + + + Object displays non-quantitative status information (c.f. ROLE_PROGRESS_BAR) + + + + + An object used to repesent information in terms of rows and columns. + + + + +

A 'cell' or discrete child within a Table. \note Table cells need not have ROLE_TABLE_CELL, + other RoleType values are valid as well.

+ + + + + An object which labels a particular column in a Table. + + + + +

An object which labels a particular row in a Table. Table rows and columns may also be + labelled via the RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships; + \see Accessibility::RelationSet.

+ + + + + Object allows menu to be removed from menubar and shown in its own window. + + + + + An object that emulates a terminal + + + + + An object that presents text to the user, of nonspecific type. + + + + +

A specialized push button that can be checked or unchecked, but does + not procide a separate indicator for the current state.

+ + + + + A bar or palette usually composed of push buttons or toggle buttons + + + + + An object that provides information about another object + + + + + An object used to repsent hierarchical information to the user. + + + + + An object that presents both tabular and hierarchical info to the user + + + + +

The object contains some Accessible information, but its role is + not known.

+ + + + +

An object usually used in a scroll pane, or to otherwise clip a larger object or + content renderer to a specific onscreen viewport.

+ + + + + A ¨top level window¨ with no title or border. + + + + +

means that the role for this item is known, but not included in the + core enumeration

+ + + + + An object that serves as a document header. + + + + + An object that serves as a document footer. + + + + + An object which is contains a single paragraph of text content. \see also ROLE_TEXT. + + + + +

An object which describes margins and tab stops, etc. + for text objects which it controls + (should have CONTROLLER_FOR relation to such).

+ + + + +

An object corresponding to the toplevel accessible of an + application, which may contain ROLE_FRAME objects or other + accessible objects. Children of AccessibleDesktop objects + are generally ROLE_APPLICATION objects.

+ + + + +

The object is a dialog or list containing items for insertion + into an entry widget, for instance a list of words for completion + of a text entry.

+ + + + + The object is an editable text object in a toolbar. + + + + +

The object is an embedded component container. This role is a + "grouping" hint that the contained objects share a context which is + different from the container in which this accessible is embedded. + In particular, it is used for some kinds of document embedding, and + for embedding of out-of-process component, "panel applets", etc.

+ + + + +

The object is a component whose textual content may be entered or modified by the user, + provided STATE_EDITABLE is present. + @note a readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) implies a + read-only ¨text field¨ in a form, as opposed to a title, label, or caption.

+ +

@since AT-SPI 1.7.0

+ + + + +

The object is a graphical depiction of quantitative data. It may contain multiple + subelements whose attributes and/or description may be queried to obtain both the + quantitative data and information about how the data is being presented. + The LABELLED_BY relation is particularly important in interpreting objects of this type, + as is the accessible-description property. + @see ROLE_CAPTION

+ +

@since AT-SPI 1.7.0

+ + + + +

The object contains descriptive information, usually textual, about another user interface + element such as a table, chart, or image.

+ +

@since AT-SPI 1.7.0

+ + + + +

The object is a visual frame or container which contains a view of document content. + Document frames may occur within another Document instance, in which case the second + document may be said to be embedded in the containing instance. HTML frames are + often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement + the Document interface.

+ +

@since AT-SPI 1.7.0

+ + + + +

The object serves as a heading for content which follows it in a document. + The 'heading level' of the heading, if availabe, may be obtained by + querying the object's attributes.

+ +

@since AT-SPI 1.7.0

+ + + + +

The object is a containing instance which encapsulates a page of + information. ROLE_PAGE is used in documents and content which support + a paginated navigation model.

+ +

@since AT-SPI 1.7.0

+ + + + +

The object is a containing instance of document content which constitutes + a particular 'logical' section of the document. The type of content within + a section, and the nature of the section division itself, may be obtained + by querying the object's attributes. Sections may be nested.

+ +

@since AT-SPI 1.7.0

+ + + + +

The object is redundant with another object in the hierarchy, + and is exposed for purely technical reasons. Objects of this role + should be ignored by clients, if they are encountered at all.

+ +

@since AT-SPI 1.7.6

+ + + + +

The object is a containing instance of document content which + has within it components with which the user can interact in order to + input information; i.e. the object is a container for pushbuttons, + comboboxes, text input fields, and other 'GUI' components. + ROLE_FORM should not, in general, be used for toplevel GUI containers + or dialogs, but should be reserved for 'GUI' containers which occur within + document content, for instance within Web documents, presentations, or + text documents. Unlike other GUI containers and dialogs which occur inside + application instances, ROLE_FORM containers' components are associated with + the current document, rather than the current foreground application or + viewer instance.

+ +

@since AT-SPI 1.7.6

+ + + + +

The object is a hypertext anchor, i.e. a "link" in a + hypertext document. Such objects are distinct from 'inline' + content which may also use the Hypertext/Hyperlink interfaces + to indicate the range/location within a text object where + an inline or embedded object lies.

+ +

@since AT-SPI 1.7.6

+ + + + +

The object is a window or similar viewport which is used + to allow composition or input of a 'complex character', + in other words it is an "input method window."

+ +

@since AT-SPI 1.7.6

+ + + + + not a valid role, used for finding end of enumeration. + + + + diff --git a/xml/Accessibility_State.xml b/xml/Accessibility_State.xml new file mode 100644 index 0000000..06e51d9 --- /dev/null +++ b/xml/Accessibility_State.xml @@ -0,0 +1,397 @@ + + +AT-SPI - Assistive Technology Service Provider Interface +Copyright 2008 Novell, Inc. +Copyright 2001 Sun Microsystems Inc. + +

This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version.

+ +

This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details.

+ +

You should have received a copy of the GNU Library General Public + License along with this library; if not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA.

+ + + + + + Indicates a window is currently the active window, or is an active subelement within a container or table + + + + + Indicates that the object is armed + + + + +

Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or + the object is temporarily unavailable for interaction due to activity already in progress.

+ + + + + Indicates this object is currently checked + + + + + Indicates this object is collapsed + + + + +

Indicates that this object no longer has a valid backing widget + (for instance, if its peer object has been destroyed)

+ + + + + Indicates the user can change the contents of this object + + + + +

Indicates that this object is enabled, i.e. that it currently reflects some application state. + Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user + interaction cannot cause them to acquire STATE_ENABLED. @see STATE_SENSITIVE.

+ + + + + Indicates this object allows progressive disclosure of its children + + + + + Indicates this object its expanded + + + + +

Indicates this object can accept keyboard focus, which means all + events resulting from typing on the keyboard will normally be passed + to it when it has focus

+ + + + + Indicates this object currently has the keyboard focus + + + + + Indicates that the object has an associated tooltip + + + + + Indicates the orientation of thsi object is horizontal + + + + + Indicates this object is minimized and is represented only by an icon + + + + +

Indicates something must be done with this object before the user can + interact with an object in a different window.

+ + + + + Indicates this (text) object can contain multiple lines of text + + + + +

Indicates this object allows more than one of its children to be + selected at the same time, or in the case of text objects, + that the object supports non-contiguous text selections.

+ + + + +

Indicates this object paints every pixel within its rectangular region. + It also indicates an alpha value of unity, if it supports alpha blending.

+ + + + + Indicates this object is currently pressed + + + + + Indicates the size of this object's size is not fixed + + + + +

Indicates this object is the child of an object that allows its + children to be selected and that this child is one of those children + that can be selected.

+ + + + +

Indicates this object is the child of an object that allows its + children to be selected and that this child is one of those children + that has been selected.

+ + + + +

Indicates this object is sensitive, e.g. to user interaction. + STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls, + but may be found in the absence of STATE_ENABLED if the current visible state of the + control is "disconnected" from the application state. In such cases, direct user interaction + can often result in the object gaining STATE_SENSITIVE, for instance if a user makes + an explicit selection using an object whose current state is ambiguous or undefined. + @see STATE_ENABLED, STATE_INDETERMINATE.

+ + + + +

Indicates this object, the object's parent, the object's parent's + parent, and so on, are all 'shown' to the end-user, i.e. + subject to "exposure" if blocking or obscuring objects do not interpose + between this object and the top of the window stack.

+ + + + + Indicates this (text) object can contain only a single line of text + + + + +

Indicates that the information returned for this object may no longer be + synchronized with the application state. This can occur if the object has STATE_TRANSIENT, + and can also occur towards the end of the object peer's lifecycle.

+ + + + + Indicates this object is transient + + + + +

Indicates the orientation of this object is vertical; for example this state may appear on + such objects as scrollbars, text objects (with vertical text flow), separators, etc.

+ + + + +

Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. + @note: STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only + that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the + field of view, or having an ancestor container that has not yet made visible. + A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING. + The absence of STATE_VISIBLE and STATE_SHOWING is semantically equivalent to saying + that an object is 'hidden'.

+ + + + +

Indicates that "active-descendant-changed" event is sent when children + become 'active' (i.e. are selected or navigated to onscreen). Used to + prevent need to enumerate all children in very large containers, like + tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client. + that the children should not, and need not, be enumerated by the client. + Objects implementing this state are expected to provide relevant state + notifications to listening clients, for instance notifications of visibility + changes and activation of their contained child objects, without the client + having previously requested references to those children.

+ + + + +

Indicates that a check box or other boolean indicator is in a state other than + checked or not checked. This usually means that the boolean value reflected or + controlled by the object does not apply consistently to the entire current context. + For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE + if the currently selected text contains a mixture of weight attributes. + In many cases interacting with a STATE_INDETERMINATE object will cause + the context's corresponding boolean attribute to be homogenized, whereupon the object + will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired.

+ + + + +

Indicates that user interaction with this object is 'required' from the user, + for instance before completing the processing of a form.

+ + + + +

Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell. + @since AT-SPI 1.7.0.

+ + + + +

Indicates this object's visual representation is dynamic, not static. + This state may be applied to an object during an animated 'effect' and + be removed from the object once its visual representation becomes static. + @note some applications, notably content viewers, may not be able to detect + all kinds of animated content. Therefore the absence of this state should not + be taken as definitive evidence that the object's visual representation is + static; this state is advisory.

+ +

@since AT-SPI 1.7.0

+ + + + +

This object has indicated an error condition due to failure of input + validation. For instance, a form control may acquire this state in response + to invalid or malformed user input.

+ +

@since AT-SPI 1.7.0

+ + + + +

This state indicates that the object in question implements some form of ¨typeahead¨ or + pre-selection behavior whereby entering the first character of one or more sub-elements + causes those elements to scroll into view or become selected. Subsequent character input + may narrow the selection further as long as one or more sub-elements match the string. + This state is normally only useful and encountered on objects that implement Selection. + In some cases the typeahead behavior may result in full or partial ¨completion¨ of + the data in the input field, in which case these input events may trigger text-changed + events from the source.

+ +

@since AT-SPI 1.7.0

+ + + + +

This state indicates that the object in question supports text selection. + It should only be exposed on objects which implement the Text interface, + in order to distinguish this state from STATE_SELECTABLE, which infers that + the object in question is a selectable child of an object which implements + Selection. While similar, text selection and subelement selection are + distinct operations.

+ +

@since AT-SPI 1.7.0

+ + + + +

This state indicates that the object in question is the 'default' interaction object + in a dialog, i.e. the one that gets activated if the user presses "Enter" when the + dialog is initially posted.

+ +

@since AT-SPI 1.7.0

+ + + + +

This state indicates that the object (typically a hyperlink) + has already been activated or invoked, with the result that some backing data + has been downloaded or rendered.

+ +

@since AT-SPI 1.7.1

+ + + + +

This value of the enumeration should not be used as a parameter, it indicates the number of + items in the StateType enumeration.

+ + + + + +

The StateSet interface encapsulates a collection of state information. + It allows comparison of state information between object instances, and comparisons + of an object's state with some hypothetical collection of states.

+ + + +

Query a StateSet for a specific StateType. + @param state the StateType being queried for.

+ + + + + \c TRUE if the StateSet contains StateType \a state. + + + + + + Add a StateType to an existing StateSet, if not already present. + + + + + + Remove a StateType to an existing StateSet, if it is present. + + + + + +

Compare two statesets for equivalence. + @param tarStateSet the StateSet to be compared with this one.

+ + + + + \c TRUE if the two StateSet objects are composed of the same StateTypes. + + + + + + Compare two StateSet instances and obtain their differences. + + + + + a 'difference set', i.e. a StateSet consisting of those states not shared by the two sets being compared. + + + + + + + \c TRUE if the StateSet contains no states. + + + + + +

\cond + Private

+ + + + + +

unImplemented:

+ +

placeholders for future expansion.

+ + + + + + + + + + diff --git a/xml/Makefile.am b/xml/Makefile.am index d562661..23ab282 100644 --- a/xml/Makefile.am +++ b/xml/Makefile.am @@ -12,8 +12,10 @@ XML= \ Accessibility_Image.xml \ Accessibility_LoginHelper.xml \ Accessibility_Registry.xml \ + Accessibility_Role.xml \ Accessibility_Selection.xml \ Accessibility_Selector.xml \ + Accessibility_State.xml \ Accessibility_StreamableContent.xml \ Accessibility_Table.xml \ Accessibility_Text.xml \ -- 2.7.4