Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

Accessibility Namespace Reference


Classes

struct  BoundingBox
 Used by Component and Text, a struct defining a bounding rectangle. More...
interface  Accessible
 The base interface which is implemented by all accessible objects. More...
interface  Action
 An interface through which a user-actionable user interface component can be manipulated. More...
interface  Application
 An interface identifying an object which is the root of the user interface Accessible hierarchy associated with a running application. More...
struct  AccessibleSetEntry
 A structure that encapsulates an object reference for an Accessible, its localized name, and its Role. More...
interface  MatchRule
 An opaque object constructed via a call to Collection::createMatchRule and discarded via a call to Collection::freeMatchRule. More...
interface  Collection
 An interface designed to allow a subset of the complete accessible object 'tree' to be returned which satisfies a set of criteria. More...
interface  Component
 The Component interface is implemented by objects which occupy on-screen space, e.g. More...
interface  Desktop
 At the moment this is only a marker interface, it acts just like any other Accessible. More...
interface  Document
 Primarily a 'tagging' interface which indicates the start of document content in the Accessibility hierarchy. More...
interface  EditableText
 Derived from interface Text, EditableText provides methods for modifying textual content of components which support editing. More...
struct  EventDetails
 A struct encapsulating detailed information about an Event. More...
struct  Event
 A structure encapsulating information about an event for which notification was requested. More...
interface  EventListener
 A generic interface implemented by objects for the receipt of event notifications. More...
interface  Hyperlink
 Instances of Hyperlink are returned by Hypertext objects, and are the means by which end users and clients interact with linked, and in some cases embedded, content. More...
interface  Hypertext
 An interface used for objects which implement linking between multiple resource or content locations, or multiple 'markers' within a single document. More...
interface  Image
 An interface implemented by objects which render image data or pictorial information to the screen. More...
interface  LoginHelper
 An interface for use by assistive technologies by which they can access system information and services on a 'need to know' basis while the screen is locked, during user authentication, or during other sensitive operations. More...
interface  Registry
 The Registry is a service through which applications providing accessibility services (servers) can rendezvous with consumers of those services (Assistive Technologies). More...
struct  EventListenerMode
 A structure that encapsulates the characteristics of the event notifications that should be sent to an EventListener in response to a call to DeviceEventController::registerKeystrokeListener or DeviceEventController::registerDeviceEventListener. More...
struct  DeviceEvent
 A structure which encapsulates information about a device event. More...
struct  KeyDefinition
 A structure which defines the identity of a key for which notifications are to be requested. More...
interface  DeviceEventListener
 This interface should be implemented by AT-SPI clients who wish to make use of the DeviceEventController to receive device event notifications. More...
interface  DeviceEventController
 The interface via which clients request notification of device events, and through which device events may be simulated. More...
interface  Relation
 An interface via which objects' non-hierarchical relationships to one another are indicated. More...
interface  Selection
 An interface which indicates that an object exposes a 'selection' model, allowing the selection of one or more of its children. More...
struct  Command
 A structure which encapsulates both a string representation of a command and a unique command ID. More...
interface  CommandListener
 An interface which should be implemented by assistive technologies or other clients of the Selector interface, over which notifications to the list of available commands is made. More...
interface  Selector
 This interface is intended for use by assistive technologies and related user-agents. More...
interface  StateSet
 The StateSet interface encapsulates a collection of state information. More...
interface  StreamableContent
 An interface whereby an object allows its backing content to be streamed to clients. More...
interface  Table
 An interface used by containers whose contained data is arranged in a "tabular" (i.e. row-column) fashion. More...
interface  Terminal
 An interface dedicated to the support of virtual terminals and terminal emulators, in which row/column text position, and line-by-line access, are the dominant user model. More...
interface  Text
 The text interface should be implemented by objects which place textual information onscreen as character strings or glyphs. More...
interface  Value
 An interface supporting controls which allow a one-dimensional, scalar quantity to be modified or which reflect a scalar quantity. More...

Typedefs

typedef sequence< RelationRelationSet
 A list of Relations, which may be many-to-many.
typedef sequence< string > AttributeSet
 A list of name-value pairs, returned as a sequence of strings; the name and value are separated by a colon.
typedef sequence< RoleRoleSet
 A list of accessible roles.
typedef sequence< DesktopDesktopSeq
typedef unsigned long ControllerEventMask
 an unsigned short int consisting of zero or more of the following values OR'ed together:
typedef sequence< KeyDefinitionKeySet
typedef sequence< EventTypeKeyEventTypeSeq
typedef sequence< EventTypeEventTypeSeq
typedef sequence< CommandCommandList
 A list of Command objects.
typedef sequence< StateTypeStateSeq
typedef sequence< string > StringSeq
typedef sequence< long > LongSeq

Enumerations

enum  LOCALE_TYPE {
  LOCALE_TYPE_MESSAGES,
  LOCALE_TYPE_COLLATE,
  LOCALE_TYPE_CTYPE,
  LOCALE_TYPE_MONETARY,
  LOCALE_TYPE_NUMERIC,
  LOCALE_TYPE_TIME
}
 used by Text and Document: these correspond to the POSIX setlocale() enum values. More...
enum  ComponentLayer {
  LAYER_INVALID,
  LAYER_BACKGROUND,
  LAYER_CANVAS,
  LAYER_WIDGET,
  LAYER_MDI,
  LAYER_POPUP,
  LAYER_OVERLAY,
  LAYER_WINDOW,
  LAYER_LAST_DEFINED
}
 The ComponentLayer of a Component instance indicates its relative stacking order with respect to the onscreen visual representation of the UI. More...
enum  KeyEventType {
  KEY_PRESSED,
  KEY_RELEASED
}
 Deprecated, DO NOT USE! More...
enum  EventType {
  KEY_PRESSED_EVENT,
  KEY_RELEASED_EVENT,
  BUTTON_PRESSED_EVENT,
  BUTTON_RELEASED_EVENT
}
 Used to specify the event types of interest to an EventListener, or to identify the type of an event for which notification has been sent. More...
enum  KeySynthType {
  KEY_PRESS,
  KEY_RELEASE,
  KEY_PRESSRELEASE,
  KEY_SYM,
  KEY_STRING
}
 Used when synthesizing keyboard input via DeviceEventController:generateKeyboardEvent. More...
enum  ModifierType {
  MODIFIER_SHIFT,
  MODIFIER_SHIFTLOCK,
  MODIFIER_CONTROL,
  MODIFIER_ALT,
  MODIFIER_META,
  MODIFIER_META2,
  MODIFIER_META3,
  MODIFIER_NUMLOCK
}
enum  RelationType {
  RELATION_NULL,
  RELATION_LABEL_FOR,
  RELATION_LABELLED_BY,
  RELATION_CONTROLLER_FOR,
  RELATION_CONTROLLED_BY,
  RELATION_MEMBER_OF,
  RELATION_TOOLTIP_FOR,
  RELATION_NODE_CHILD_OF,
  RELATION_EXTENDED,
  RELATION_FLOWS_TO,
  RELATION_FLOWS_FROM,
  RELATION_SUBWINDOW_OF,
  RELATION_EMBEDS,
  RELATION_EMBEDDED_BY,
  RELATION_POPUP_FOR,
  RELATION_LAST_DEFINED
}
 RelationType specifies a relationship between objects (possibly one-to-many or many-to-one) outside of the normal parent/child hierarchical relationship. More...
enum  Role {
  ROLE_INVALID,
  ROLE_ACCELERATOR_LABEL,
  ROLE_ALERT,
  ROLE_ANIMATION,
  ROLE_ARROW,
  ROLE_CALENDAR,
  ROLE_CANVAS,
  ROLE_CHECK_BOX,
  ROLE_CHECK_MENU_ITEM,
  ROLE_COLOR_CHOOSER,
  ROLE_COLUMN_HEADER,
  ROLE_COMBO_BOX,
  ROLE_DATE_EDITOR,
  ROLE_DESKTOP_ICON,
  ROLE_DESKTOP_FRAME,
  ROLE_DIAL,
  ROLE_DIALOG,
  ROLE_DIRECTORY_PANE,
  ROLE_DRAWING_AREA,
  ROLE_FILE_CHOOSER,
  ROLE_FILLER,
  ROLE_FOCUS_TRAVERSABLE,
  ROLE_FONT_CHOOSER,
  ROLE_FRAME,
  ROLE_GLASS_PANE,
  ROLE_HTML_CONTAINER,
  ROLE_ICON,
  ROLE_IMAGE,
  ROLE_INTERNAL_FRAME,
  ROLE_LABEL,
  ROLE_LAYERED_PANE,
  ROLE_LIST,
  ROLE_LIST_ITEM,
  ROLE_MENU,
  ROLE_MENU_BAR,
  ROLE_MENU_ITEM,
  ROLE_OPTION_PANE,
  ROLE_PAGE_TAB,
  ROLE_PAGE_TAB_LIST,
  ROLE_PANEL,
  ROLE_PASSWORD_TEXT,
  ROLE_POPUP_MENU,
  ROLE_PROGRESS_BAR,
  ROLE_PUSH_BUTTON,
  ROLE_RADIO_BUTTON,
  ROLE_RADIO_MENU_ITEM,
  ROLE_ROOT_PANE,
  ROLE_ROW_HEADER,
  ROLE_SCROLL_BAR,
  ROLE_SCROLL_PANE,
  ROLE_SEPARATOR,
  ROLE_SLIDER,
  ROLE_SPIN_BUTTON,
  ROLE_SPLIT_PANE,
  ROLE_STATUS_BAR,
  ROLE_TABLE,
  ROLE_TABLE_CELL,
  ROLE_TABLE_COLUMN_HEADER,
  ROLE_TABLE_ROW_HEADER,
  ROLE_TEAROFF_MENU_ITEM,
  ROLE_TERMINAL,
  ROLE_TEXT,
  ROLE_TOGGLE_BUTTON,
  ROLE_TOOL_BAR,
  ROLE_TOOL_TIP,
  ROLE_TREE,
  ROLE_TREE_TABLE,
  ROLE_UNKNOWN,
  ROLE_VIEWPORT,
  ROLE_WINDOW,
  ROLE_EXTENDED,
  ROLE_HEADER,
  ROLE_FOOTER,
  ROLE_PARAGRAPH,
  ROLE_RULER,
  ROLE_APPLICATION,
  ROLE_AUTOCOMPLETE,
  ROLE_EDITBAR,
  ROLE_EMBEDDED,
  ROLE_LINK,
  ROLE_SUBMIT_BUTTON,
  ROLE_CANCEL_BUTTON,
  ROLE_UNDO_BUTTON,
  ROLE_BACK_BUTTON,
  ROLE_ENTRY,
  ROLE_CHART,
  ROLE_CAPTION,
  ROLE_DOCUMENT_FRAME,
  ROLE_HEADING,
  ROLE_PAGE,
  ROLE_SECTION,
  ROLE_LAST_DEFINED
}
enum  StateType {
  STATE_INVALID,
  STATE_ACTIVE,
  STATE_ARMED,
  STATE_BUSY,
  STATE_CHECKED,
  STATE_COLLAPSED,
  STATE_DEFUNCT,
  STATE_EDITABLE,
  STATE_ENABLED,
  STATE_EXPANDABLE,
  STATE_EXPANDED,
  STATE_FOCUSABLE,
  STATE_FOCUSED,
  STATE_HAS_TOOLTIP,
  STATE_HORIZONTAL,
  STATE_ICONIFIED,
  STATE_MODAL,
  STATE_MULTI_LINE,
  STATE_MULTISELECTABLE,
  STATE_OPAQUE,
  STATE_PRESSED,
  STATE_RESIZABLE,
  STATE_SELECTABLE,
  STATE_SELECTED,
  STATE_SENSITIVE,
  STATE_SHOWING,
  STATE_SINGLE_LINE,
  STATE_STALE,
  STATE_TRANSIENT,
  STATE_VERTICAL,
  STATE_VISIBLE,
  STATE_MANAGES_DESCENDANTS,
  STATE_INDETERMINATE,
  STATE_REQUIRED,
  STATE_ANIMATED,
  STATE_INVALID_ENTRY,
  STATE_SUPPORTS_TYPEAHEAD,
  STATE_SELECTABLE_TEXT,
  STATE_LAST_DEFINED
}
enum  TEXT_BOUNDARY_TYPE {
  TEXT_BOUNDARY_CHAR,
  TEXT_BOUNDARY_WORD_START,
  TEXT_BOUNDARY_WORD_END,
  TEXT_BOUNDARY_SENTENCE_START,
  TEXT_BOUNDARY_SENTENCE_END,
  TEXT_BOUNDARY_LINE_START,
  TEXT_BOUNDARY_LINE_END
}
 Specifies the boundary conditions determining a run of text as returned from getTextAtOffset, getTextAfterOffset, and getTextBeforeOffset. More...
enum  TEXT_CLIP_TYPE {
  TEXT_CLIP_NONE,
  TEXT_CLIP_MIN,
  TEXT_CLIP_MAX,
  TEXT_CLIP_BOTH
}
 TEXT_CLIP_TYPE: CLIP_MIN means text clipped by min coordinate is omitted, CLIP_MAX clips text interescted by the max coord, and CLIP_BOTH will retain only text falling fully within the min/max bounds. More...

Variables

Accessibility::AccessibleSetEntry AccessibleSet
 A list of Accessible instances, returned as a Sequence of Accessible objects.


Typedef Documentation

typedef sequence<Relation> Accessibility::RelationSet
 

A list of Relations, which may be many-to-many.

Definition at line 43 of file Accessibility_Accessible.idl.

typedef sequence<string> Accessibility::AttributeSet
 

A list of name-value pairs, returned as a sequence of strings; the name and value are separated by a colon.

Note:
"Attributes" returned in AttributeSet lists are distinct from, and should not be confused with, "attribute" members of interfaces as defined by the IDL "attribute" keyword. IDL attributes are strongly-typed values which are individually obtained via language-specific bindings whose syntax is dictated by the OMG's IDL language bindings. For instance using the C language, the "Accessible::name" attribute is queried using Accessibility_Accessible__get_name (obj, &ev); Name-value pairs associated with Accessible instances are not normally redundant with these IDL attributes, i.e. there is no "accessible-name" attribute in the AttributeSet returned from Accessible::getAttributes().
Since:
AT-SPI 1.7.0

Definition at line 63 of file Accessibility_Accessible.idl.

typedef sequence<Role> Accessibility::RoleSet
 

A list of accessible roles.

Since:
AT-SPI 1.7.0

Definition at line 69 of file Accessibility_Accessible.idl.

typedef sequence<Desktop> Accessibility::DesktopSeq
 

Definition at line 33 of file Accessibility_Registry.idl.

typedef unsigned long Accessibility::ControllerEventMask
 

an unsigned short int consisting of zero or more of the following values OR'ed together:

Definition at line 290 of file Accessibility_Registry.idl.

typedef sequence< KeyDefinition > Accessibility::KeySet
 

Definition at line 374 of file Accessibility_Registry.idl.

typedef sequence< EventType > Accessibility::KeyEventTypeSeq
 

Definition at line 375 of file Accessibility_Registry.idl.

typedef sequence< EventType > Accessibility::EventTypeSeq
 

Definition at line 376 of file Accessibility_Registry.idl.

typedef sequence<Command> Accessibility::CommandList
 

A list of Command objects.

Definition at line 37 of file Accessibility_Selector.idl.

typedef sequence<StateType> Accessibility::StateSeq
 

Definition at line 220 of file Accessibility_State.idl.

typedef sequence<string> Accessibility::StringSeq
 

Definition at line 27 of file Accessibility_StreamableContent.idl.

typedef sequence<long> Accessibility::LongSeq
 

Definition at line 27 of file Accessibility_Table.idl.


Enumeration Type Documentation

enum Accessibility::LOCALE_TYPE
 

used by Text and Document: these correspond to the POSIX setlocale() enum values.

Enumerator:
LOCALE_TYPE_MESSAGES 
LOCALE_TYPE_COLLATE 
LOCALE_TYPE_CTYPE 
LOCALE_TYPE_MONETARY 
LOCALE_TYPE_NUMERIC 
LOCALE_TYPE_TIME 

Definition at line 33 of file Accessibility_Accessible.idl.

enum Accessibility::ComponentLayer
 

The ComponentLayer of a Component instance indicates its relative stacking order with respect to the onscreen visual representation of the UI.

ComponentLayer, in combination with Component bounds information, can be used to compute the visibility of all or part of a component. This is important in programmatic determination of region-of-interest for magnification, and in ¨flat screen review¨ models of the screen, as well as for other uses. Objects residing in two of the ComponentLayer categories support further z-ordering information, with respect to their peers in the same layer: namely, LAYER_WINDOW and LAYER_MDI. Relative stacking order for other objects within the same layer is not available; the recommended heuristic is ¨first child paints first¨, in other words, assume that the first siblings in the child list are subject to being overpainted by later siblings if their bounds intersect.

The order of layers, from bottom to top, is:

  • LAYER_BACKGROUND
  • LAYER_WINDOW
  • LAYER_MDI
  • LAYER_CANVAS
  • LAYER_WIDGET
  • LAYER_POPUP
  • LAYER_OVERLAY
Enumerator:
LAYER_INVALID  Indicates an error condition or uninitialized value.
LAYER_BACKGROUND  The bottom-most layer, over which everything else is painted.

The 'desktop background' is generally in this layer.

LAYER_CANVAS  The 'background' layer for most content renderers and UI Component containers.
LAYER_WIDGET  The layer in which the majority of ordinary 'foreground' widgets reside.
LAYER_MDI  A special layer between LAYER_CANVAS and LAYER_WIDGET, in which the 'pseudo windows' (e.g.

the MDI frames) reside.

See also:
Component::getMDIZOrder
LAYER_POPUP  A layer for popup window content, above LAYER_WIDGET.
LAYER_OVERLAY  The topmost layer.
LAYER_WINDOW  The layer in which a toplevel window background usually resides.
LAYER_LAST_DEFINED  Used only to determine the end of the enumeration.

Definition at line 50 of file Accessibility_Component.idl.

enum Accessibility::KeyEventType
 

Deprecated, DO NOT USE!

Enumerator:
KEY_PRESSED 
KEY_RELEASED 

Definition at line 186 of file Accessibility_Registry.idl.

enum Accessibility::EventType
 

Used to specify the event types of interest to an EventListener, or to identify the type of an event for which notification has been sent.

See also:
EventTypeSeq, DeviceEvent::type
Enumerator:
KEY_PRESSED_EVENT  key on a keyboard device was pressed.
KEY_RELEASED_EVENT  key on a keyboard device was released.
BUTTON_PRESSED_EVENT  button on a non-keyboard human interface device (HID) was pressed
BUTTON_RELEASED_EVENT  button on a non-keyboard human interface device (HID) was pressed

Definition at line 195 of file Accessibility_Registry.idl.

enum Accessibility::KeySynthType
 

Used when synthesizing keyboard input via DeviceEventController:generateKeyboardEvent.

Enumerator:
KEY_PRESS 
KEY_RELEASE  emulate the pressing of a hardware keyboard key.
KEY_PRESSRELEASE  emulate the release of a hardware keyboard key.
KEY_SYM  a hardware keyboard key is pressed and immediately released.
KEY_STRING  a string is converted to its equivalent keyboard events and emitted.

If the string consists of complex character or composed characters which are not in the current keymap, string emission is subject to the out-of-keymap limitations described for KeySynthType::KEY_SYM. In practice this limitation primarily effects Chinese and Japanese locales.

Definition at line 205 of file Accessibility_Registry.idl.

enum Accessibility::ModifierType
 

Enumerator:
MODIFIER_SHIFT 
MODIFIER_SHIFTLOCK  The left or right 'Shift' key.
MODIFIER_CONTROL  The ShiftLock or CapsLock key.
MODIFIER_ALT  'Control'/'Ctrl'
MODIFIER_META  The Alt key (as opposed to AltGr).
MODIFIER_META2  depending on the platform this may map to 'Window', 'Function', 'Meta', 'Menu', or 'NumLock'.

Such 'Meta keys' will map to one of META, META2, META3. On X Windows platforms these META values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an event having ModifierType::MODIFIER_META2 means that the 'Mod2Mask' bit is set in the corresponding XEvent.

MODIFIER_META3 
MODIFIER_NUMLOCK  A symbolic meta key name that is mapped by AT-SPI to the appropriate META value, for the convenience of the client.

Definition at line 228 of file Accessibility_Registry.idl.

enum Accessibility::RelationType
 

RelationType specifies a relationship between objects (possibly one-to-many or many-to-one) outside of the normal parent/child hierarchical relationship.

It allows better semantic identification of how objects are associated with one another. For instance the RELATION_LABELLED_BY relationship may be used to identify labelling information that should accompany the accessibleName property when presenting an object's content or identity to the end user. Similarly, RELATION_CONTROLLER_FOR can be used to further specify the context in which a valuator is useful, and/or the other UI components which are directly effected by user interactions with the valuator. Common examples include association of scrollbars with the viewport or panel which they control.

Enumerator:
RELATION_NULL  Not a meaningful relationship; clients should not normally encounter this RelationType value.
RELATION_LABEL_FOR  Object is a label for one or more other objects.
RELATION_LABELLED_BY  Object is labelled by one or more other objects.
RELATION_CONTROLLER_FOR  Object is an interactive object which modifies the state, onscreen location, or other attributes of one or more target objects.
RELATION_CONTROLLED_BY  Object state, position, etc.

is modified/controlled by user interaction with one or more other objects. For instance a viewport or scroll pane may be CONTROLLED_BY scrollbars.

RELATION_MEMBER_OF  Object has a grouping relationship (e.g.

¨same group as¨) to one or more other objects.

RELATION_TOOLTIP_FOR  Object is a tooltip associated with another object.
RELATION_NODE_CHILD_OF  Reserved for future use.
RELATION_EXTENDED  Used to indicate that a relationship exists, but its type is not specified in the enumeration and must be obtained via a call to getRelationName.
RELATION_FLOWS_TO  Object renders content which flows logically to another object.

For instance, text in a paragraph may flow to another object which is not the ¨next sibling¨ in the accessibility hierarchy.

RELATION_FLOWS_FROM  Reciprocal of RELATION_FLOWS_TO.
RELATION_SUBWINDOW_OF  Object is visually and semantically considered a subwindow of another object, even though it is not the object's child.

Useful when dealing with embedded applications and other cases where the widget hierarchy does not map cleanly to the onscreen presentation.

RELATION_EMBEDS  Similar to SUBWINDOW_OF, but specifically used for cross-process embedding.
RELATION_EMBEDDED_BY  Reciprocal of RELATION_EMBEDS; Used to denote content rendered by embedded renderers that live in a separate process space from the embedding context.
RELATION_POPUP_FOR  Denotes that the object is a transient window or frame associated with another onscreen object.

Similar to TOOLTIP_FOR, but more general. Useful for windows which are technically toplevels but which, for one or more reasons, do not explicitly cause their associated window to lose ¨window focus¨. Creation of a ROLE_WINDOW object with the POPUP_FOR relation usually requires some presentation action on the part of assistive technology clients, even though the previous toplevel ROLE_FRAME object may still be the active window.

RELATION_LAST_DEFINED  Do not use as a parameter value, used to determine the size of the enumeration.

Definition at line 39 of file Accessibility_Relation.idl.

enum Accessibility::Role
 

Enumerator:
ROLE_INVALID  A Role indicating an error condition, such as uninitialized Role data.
ROLE_ACCELERATOR_LABEL  Object is a label indicating the keyboard accelerators for the parent.
ROLE_ALERT  Object is used to alert the user about something.
ROLE_ANIMATION  Object contains a dynamic or moving image of some kind.
ROLE_ARROW  Object is a 2d directional indicator.
ROLE_CALENDAR  Object contains one or more dates, usually arranged into a 2d list.
ROLE_CANVAS  Object that can be drawn into and is used to trap events.
ROLE_CHECK_BOX  A choice that can be checked or unchecked and provides a separate indicator for the current state.
ROLE_CHECK_MENU_ITEM  A menu item that behaves like a check box (see ROLE_CHECK_BOX).
ROLE_COLOR_CHOOSER  A specialized dialog that lets the user choose a color.
ROLE_COLUMN_HEADER  The header for a column of data.
ROLE_COMBO_BOX  A list of choices the user can select from.
ROLE_DATE_EDITOR  An object which allows entry of a date.
ROLE_DESKTOP_ICON  An inconifed internal frame within a DESKTOP_PANE.
ROLE_DESKTOP_FRAME  A pane that supports internal frames and iconified versions of those internal frames.
ROLE_DIAL  An object that allows a value to be changed via rotating a visual element, or which displays a value via such a rotating element.
ROLE_DIALOG  A top level window with title bar and a border.
ROLE_DIRECTORY_PANE  A pane that allows the user to navigate through and select the contents of a directory.
ROLE_DRAWING_AREA  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.
ROLE_FILE_CHOOSER  An object used for drawing custom user interface elements.
ROLE_FILLER  A object that fills up space in a user interface.
ROLE_FOCUS_TRAVERSABLE  XXX Don't use, reserved for future use.
ROLE_FONT_CHOOSER  Allows selection of a display font.
ROLE_FRAME  A top level window with a title bar, border, menubar, etc.
ROLE_GLASS_PANE  A pane that is guaranteed to be painted on top of all panes beneath it.
ROLE_HTML_CONTAINER  A document container for HTML, whose children represent the document content.
ROLE_ICON  A small fixed size picture, typically used to decorate components.
ROLE_IMAGE  An image, typically static.
ROLE_INTERNAL_FRAME  A frame-like object that is clipped by a desktop pane.
ROLE_LABEL  An object used to present an icon or short string in an interface.
ROLE_LAYERED_PANE  A specialized pane that allows its children to be drawn in layers, providing a form of stacking order.
ROLE_LIST  An object that presents a list of objects to the user and allows the user to select one or more of them.
ROLE_LIST_ITEM  An object that represents an element of a list.
ROLE_MENU  An object usually found inside a menu bar that contains a list of actions the user can choose from.
ROLE_MENU_BAR  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.
ROLE_MENU_ITEM  An object usually contained in a menu that presents an action the user can choose.
ROLE_OPTION_PANE  A specialized pane whose primary use is inside a DIALOG.
ROLE_PAGE_TAB  An object that is a child of a page tab list.
ROLE_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.
ROLE_PANEL  A generic container that is often used to group objects.
ROLE_PASSWORD_TEXT  A text object uses for passwords, or other places where the text content is not shown visibly to the user.
ROLE_POPUP_MENU  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.
ROLE_PROGRESS_BAR  An object used to indicate how much of a task has been completed.
ROLE_PUSH_BUTTON  An object the user can manipulate to tell the application to do something.
ROLE_RADIO_BUTTON  A specialized check box that will cause other radio buttons in the same group to become uncghecked when this one is checked.
ROLE_RADIO_MENU_ITEM  Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON).
ROLE_ROOT_PANE  A specialized pane that has a glass pane and a layered pane as its children.
ROLE_ROW_HEADER  The header for a row of data.
ROLE_SCROLL_BAR  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.
ROLE_SCROLL_PANE  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 also:
Accessibility::RelationSet.
ROLE_SEPARATOR  An object usually contained in a menu to provide a visible and logical separation of the contents in a menu.
ROLE_SLIDER  An object that allows the user to select from a bounded range.
ROLE_SPIN_BUTTON  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.

ROLE_SPLIT_PANE  A specialized panel that presents two other panels at the same time.
ROLE_STATUS_BAR  Object displays non-quantitative status information (c.f.

ROLE_PROGRESS_BAR)

ROLE_TABLE  An object used to repesent information in terms of rows and columns.
ROLE_TABLE_CELL  A 'cell' or discrete child within a Table.

Note:
Table cells need not have ROLE_TABLE_CELL, other RoleType values are valid as well.
ROLE_TABLE_COLUMN_HEADER  An object which labels a particular column in a Table.
ROLE_TABLE_ROW_HEADER  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 also:
Accessibility::RelationSet.
ROLE_TEAROFF_MENU_ITEM  Object allows menu to be removed from menubar and shown in its own window.
ROLE_TERMINAL  An object that emulates a terminal.
ROLE_TEXT  An object that presents text to the user, of nonspecific type.
ROLE_TOGGLE_BUTTON  A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state.
ROLE_TOOL_BAR  A bar or palette usually composed of push buttons or toggle buttons.
ROLE_TOOL_TIP  An object that provides information about another object.
ROLE_TREE  An object used to repsent hierarchical information to the user.
ROLE_TREE_TABLE  An object that presents both tabular and hierarchical info to the user.
ROLE_UNKNOWN  The object contains some Accessible information, but its role is not known.
ROLE_VIEWPORT  An object usually used in a scroll pane, or to otherwise clip a larger object or content renderer to a specific onscreen viewport.
ROLE_WINDOW  A ¨top level window¨ with no title or border.
ROLE_EXTENDED  means that the role for this item is known, but not included in the core enumeration
ROLE_HEADER  An object that serves as a document header.
ROLE_FOOTER  An object that serves as a document footer.
ROLE_PARAGRAPH  An object which is contains a single paragraph of text content.

See also:
also ROLE_TEXT.
ROLE_RULER  An object which describes margins and tab stops, etc.

for text objects which it controls (should have CONTROLLER_FOR relation to such).

ROLE_APPLICATION  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.

ROLE_AUTOCOMPLETE  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.
ROLE_EDITBAR  The object is an editable text object in a toolbar.
ROLE_EMBEDDED  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.

ROLE_LINK  The object is a link to some other content, for instance to a URI in this or another document.

ROLE_LINK can occur primarily in two situations; as the role of an object returned via the Hypertext::getLink, or, more importantly, as the role of a standalone object that implements the Hypertext interface but points to only one link object.

Note:
NOT SURE ABOUT THIS ONE, the description makes it sound pretty ropy. Why aren't links just identified via the Hypertext interface? For non-textual hyperlinks (as allowed in XHTML 2.0), shouldn't this role be ROLE_IMAGE or ROLE_ICON?
Since:
AT-SPI 1.7.0
ROLE_SUBMIT_BUTTON  The object is a push button whose activation by the user indicates completion of data entry in a form or dialog.

Common examples include buttons labelled ¨Submit¨, ¨Close¨ (for instant-apply cases), ¨OK¨, ¨Apply¨, etc.

Since:
AT-SPI 1.7.0
ROLE_CANCEL_BUTTON  The object is a push button whose activation by the user cancels or reverts the current user operation.

Inside a container of ROLE_DIALOG, it generally results in the closure or 'unposting' of the dialog.

Since:
AT-SPI 1.7.0
ROLE_UNDO_BUTTON  The object is a push button whose activation by the user reverts the most recent user editing operation.

It is distinguished from ROLE_CANCEL_BUTTON by reverting user operations incrementally, and not closing the current user dialog.

Since:
AT-SPI 1.7.0
ROLE_BACK_BUTTON  The object is a push button whose activation by the user reverts navigation by one step, i.e.

in a browsing or viewing model it returns the user to the previous document, page, or view (where the step size is implied by the context). Differs from ROLE_UNDO_BUTTON in that it affects navigation or viewing operations as opposed to editing operations.

Since:
AT-SPI 1.7.0
ROLE_ENTRY  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
ROLE_CHART  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 also:
ROLE_CAPTION
Since:
AT-SPI 1.7.0
ROLE_CAPTION  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
ROLE_DOCUMENT_FRAME  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
ROLE_HEADING  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
ROLE_PAGE  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
ROLE_SECTION  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
ROLE_LAST_DEFINED  not a valid role, used for finding end of enumeration.

Definition at line 28 of file Accessibility_Role.idl.

enum Accessibility::StateType
 

Enumerator:
STATE_INVALID 
STATE_ACTIVE  Indicates a window is currently the active window, or is an active subelement within a container or table.
STATE_ARMED  Indicates that the object is armed.
STATE_BUSY  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.

STATE_CHECKED  Indicates this object is currently checked.
STATE_COLLAPSED  Indicates this object is collapsed.
STATE_DEFUNCT  Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed).
STATE_EDITABLE  Indicates the user can change the contents of this object.
STATE_ENABLED  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 also:
STATE_SENSITIVE.
STATE_EXPANDABLE  Indicates this object allows progressive disclosure of its children.
STATE_EXPANDED  Indicates this object its expanded.
STATE_FOCUSABLE  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.
STATE_FOCUSED  Indicates this object currently has the keyboard focus.
STATE_HAS_TOOLTIP  Indicates that the object has an associated tooltip.
STATE_HORIZONTAL  Indicates the orientation of thsi object is horizontal.
STATE_ICONIFIED  Indicates this object is minimized and is represented only by an icon.
STATE_MODAL  Indicates something must be done with this object before the user can interact with an object in a different window.
STATE_MULTI_LINE  Indicates this (text) object can contain multiple lines of text.
STATE_MULTISELECTABLE  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.
STATE_OPAQUE  Indicates this object paints every pixel within its rectangular region.

It also indicates an alpha value of unity, if it supports alpha blending.

STATE_PRESSED  Indicates this object is currently pressed.
STATE_RESIZABLE  Indicates the size of this object's size is not fixed.
STATE_SELECTABLE  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.
STATE_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.
STATE_SENSITIVE  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 also:
STATE_ENABLED, STATE_INDETERMINATE.
STATE_SHOWING  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.

STATE_SINGLE_LINE  Indicates this (text) object can contain only a single line of text.
STATE_STALE  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.

STATE_TRANSIENT  Indicates this object is transient.
STATE_VERTICAL  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.
STATE_VISIBLE  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'.
STATE_MANAGES_DESCENDANTS  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.

STATE_INDETERMINATE  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.

STATE_REQUIRED  Indicates that user interaction with this object is 'required' from the user, for instance before completing the processing of a form.
STATE_ANIMATED  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
STATE_INVALID_ENTRY  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
STATE_SUPPORTS_TYPEAHEAD  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
STATE_SELECTABLE_TEXT  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
STATE_LAST_DEFINED  This value of the enumeration should not be used as a parameter, it indicates the number of items in the StateType enumeration.

Definition at line 28 of file Accessibility_State.idl.

enum Accessibility::TEXT_BOUNDARY_TYPE
 

Specifies the boundary conditions determining a run of text as returned from getTextAtOffset, getTextAfterOffset, and getTextBeforeOffset.

Enumerator:
TEXT_BOUNDARY_CHAR  Text is bounded by this character only.

Start and end offsets differ by one, by definition, for this value.

TEXT_BOUNDARY_WORD_START  Boundary condition is start of a word; i.e.

range is from start of one word to the start of another word.

TEXT_BOUNDARY_WORD_END  Boundary condition is the end of a word; i.e.

range is from the end of one word to the end of another.

Note:
some locales may not distinguish between words and characters or glyphs, in particular those locales which use wholly or partially ideographic character sets. In these cases, characters may be returned in lieu of multi-character substrings.
TEXT_BOUNDARY_SENTENCE_START  Boundary condition is start of a sentence, as determined by the application.

Note:
Some locales or character sets may not include explicit sentence delimiters, so this boundary type can not always be honored. Some locales will return lines of text instead of grammatical sentences.
TEXT_BOUNDARY_SENTENCE_END  Boundary condition is end of a sentence, as determined by the application, including the sentence-delimiting character, for instance '.

'

Note:
Some locales or character sets may not include explicit sentence delimiters, so this boundary type can not always be honored. Some locales will return lines of text instead of grammatical sentences.
TEXT_BOUNDARY_LINE_START  Boundary condition is the start of a line; i.e.

range is from start of one line to the start of another. This generally means that an end-of-line character will appear at the end of the range.

TEXT_BOUNDARY_LINE_END  Boundary condition is the end of a line; i.e.

range is from start of one line to the start of another. This generally means that an end-of-line character will be the first character of the range.

Definition at line 29 of file Accessibility_Text.idl.

enum Accessibility::TEXT_CLIP_TYPE
 

TEXT_CLIP_TYPE: CLIP_MIN means text clipped by min coordinate is omitted, CLIP_MAX clips text interescted by the max coord, and CLIP_BOTH will retain only text falling fully within the min/max bounds.

Enumerator:
TEXT_CLIP_NONE 
TEXT_CLIP_MIN  characters/glyphs clipped by the minimum coordinate are omitted
TEXT_CLIP_MAX  characters/glyphs which intersect the maximum coordinate are omitted
TEXT_CLIP_BOTH  only glyphs falling entirely within the region bounded by min and max are retained.

Definition at line 72 of file Accessibility_Text.idl.


Variable Documentation

struct Accessibility::AccessibleSetEntry Accessibility::AccessibleSet
 

A list of Accessible instances, returned as a Sequence of Accessible objects.


Generated on Fri Dec 2 15:20:45 2005 for AT_SPI_IDL by  doxygen 1.4.3