import "AccessibleText.idl";
Inheritance diagram for IAccessibleText:
Public Member Functions | |
| HRESULT | addSelection ([in] long startOffset,[in] long endOffset) |
| Adds a text selection. | |
| HRESULT | attributes ([in] long offset,[out] long *startOffset,[out] long *endOffset,[out, retval] BSTR *textAttributes) |
| Returns text attributes. | |
| HRESULT | caretOffset ([out, retval] long *offset) |
| Returns the position of the caret. | |
| HRESULT | characterExtents ([in] long offset,[in] enum IA2CoordinateType coordType,[out] long *x,[out] long *y,[out] long *width,[out, retval] long *height) |
| Returns the bounding box of the specified position. | |
| HRESULT | nSelections ([out, retval] long *nSelections) |
| Returns the number of active non-contiguous selections. | |
| HRESULT | offsetAtPoint ([in] long x,[in] long y,[in] enum IA2CoordinateType coordType,[out, retval] long *offset) |
| Returns the text position for the specified screen position. | |
| HRESULT | selection ([in] long selectionIndex,[out] long *startOffset,[out, retval] long *endOffset) |
| Returns the character offsets of N-th active text selection. | |
| HRESULT | text ([in] long startOffset,[in] long endOffset,[out, retval] BSTR *text) |
| Returns the substring between the two given indices. | |
| HRESULT | textBeforeOffset ([in] long offset,[in] enum IA2TextBoundaryType boundaryType,[out] long *startOffset,[out] long *endOffset,[out, retval] BSTR *text) |
| Returns a text portion before the given position. | |
| HRESULT | textAfterOffset ([in] long offset,[in] enum IA2TextBoundaryType boundaryType,[out] long *startOffset,[out] long *endOffset,[out, retval] BSTR *text) |
| Returns a text portion after the given position. | |
| HRESULT | textAtOffset ([in] long offset,[in] enum IA2TextBoundaryType boundaryType,[out] long *startOffset,[out] long *endOffset,[out, retval] BSTR *text) |
| Returns a text portion that spans the given position. | |
| HRESULT | removeSelection ([in] long selectionIndex) |
| Unselects a range of text. | |
| HRESULT | setCaretOffset ([in] long offset) |
| Sets the position of the caret. | |
| HRESULT | setSelection ([in] long selectionIndex,[in] long startOffset,[in] long endOffset) |
| Changes the bounds of an existing selection. | |
| HRESULT | nCharacters ([out, retval] long *nCharacters) |
| Returns total number of characters. | |
| HRESULT | scrollSubstringTo ([in] long startIndex,[in] long endIndex,[in] enum IA2ScrollType scrollType) |
| Makes a specific part of string visible on screen. | |
| HRESULT | scrollSubstringToPoint ([in] long startIndex,[in] long endIndex,[in] enum IA2CoordinateType coordinateType,[in] long x,[in] long y) |
| Moves the top left of a substring to a specified location. | |
| HRESULT | newText ([out, retval] IA2TextSegment *newText) |
| Returns any inserted text. | |
| HRESULT | oldText ([out, retval] IA2TextSegment *oldText) |
| Returns any removed text. | |
The IAccessibleText interface should be implemented by all components that present textual information on the display like buttons, text entry fields, or text portions of the document window. The interface provides access to the text's content, attributes, and spatial location. However, text can not be modified with this interface. That is the task of the IAccessibleEditableText interface.
The text length, i.e. the number of characters in the text, is returned by IAccessibleText::nCharacters. All methods that operate on particular characters (e.g. IAccessibleText::textAtOffset) use character indices from 0 to length-1. All methods that operate on character positions (e.g. IAccessibleText::text) use indices from 0 to length.
Please note that accessible text does not necessarily support selection. In this case it should behave as if there where no selection. An empty selection is used for example to express the current cursor position.
|
||||||||||||
|
Adds a text selection.
|
|
||||||||||||||||||||
|
Returns text attributes.
|
|
|
Returns the position of the caret. The caret is the position between two characters. Its position/offset is that of the character to the right of it.
|
|
||||||||||||||||||||||||||||
|
Returns the bounding box of the specified position. The virtual character after the last character of the represented text, i.e. the one at position length is a special case. It represents the current input position and will therefore typically be queried by AT more often than other positions. Because it does not represent an existing character its bounding box is defined in relation to preceding characters. It should be roughly equivalent to the bounding box of some character when inserted at the end of the text. Its height typically being the maximal height of all the characters in the text or the height of the preceding character, its width being at least one pixel so that the bounding box is not degenerate. Note that the index 'length' is not always valid. Whether it is or not is implementation dependent. It typically is when text is editable or otherwise when on the screen the caret can be placed behind the text. You can be sure that the index is valid after you have received a IA2_EVENT_TEXT_CARET_MOVED event for this index.
|
|
|
Returns total number of characters. Note: This may be different than the total number of bytes required to store the text, if the text contains multi-byte characters.
|
|
|
Returns any inserted text. Provided for use by the IA2_EVENT_TEXT_INSERTED and IA2_EVENT_TEXT_UPDATED event handlers.
|
|
|
Returns the number of active non-contiguous selections.
|
|
||||||||||||||||||||
|
Returns the text position for the specified screen position. Given a point return the zero-based index of the character under that point. The same functionality could be achieved by using the bounding boxes for each character as returned by IAccessibleText::characterExtents. The method IAccessibleText::offsetAtPoint, however, can be implemented more efficiently.
|
|
|
Returns any removed text. Provided for use by the IA2_EVENT_TEXT_REMOVED/UPDATED event handlers.
|
|
|
Unselects a range of text.
|
|
||||||||||||||||
|
Makes a specific part of string visible on screen.
|
|
||||||||||||||||||||||||
|
Moves the top left of a substring to a specified location. Note: S_FALSE is returned if the object is already at the specified location.
|
|
||||||||||||||||
|
Returns the character offsets of N-th active text selection.
|
|
|
Sets the position of the caret. The caret is the position between two characters. Its position/offset is that of the character to the right of it. Setting the caret position may or may not alter the current selection. A change of the selection is notified to the accessibility event listeners with an IA2_EVENT_TEXT_SELECTION_CHANGED event. When the new caret position differs from the old one (which, of course, is the standard case) this is notified to the accessibility event listeners with an IA2_EVENT_TEXT_CARET_MOVED event.
|
|
||||||||||||||||
|
Changes the bounds of an existing selection.
|
|
||||||||||||||||
|
Returns the substring between the two given indices. The substring starts with the character at startOffset (inclusive) and up to the character at endOffset (exclusive), if startOffset is less or equal endOffste. If endOffset is lower than startOffset, the result is the same as a call with the two arguments being exchanged. The whole text can be requested by passing the indices zero and IAccessibleText::nCharacters. If both indices have the same value, an empty string is returned.
|
|
||||||||||||||||||||||||
|
Returns a text portion after the given position. Returns the substring of the specified text type that is located after the given character and does not include it. The result of this method should be same as a result for IAccessibleText::textAtOffset with a suitably decreased index value. For example, if text type is IA2_TEXT_BOUNDARY_WORD, then the complete word that is closest to and located before offset is returned. If the index is valid, but no suitable word (or other text type) is found, an empty text segment is returned.
|
|
||||||||||||||||||||||||
|
Returns a text portion that spans the given position. Returns the substring of the specified text type that the specified offset. The result of this method should be same as a result for IAccessibleText::textAtOffset with a suitably decreased index value. For example, if text type is IA2_TEXT_BOUNDARY_WORD, then the complete word that is closest to and located before offset is returned. If the index is valid, but no suitable word (or other text type) is found, an empty text segment is returned.
|
|
||||||||||||||||||||||||
|
Returns a text portion before the given position. Returns the substring of the specified text type that is located before the given character and does not include it. The result of this method should be same as a result for IAccessibleText::textAtOffset with a suitably decreased index value. For example, if text type is IA2_TEXT_BOUNDARY_WORD, then the complete word that is closest to and located before offset is returned. If the index is valid, but no suitable word (or other text type) is found, an empty text segment is returned.
|
1.4.6-NO