|
LibreOffice Module winaccessibility (master) 1
|
Go to the source code of this file.
Classes | |
| struct | IA2TableModelChange |
| A structure defining the type of and extents of changes made to a table. More... | |
| interface | IAccessibleRelation |
| This interface gives access to an object's set of relations. More... | |
| interface | IAccessibleAction |
| This interface gives access to actions that can be executed for accessible objects. More... | |
| struct | IA2Locale |
| A structure defining the locale of an accessible object. More... | |
| interface | IAccessible2 |
| This interface exposes the primary set of information about an IAccessible2 enabled accessible object. More... | |
| interface | IAccessible2_2 |
| This interface exposes the primary set of information about an IAccessible2 enabled accessible object. More... | |
| interface | IAccessibleComponent |
| This interface is implemented by any object that can be rendered on the screen. More... | |
| interface | IAccessibleValue |
| This interface gives access to a single numerical value. More... | |
| struct | IA2TextSegment |
| A structure containing a substring and the start and end offsets in the enclosing string. More... | |
| interface | IAccessibleText |
| This interface gives read-only access to text. More... | |
| interface | IAccessibleText2 |
| This interface gives read-only access to text. More... | |
| interface | IAccessibleEditableText |
| This interface provides clipboard capability to text objects. More... | |
| interface | IAccessibleHyperlink |
| This interface represents hyperlinks. More... | |
| interface | IAccessibleHypertext |
| This interface exposes information about hypertext in a document. More... | |
| interface | IAccessibleHypertext2 |
| This interface exposes information about hypertext in a document. More... | |
| interface | IAccessibleTable |
| This interface gives access to a two-dimensional table. More... | |
| interface | IAccessibleTable2 |
| This interface gives access to a two-dimensional table. More... | |
| interface | IAccessibleTableCell |
| This interface gives access to the cells of a two-dimensional table. More... | |
| interface | IAccessibleImage |
| This interface represents images and icons. More... | |
| interface | IAccessibleApplication |
| This interface gives access to the application's name and version information. More... | |
| interface | IAccessibleDocument |
| This interface represents documents. More... | |
Modules | |
| library | IAccessible2Lib |
Typedefs | |
| typedef struct IA2TableModelChange | IA2TableModelChange |
| A structure defining the type of and extents of changes made to a table. More... | |
| typedef long | AccessibleStates |
| typedef struct IA2Locale | IA2Locale |
| A structure defining the locale of an accessible object. More... | |
| typedef long | IA2Color |
| A value specifying a color in ARGB format, where each 8 bit color component specifies alpha, red, green, and blue respectively. More... | |
| typedef struct IA2TextSegment | IA2TextSegment |
| A structure containing a substring and the start and end offsets in the enclosing string. More... | |
Functions | |
| IAccessible2Lib::importlib ("stdole2.tlb") | |
| IAccessible2Lib::importlib ("oleacc.dll") | |
Variables | |
| const WCHAR *const | IA2_RELATION_CONTAINING_APPLICATION = L"containingApplication" |
| The target object is the containing application object. More... | |
| const WCHAR *const | IA2_RELATION_CONTAINING_DOCUMENT = L"containingDocument" |
| The target object is the containing document object. More... | |
| const WCHAR *const | IA2_RELATION_CONTAINING_TAB_PANE = L"containingTabPane" |
| The target object is the containing tab pane object. More... | |
| const WCHAR *const | IA2_RELATION_CONTAINING_WINDOW = L"containingWindow" |
| The target object is the containing window object. More... | |
| const WCHAR *const | IA2_RELATION_CONTROLLED_BY = L"controlledBy" |
| Some attribute of this object is affected by a target object. More... | |
| const WCHAR *const | IA2_RELATION_CONTROLLER_FOR = L"controllerFor" |
| This object is interactive and controls some attribute of a target object. More... | |
| const WCHAR *const | IA2_RELATION_DESCRIBED_BY = L"describedBy" |
| This object is described by the target object. More... | |
| const WCHAR *const | IA2_RELATION_DESCRIPTION_FOR = L"descriptionFor" |
| This object is describes the target object. More... | |
| const WCHAR *const | IA2_RELATION_EMBEDDED_BY = L"embeddedBy" |
| This object is embedded by a target object. More... | |
| const WCHAR *const | IA2_RELATION_EMBEDS = L"embeds" |
| This object embeds a target object. More... | |
| const WCHAR *const | IA2_RELATION_FLOWS_FROM = L"flowsFrom" |
| Content flows to this object from a target object. More... | |
| const WCHAR *const | IA2_RELATION_FLOWS_TO = L"flowsTo" |
| Content flows from this object to a target object. More... | |
| const WCHAR *const | IA2_RELATION_LABEL_FOR = L"labelFor" |
| This object is label for a target object. More... | |
| const WCHAR *const | IA2_RELATION_LABELED_BY = L"labelledBy" |
| This object is labelled by a target object. More... | |
| const WCHAR *const | IA2_RELATION_LABELLED_BY = L"labelledBy" |
| This object is labelled by a target object. More... | |
| const WCHAR *const | IA2_RELATION_MEMBER_OF = L"memberOf" |
| This object is a member of a group of one or more objects. More... | |
| const WCHAR *const | IA2_RELATION_NEXT_TABBABLE = L"nextTabbable" |
| The target object is the next object in the tab order. More... | |
| const WCHAR *const | IA2_RELATION_NODE_CHILD_OF = L"nodeChildOf" |
| This object is a logical child of a target object. More... | |
| const WCHAR *const | IA2_RELATION_NODE_PARENT_OF = L"nodeParentOf" |
| This object is a logical parent of a target object. More... | |
| const WCHAR *const | IA2_RELATION_PARENT_WINDOW_OF = L"parentWindowOf" |
| This object is a parent window of the target object. More... | |
| const WCHAR *const | IA2_RELATION_POPUP_FOR = L"popupFor" |
| This object is a transient component related to the target object. More... | |
| const WCHAR *const | IA2_RELATION_PREVIOUS_TABBABLE = L"previousTabbable" |
| The target object is the previous object in the tab order. More... | |
| const WCHAR *const | IA2_RELATION_SUBWINDOW_OF = L"subwindowOf" |
| This object is a sub window of a target object. More... | |
| typedef long AccessibleStates |
Definition at line 1045 of file ia2_api_all.idl.
| typedef long IA2Color |
A value specifying a color in ARGB format, where each 8 bit color component specifies alpha, red, green, and blue respectively.
The alpha value is optional.
Definition at line 2074 of file ia2_api_all.idl.
A structure defining the locale of an accessible object.
IAccessible2::locale returns this struct.
| typedef struct IA2TableModelChange IA2TableModelChange |
A structure defining the type of and extents of changes made to a table.
IAccessibleTable::modelChange and IAccessibleTable2::modelChange return this struct. In the case of an insertion or change the row and column offsets define the boundaries of the inserted or changed subtable after the operation. In the case of a deletion the row and column offsets define the boundaries of the subtable being removed before the removal.
| typedef struct IA2TextSegment IA2TextSegment |
A structure containing a substring and the start and end offsets in the enclosing string.
IAccessibleText::newText and IAccessibleText::oldText return this struct.
| enum IA2Actions |
This enum defines values which are predefined actions for use when implementing support for media.
This enum is used when specifying an action for IAccessibleAction::doAction.
Definition at line 538 of file ia2_api_all.idl.
| enum IA2CoordinateType |
These constants define which coordinate system a point is located in.
This enum is used in IAccessible2::scrollToPoint, IAccessibleImage::imagePosition, IAccessibleText::characterExtents, and IAccessibleText::offsetAtPoint, and IAccessibleText::scrollSubstringToPoint.
Definition at line 197 of file ia2_api_all.idl.
| enum IA2EventID |
IAccessible2 specific event constants
This enum defines the event IDs fired by IAccessible2 objects. The event IDs are in addition to those used by MSAA.
| Enumerator | |
|---|---|
| IA2_EVENT_ACTION_CHANGED | The change of the number or attributes of actions of an accessible object is signaled by events of this type. |
| IA2_EVENT_ACTIVE_DECENDENT_CHANGED | Deprecated. The active descendant of a component has changed. Note: This event constant is misspelled and thus is deprecated and will be removed in a later version. Please use the correctly spelled version which follows. |
| IA2_EVENT_ACTIVE_DESCENDANT_CHANGED | The active descendant of a component has changed. The active descendant is used in objects with transient children. Note: Due to the fact that MSAA's WinEvents don't allow the active child index to be passed on the IA2_EVENT_ACTIVE_DESCENDANT_CHANGED event the manages descendants scheme can't be used. Instead the active child object has to fire MSAA's EVENT_OBJECT_FOCUS. In a future release a new event mechanism may be added to provide for event specific data to be passed with the event. At that time the IA2_EVENT_ACTIVE_DECENDENT_CHANGED event and IA2_STATE_MANAGES_DESCENDANTS state would be useful. |
| IA2_EVENT_DOCUMENT_ATTRIBUTE_CHANGED | The document wide attributes of the document object have changed. |
| IA2_EVENT_DOCUMENT_CONTENT_CHANGED | The contents of the document have changed. |
| IA2_EVENT_DOCUMENT_LOAD_COMPLETE | The loading of the document has completed. |
| IA2_EVENT_DOCUMENT_LOAD_STOPPED | The loading of the document was interrupted. |
| IA2_EVENT_DOCUMENT_RELOAD | The document contents are being reloaded. |
| IA2_EVENT_HYPERLINK_END_INDEX_CHANGED | The ending index of this link within the containing string has changed. |
| IA2_EVENT_HYPERLINK_NUMBER_OF_ANCHORS_CHANGED | The number of anchors associated with this hyperlink object has changed. |
| IA2_EVENT_HYPERLINK_SELECTED_LINK_CHANGED | The hyperlink selected state changed from selected to unselected or from unselected to selected. |
| IA2_EVENT_HYPERTEXT_LINK_ACTIVATED | One of the links associated with the hypertext object has been activated. |
| IA2_EVENT_HYPERTEXT_LINK_SELECTED | One of the links associated with the hypertext object has been selected. |
| IA2_EVENT_HYPERLINK_START_INDEX_CHANGED | The starting index of this link within the containing string has changed. |
| IA2_EVENT_HYPERTEXT_CHANGED | Focus has changed from one hypertext object to another, or focus moved from a non-hypertext object to a hypertext object, or focus moved from a hypertext object to a non-hypertext object. |
| IA2_EVENT_HYPERTEXT_NLINKS_CHANGED | The number of hyperlinks associated with a hypertext object changed. |
| IA2_EVENT_OBJECT_ATTRIBUTE_CHANGED | An object's attributes changed. Also see IA2_EVENT_TEXT_ATTRIBUTE_CHANGED. |
| IA2_EVENT_PAGE_CHANGED | A slide changed in a presentation document or a page boundary was crossed in a word processing document. |
| IA2_EVENT_SECTION_CHANGED | The caret moved from one section to the next. |
| IA2_EVENT_TABLE_CAPTION_CHANGED | A table caption changed. |
| IA2_EVENT_TABLE_COLUMN_DESCRIPTION_CHANGED | A table's column description changed. |
| IA2_EVENT_TABLE_COLUMN_HEADER_CHANGED | A table's column header changed. |
| IA2_EVENT_TABLE_MODEL_CHANGED | A table's data changed. |
| IA2_EVENT_TABLE_ROW_DESCRIPTION_CHANGED | A table's row description changed. |
| IA2_EVENT_TABLE_ROW_HEADER_CHANGED | A table's row header changed. |
| IA2_EVENT_TABLE_SUMMARY_CHANGED | A table's summary changed. |
| IA2_EVENT_TEXT_ATTRIBUTE_CHANGED | A text object's attributes changed. Also see IA2_EVENT_OBJECT_ATTRIBUTE_CHANGED. |
| IA2_EVENT_TEXT_CARET_MOVED | The caret has moved to a new position. |
| IA2_EVENT_TEXT_CHANGED | Deprecated. This event is equivalent to IA2_EVENT_TEXT_UPDATED. |
| IA2_EVENT_TEXT_COLUMN_CHANGED | The caret moved from one column to the next. |
| IA2_EVENT_TEXT_INSERTED | Text was inserted. |
| IA2_EVENT_TEXT_REMOVED | Text was removed. |
| IA2_EVENT_TEXT_UPDATED | This event indicates general text changes, i.e. changes to text that are exposed through the IAccessibleText interface. For compatibility with ATK/AT-SPI which does not have an equivalent event, servers can alternatively fire IA2_EVENT_TEXT_REMOVED and IA2_EVENT_TEXT_INSERTED. |
| IA2_EVENT_TEXT_SELECTION_CHANGED | The text selection changed. Later versions of Microsoft development environments have an equivalent event identified, EVENT_OBJECT_TEXTSELECTIONCHANGED. Servers should use that if it is available and use IA2_EVENT_TEXT_SELECTION_CHANGED otherwise. Clients should be prepared to respond to either event. |
| IA2_EVENT_VISIBLE_DATA_CHANGED | A visible data event indicates the change of the visual appearance of an accessible object. This includes for example most of the attributes available via the IAccessibleComponent interface. |
Definition at line 5006 of file ia2_api_all.idl.
| enum IA2Role |
Collection of roles.
This enumerator defines an extended set of accessible roles of objects implementing the IAccessible2 interface. These roles are in addition to the MSAA roles obtained through the MSAA get_accRole method. Examples are 'footnote', 'heading', and 'label'. You obtain an object's IAccessible2 roles by calling IAccessible2::role.
| Enumerator | |
|---|---|
| IA2_ROLE_UNKNOWN | Unknown role. The object contains some Accessible information, but its role is not known. |
| IA2_ROLE_CANVAS | An object that can be drawn into and to manage events from the objects drawn into it. Also refer to IA2_ROLE_FRAME, IA2_ROLE_GLASS_PANE, and IA2_ROLE_LAYERED_PANE. |
| IA2_ROLE_CAPTION | A caption describing another object. |
| IA2_ROLE_CHECK_MENU_ITEM | Used for check buttons that are menu items. |
| IA2_ROLE_COLOR_CHOOSER | A specialized dialog that lets the user choose a color. |
| IA2_ROLE_DATE_EDITOR | A date editor. |
| IA2_ROLE_DESKTOP_ICON | An iconified internal frame in an IA2_ROLE_DESKTOP_PANE. Also refer to IA2_ROLE_INTERNAL_FRAME. |
| IA2_ROLE_DESKTOP_PANE | A desktop pane. A pane that supports internal frames and iconified versions of those internal frames. Also refer to IA2_ROLE_INTERNAL_FRAME. |
| IA2_ROLE_DIRECTORY_PANE | A directory pane. A pane that allows the user to navigate through and select the contents of a directory. May be used by a file chooser. Also refer to IA2_ROLE_FILE_CHOOSER. |
| IA2_ROLE_EDITBAR | An editable text object in a toolbar. Deprecated. The edit bar role was meant for a text area in a tool bar. However, to detect a text area in a tool bar the AT can query the parent. |
| IA2_ROLE_EMBEDDED_OBJECT | Embedded (OLE) object. |
| IA2_ROLE_ENDNOTE | Text that is used as an endnote (footnote at the end of a chapter or section). |
| IA2_ROLE_FILE_CHOOSER | A file chooser. 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. May use the directory pane to show the contents of a directory. Also refer to IA2_ROLE_DIRECTORY_PANE. |
| IA2_ROLE_FONT_CHOOSER | A font chooser. A font chooser is a component that lets the user pick various attributes for fonts. |
| IA2_ROLE_FOOTER | Footer of a document page. Also refer to IA2_ROLE_HEADER. |
| IA2_ROLE_FOOTNOTE | Text that is used as a footnote. Also refer to IA2_ROLE_ENDNOTE. |
| IA2_ROLE_FORM | A container of form controls. An example of the use of this role is to represent an HTML FORM tag. |
| IA2_ROLE_FRAME | Frame role. A top level window with a title bar, border, menu bar, etc. It is often used as the primary window for an application. Also refer to IA2_ROLE_CANVAS and the MSAA roles of dialog and window. |
| IA2_ROLE_GLASS_PANE | A glass pane. A pane that is guaranteed to be painted on top of all panes beneath it. Also refer to IA2_ROLE_CANVAS, IA2_ROLE_INTERNAL_FRAME, and IA2_ROLE_ROOT_PANE. |
| IA2_ROLE_HEADER | Header of a document page. Also refer to IA2_ROLE_FOOTER. |
| IA2_ROLE_HEADING | Heading. Use the IAccessible2::attributes level attribute to determine the heading level. |
| IA2_ROLE_ICON | A small fixed size picture, typically used to decorate components. |
| IA2_ROLE_IMAGE_MAP | An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. |
| IA2_ROLE_INPUT_METHOD_WINDOW | An object which is used to allow input of characters not found on a keyboard, such as the input of Chinese characters on a Western keyboard. |
| IA2_ROLE_INTERNAL_FRAME | An internal frame. A frame-like object that is clipped by a desktop pane. The desktop pane, internal frame, and desktop icon objects are often used to create multiple document interfaces within an application. Also refer to IA2_ROLE_DESKTOP_ICON, IA2_ROLE_DESKTOP_PANE, and IA2_ROLE_FRAME. |
| IA2_ROLE_LABEL | An object used to present an icon or short string in an interface. |
| IA2_ROLE_LAYERED_PANE | A layered pane. A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. This is usually the pane that holds the menu bar as well as the pane that contains most of the visual components in a window. Also refer to IA2_ROLE_CANVAS, IA2_ROLE_GLASS_PANE, and IA2_ROLE_ROOT_PANE. |
| IA2_ROLE_NOTE | A section whose content is parenthetic or ancillary to the main content of the resource. |
| IA2_ROLE_OPTION_PANE | A specialized pane whose primary use is inside a dialog. Also refer to MSAA's dialog role. |
| IA2_ROLE_PAGE | An object representing a page of document content. It is used in documents which are accessed by the user on a page by page basis. |
| IA2_ROLE_PARAGRAPH | A paragraph of text. |
| IA2_ROLE_RADIO_MENU_ITEM | A radio button that is a menu item. Also refer to MSAA's button and menu item roles. |
| IA2_ROLE_REDUNDANT_OBJECT | An object which is redundant with another object in the accessible hierarchy. ATs typically ignore objects with this role. |
| IA2_ROLE_ROOT_PANE | A root pane. A specialized pane that has a glass pane and a layered pane as its children. Also refer to IA2_ROLE_GLASS_PANE and IA2_ROLE_LAYERED_PANE |
| IA2_ROLE_RULER | A ruler such as those used in word processors. |
| IA2_ROLE_SCROLL_PANE | A scroll pane. An object that allows a user to incrementally view a large amount of information. Its children can include scroll bars and a viewport. Also refer to IA2_ROLE_VIEW_PORT and MSAA's scroll bar role. |
| IA2_ROLE_SECTION | A container of document content. An example of the use of this role is to represent an HTML DIV tag. A section may be used as a region. A region is a group of elements that together form a perceivable unit. A region does not necessarily follow the logical structure of the content, but follows the perceivable structure of the page. A region may have an attribute in the set of IAccessible2::attributes which indicates that it is "live". A live region is content that is likely to change in response to a timed change, a user event, or some other programmed logic or event. |
| IA2_ROLE_SHAPE | Object with graphical representation used to represent content on draw pages. |
| IA2_ROLE_SPLIT_PANE | A split pane. A specialized panel that presents two other panels at the same time. Between the two panels is a divider the user can manipulate to make one panel larger and the other panel smaller. |
| IA2_ROLE_TEAR_OFF_MENU | An object that forms part of a menu system but which can be "undocked" from or "torn off" the menu system to exist as a separate window. |
| IA2_ROLE_TERMINAL | An object used as a terminal emulator. |
| IA2_ROLE_TEXT_FRAME | Collection of objects that constitute a logical text entity. |
| IA2_ROLE_TOGGLE_BUTTON | A toggle button. A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state. Also refer to MSAA's roles of push button, check box, and radio button. |
| IA2_ROLE_VIEW_PORT | A viewport. An object usually used in a scroll pane. It represents the portion of the entire data that the user can see. As the user manipulates the scroll bars, the contents of the viewport can change. Also refer to IA2_ROLE_SCROLL_PANE. |
| IA2_ROLE_COMPLEMENTARY_CONTENT | An object containing content which is complementary to the main content of a document, but remains meaningful when separated from the main content. There are various types of content that would appropriately have this role. For example, in the case where content is delivered via a web portal to a web browser, this may include but not be limited to show times, current weather, related articles, or stocks to watch. The complementary role indicates that contained content is relevant to the main content. If the complementary content is completely separable main content, it may be appropriate to use a more general role. |
Definition at line 757 of file ia2_api_all.idl.
| enum IA2ScrollType |
These constants control the scrolling of an object or substring into a window.
This enum is used in IAccessible2::scrollTo and IAccessibleText::scrollSubstringTo.
Definition at line 114 of file ia2_api_all.idl.
| enum IA2States |
IAccessible2 specific state bit constants
This enum defines the state bits returned by IAccessible2::states. The IAccessible2 state bits are in addition to those returned by MSAA.
| Enumerator | |
|---|---|
| IA2_STATE_ACTIVE | Indicates a window is currently the active window, or is an active subelement within a container or table. This state can be used to indicate the current active item in a container, even if the container itself is not currently active. In other words this would indicate the item that will get focus if you tab to the container. This information is important for knowing what to report for trees and potentially other containers in a virtual buffer. Also, see IA2_STATE_MANAGES_DESCENDANTS for more information. |
| IA2_STATE_ARMED | Indicates that the object is armed. Used to indicate that the control is "pressed" and will be invoked when the actuator, e.g. a mouse button, is "released". An AT which either monitors the mouse or synthesizes mouse events might need to know that, and possibly a talking interface would even let the user know about it. It could also potentially be useful to on screen keyboards or test tools since the information does indicate something about the state of the interface, for example, code operating asynchronously might need to wait for the armed state to change before doing something else. |
| IA2_STATE_DEFUNCT | Indicates the user interface object corresponding to this object no longer exists. |
| IA2_STATE_EDITABLE | An object with this state has a caret and implements the IAccessibleText interface. Such fields may be read-only, so STATE_SYSTEM_READONLY is valid in combination with IA2_STATE_EDITABLE. |
| IA2_STATE_HORIZONTAL | Indicates the orientation of this object is horizontal. |
| IA2_STATE_ICONIFIED | Indicates this object is minimized and is represented only by an icon. |
| IA2_STATE_INVALID_ENTRY | Indicates an input validation failure. |
| IA2_STATE_MANAGES_DESCENDANTS | Indicates that this object manages its children. Note: Due to the fact that MSAA's WinEvents don't allow the active child index to be passed on the IA2_EVENT_ACTIVE_DESCENDANT_CHANGED event, the manages descendants scheme can't be used. Instead the active child object has to fire MSAA's EVENT_OBJECT_FOCUS. In a future release a new event mechanism may be added to provide for event specific data to be passed with the event. At that time the IA2_EVENT_ACTIVE_DECENDENT_CHANGED event and IA2_STATE_MANAGES_DESCENDANTS state would be useful. |
| IA2_STATE_MODAL | Indicates that an object is modal. Modal objects have the behavior that something must be done with the object before the user can interact with an object in a different window. |
| IA2_STATE_MULTI_LINE | Indicates this text object can contain multiple lines of text. |
| IA2_STATE_OPAQUE | Indicates this object paints every pixel within its rectangular region. |
| IA2_STATE_REQUIRED | Indicates that user interaction is required. An example of when this state is used is when a field in a form must be filled before a form can be processed. |
| IA2_STATE_SELECTABLE_TEXT | Indicates an object which supports text selection. Note: This is different than MSAA STATE_SYSTEM_SELECTABLE. |
| IA2_STATE_SINGLE_LINE | Indicates that this text object can contain only a single line of text. |
| IA2_STATE_STALE | Indicates that the accessible object is stale. This state is used when the accessible object no longer accurately represents the state of the object which it is representing such as when an object is transient or when an object has been or is in the process of being destroyed or when the object's index in its parent has changed. |
| IA2_STATE_SUPPORTS_AUTOCOMPLETION | Indicates that the object implements autocompletion. This state indicates that a text control will respond to the input of one or more characters and cause a sub-item to become selected. The selection may also result in events fired on the parent object. |
| IA2_STATE_TRANSIENT | Indicates this object is transient. An object has this state when its parent object has the state IA2_STATE_MANAGES_DESCENDANTS. For example, a list item object may be managed by its parent list object and may only exist as long as the object is actually rendered. Similarly a table cell's accessible object may exist only while the cell has focus. However, from the perspective of an assistive technology a transient object behaves like a non-transient object. As a result it is likely that this state is not of use to an assistive technology, but it is provided in case an assistive technology determines that knowledge of the transient nature of the object is useful and also for harmony with the Linux accessibility API. Also, see IA2_STATE_MANAGES_DESCENDANTS for more information. |
| IA2_STATE_VERTICAL | Indicates the orientation of this object is vertical. |
| IA2_STATE_CHECKABLE | Indicates this object is checkable. The standard checkable objects are check boxes, radio buttons, check box menu items, radio menu items, and toggle buttons. Since assistive technology will determine that these objects are checkable via the object's role the checkable state is not required. However, this state is necessary in those cases where an object has a role which is not one of the previously mentioned roles. An example is a table cell which indicates whether or not an email has an attachment, whether or not a mail is considered spam, and whether or not an email has been read. |
| IA2_STATE_PINNED | Indicates this object is pinned. This state indicates that an object is fixed at a certain location. One example is a browser tab that when pinned cannot be moved until unpinned. Another example is a movable or floating object that when pinned remains in its pinned location until being unpinned. |
Definition at line 1052 of file ia2_api_all.idl.
These constants specify the kind of change made to a table.
This enum is used in the IA2TableModelChange struct which in turn is used by IAccessibleTable::modelChange and IAccessibleTable2::modelChange.
| Enumerator | |
|---|---|
| IA2_TABLE_MODEL_CHANGE_INSERT | |
| IA2_TABLE_MODEL_CHANGE_DELETE | |
| IA2_TABLE_MODEL_CHANGE_UPDATE | |
Definition at line 227 of file ia2_api_all.idl.
| enum IA2TextBoundaryType |
This enum defines values which specify a text boundary type.
IA2_TEXT_BOUNDARY_SENTENCE is optional. When a method doesn't implement this method it must return S_FALSE. Typically this feature would not be implemented by an application. However, if the application developer was not satisfied with how screen readers have handled the reading of sentences this boundary type could be implemented and screen readers could use the application's version of a sentence rather than the screen reader's.
The rest of the boundary types must be supported.
This enum is used in IAccessibleText::textBeforeOffset, IAccessibleText::textAtOffset, and IAccessibleText::textAfterOffset.
| Enumerator | |
|---|---|
| IA2_TEXT_BOUNDARY_CHAR | Typically, a single character is returned. In some cases more than one character is returned, for example, when a document contains field data such as a field containing a date, time, or footnote reference. In this case the caret can move over several characters in one movement of the caret. Note that after the caret moves, the caret offset changes by the number of characters in the field, e.g. by 8 characters in the following date: 03/26/07. |
| IA2_TEXT_BOUNDARY_WORD | The range provided matches the range observed when the application processes the Ctrl + left arrow and Ctrl + right arrow key sequences. Typically this is from the start of one word to the start of the next, but various applications are inconsistent in the handling of the end of a line. |
| IA2_TEXT_BOUNDARY_SENTENCE | Range is from start of one sentence to the start of another sentence. |
| IA2_TEXT_BOUNDARY_PARAGRAPH | Range is from start of one paragraph to the start of another paragraph. |
| IA2_TEXT_BOUNDARY_LINE | Range is from start of one line to the start of another line. This often means that an end-of-line character will appear at the end of the range. However in the case of some applications an end-of-line character indicates the end of a paragraph and the lines composing the paragraph, other than the last line, do not contain an end of line character. |
| IA2_TEXT_BOUNDARY_ALL | Using this value will cause all text to be returned. |
Definition at line 2357 of file ia2_api_all.idl.
Special offsets for use in IAccessibleText and IAccessibleEditableText methods.
Refer to Special Offsets for use in the IAccessibleText and IAccessibleEditableText Methods for more information.
| Enumerator | |
|---|---|
| IA2_TEXT_OFFSET_LENGTH | This offset is equivalent to the length of the string. It eliminates the need to call IAccessibleText::nCharacters. |
| IA2_TEXT_OFFSET_CARET | This offset signifies that the text related to the physical location of the caret should be used. |
Definition at line 215 of file ia2_api_all.idl.
1.9.3