|
LibreOffice
LibreOffice 24.2 SDK API Reference
|
UNO Accessibility API. More...
Constant Groups | |
| constants | AccessibleEventId |
| These constants identify the type of AccessibleEventObject objects. | |
| constants | AccessibleRelationType |
| Collection of relation types. | |
| constants | AccessibleRole |
| Collection of roles. | |
| constants | AccessibleStateType |
| Collection of state types. | |
| constants | AccessibleTableModelChangeType |
| Type of a change made to a table model. | |
| constants | AccessibleTextType |
| Collection of types of text portions. | |
Classes | |
| service | Accessible |
| Every class has to support this service in order to be accessible. More... | |
| service | AccessibleContext |
| Central service of the Accessibility API that gives access to various facets of an object's content. More... | |
| struct | AccessibleEventObject |
| this struct describes an accessible event, that is broadcasted from the XAccessibleEventBroadcaster and notified to XAccessibleEventListener. More... | |
| struct | AccessibleRelation |
| An AccessibleRelation object defines a one-to-many relation. More... | |
| struct | AccessibleTableModelChange |
| This structure lets an event give access to a change of a table model. More... | |
| exception | IllegalAccessibleComponentStateException |
| Indicates invalid or unavailable state information. More... | |
| service | MSAAService |
| struct | TextSegment |
| This structure describes a text segment that is embedded in a larger portion of text. More... | |
| interface | XAccessible |
| This interface has to be implemented by any class that wants to be accessible. More... | |
| interface | XAccessibleAction |
| Implement this interface to give access to actions that can be executed for accessible objects. More... | |
| interface | XAccessibleComponent |
| The XAccessibleComponent interface should be supported by any class that can be rendered on the screen. More... | |
| interface | XAccessibleContext |
| Implement this interface for exposing various aspects of a class's content. More... | |
| interface | XAccessibleContext2 |
| Implement this interface for exposing more aspects of a class's content. More... | |
| interface | XAccessibleContext3 |
| Implement this interface to speed up operations when iterating over large amounts of children. More... | |
| interface | XAccessibleEditableText |
| Implement this interface to give read and write access to a text representation. More... | |
| interface | XAccessibleEventBroadcaster |
| makes it possible to register listeners which are called whenever an accessibility event (see AccessibleEventObject) occurs. More... | |
| interface | XAccessibleEventListener |
| makes it possible to register a component as a listener, which is called whenever an accessibility event occurs. More... | |
| interface | XAccessibleExtendedAttributes |
| interface | XAccessibleExtendedComponent |
| The XAccessibleExtendedComponent interface contains additional methods to those of the XAccessibleComponent interface. More... | |
| interface | XAccessibleGroupPosition |
| interface | XAccessibleHyperlink |
| Implement this interface to represent a hyperlink or a group of hyperlinks. More... | |
| interface | XAccessibleHypertext |
| Implement this interface to expose the hypertext structure of a document. More... | |
| interface | XAccessibleImage |
| Implement this interface to represent images and icons. More... | |
| interface | XAccessibleKeyBinding |
| This interface can be used to represent any number of key bindings which then can be associated to a certain action. More... | |
| interface | XAccessibleMultiLineText |
| Implement this interface to give provide a mapping between text index and line numbers. More... | |
| interface | XAccessibleRelationSet |
| Implement this interface to give access to an object's set of relations. More... | |
| interface | XAccessibleSelection |
| Implement this interface to represent a selection of accessible objects. More... | |
| interface | XAccessibleTable |
| Implement this interface to give access to a two-dimensional table. More... | |
| interface | XAccessibleTableSelection |
| interface | XAccessibleText |
| Implement this interface to give read-only access to a text. More... | |
| interface | XAccessibleTextAttributes |
| Implement this interface to give access to the attributes of a text. More... | |
| interface | XAccessibleTextMarkup |
| Implement this interface to expose the text markups of a text. More... | |
| interface | XAccessibleTextSelection |
| interface | XAccessibleValue |
| Implement this interface to give access to a single numerical value. More... | |
| interface | XMSAAService |
| The interface must be implemented for a server that can support MSAA com objects and send win32 accessible events. More... | |
Enumerations | |
| enum | AccessibleScrollType { SCROLL_TOP_LEFT, SCROLL_BOTTOM_RIGHT, SCROLL_TOP_EDGE, SCROLL_BOTTOM_EDGE, SCROLL_LEFT_EDGE, SCROLL_RIGHT_EDGE, SCROLL_ANYWHERE } |
| Scroll types. More... | |
UNO Accessibility API.
This modules contains the basic interfaces of the UAA (UNO Accessibility API). Services that describe how these interfaces are implemented can be found in other modules. The services in this module describe only what every accessible object has to support.
Making a class accessible starts by supporting the com::sun::star::accessibility::XAccessible interface. This interface's only method returns the actual accessibility object, an instance of com::sun::star::accessibility::XAccessibleContext. These two interfaces may be implemented by the same class in which case a call to com::sun::star::accessibility::XAccessible getAccessible() returns the same object that is called. Alternatively the implementation of the com::sun::star::accessibility::XAccessibleContext interface can be done by another class. This makes it possible to put all accessibility implementations into their own library which has only to be loaded when necessary.
Note that all other interfaces have to be implemented by the same class that implements the com::sun::star::accessibility::XAccessibleContext interface. Note also that there is no way back from an accessibility object to the object from which it has been obtained by means of the UAA. If you need such a back-link you have to provide one on your own.
| enum AccessibleScrollType |
Scroll types.
Describes the type of scrolling that are available for the methods of the XAccessibleScrollableText interface.
1.8.14