import "Accessibility_Text.idl";
Inheritance diagram for Accessibility::Text:
Public Types | |
typedef sequence< Range > | RangeList |
Public Member Functions | |
string | getText (in long startOffset, in long endOffset) |
boolean | setCaretOffset (in long offset) |
string | getTextBeforeOffset (in long offset, in TEXT_BOUNDARY_TYPE type, out long startOffset, out long endOffset) |
string | getTextAtOffset (in long offset, in TEXT_BOUNDARY_TYPE type, out long startOffset, out long endOffset) |
string | getTextAfterOffset (in long offset, in TEXT_BOUNDARY_TYPE type, out long startOffset, out long endOffset) |
unsigned long | getCharacterAtOffset (in long offset) |
string | getAttributeValue (in long offset, in string attributeName, out long startOffset, out long endOffset, out boolean defined) |
string | getAttributes (in long offset, out long startOffset, out long endOffset) |
string | getDefaultAttributes () |
void | getCharacterExtents (in long offset, out long x, out long y, out long width, out long height, in short coordType) |
long | getOffsetAtPoint (in long x, in long y, in short coordType) |
long | getNSelections () |
void | getSelection (in long selectionNum, out long startOffset, out long endOffset) |
boolean | addSelection (in long startOffset, in long endOffset) |
boolean | removeSelection (in long selectionNum) |
boolean | setSelection (in long selectionNum, in long startOffset, in long endOffset) |
void | getRangeExtents (in long startOffset, in long endOffset, out long x, out long y, out long width, out long height, in short coordType) |
RangeList | getBoundedRanges (in long x, in long y, in long width, in long height, in short coordType, in TEXT_CLIP_TYPE xClipType, in TEXT_CLIP_TYPE yClipType) |
AttributeSet | getAttributeRun (in long offset, out long startOffset, out long endOffset, in boolean includeDefaults) |
AttributeSet | getDefaultAttributeSet () |
Data Fields | |
readonly attribute long | characterCount |
readonly attribute long | caretOffset |
Data Structures | |
struct | Range |
In some cases a Text object may have, as its content, an empty string. In particular this can occur in the case of Hypertext objects which do not display explicitly textual information onscreen, as Hypertext is derived from the Text interface.
"object:text-attributes-changed"
The attributes of a range of text, or the range over which attributes apply, has changed. "object:text-changed"
The text content of this object has changed. "object:text-bounds-changed"
The character bounds of a text object have changed, for instance in response to a reformatting or reflow operation. "object:text-caret-moved"
The character offset of the text caret (visible or notional) within this object has changed. Events of this type may also be generated when an onscreen text caret appears or disappears. "object:text-selection-changed"
The range or number of text selections within this text object has changed.In some cases, objects which are not onscreen may implement Text, but if such objects implement Component, their potential visibility should be examined (via comparison with STATE_VISIBLE and STATE_SHOWING) before exposing them to the user. Objects which implement Text but not Component may be encountered in special-purpose interfaces or as special ¨accessibility¨ extensions to visual interfaces to allow non-graphical access to application features. These instances should be considered the exception, rather than the rule.
|
|
|
The result of calling addSelection on objects which already have one selection present, and which do not include STATE_MULTISELECTABLE, is undefined, other than the return value.
|
|
Query a particular text object for the text attributes defined at a given offset, obtaining the start and end of the "attribute run" over which these attributes are currently invariant. Text attributes are those presentational, typographic, or semantic attributes or qualitites which apply to a range of text specifyable by starting and ending offsets. Attributes relevant to localization should be provided in accordance with the w3c "Internationalization and Localization Markup Requirements", http://www.w3.org/TR/2005/WD-itsreq-20051122/ Other text attributes should choose their names and value semantics in accordance with relevant standards such as CSS level 2 (http://www.w3.org/TR/1998/REC-CSS2-19980512), XHTML 1.0 (http://www.w3.org/TR/2002/REC-xhtml1-20020801), and WICD (http://www.w3.org/TR/2005/WD-WICD-20051121/). Those attributes from the aforementioned specifications and recommendations which do not concern typographic, presentational, or semantic aspects of text should be exposed via the more general Accessible::getAttributes() API (if at all). For example, CSS attributes which should be exposed on text (either as default attributes, or as explicitly-set attributes when non-default values are specified in the content view) include the Font attributes (i.e. "css2:font-weight", "css2:font-style"), the "css2:color" and "css2:background-color" attributes, and "css2:text-decoration" attribute. If includeDefaults is TRUE, then this AttributeSet should include the default attributes as well as those which are explicitly assigned to the attribute run in question. startOffset and endOffset will be back-filled to indicate the start and end of the attribute run which contains 'offset' - an attribute run is a contiguous section of text whose attributes are homogeneous.
|
|
getAttributes is deprecated in favor of getAttributeRun.
|
|
Get the string value of a named attribute at a given offset, if defined.
|
|
Return the text content within a bounding box, as a list of Range structures. Depending on the TEXT_CLIP_TYPE parameters, glyphs which are clipped by the bounding box (i.e. which lie partially inside and partially outside it) may or may not be included in the ranges returned.
|
|
|
|
Obtain a the bounding box, as x, y, width, and height, of the character or glyph at a particular character offset in this object's text content. The coordinate system in which the results are reported is specified by coordType. If an onscreen glyph corresponds to multiple character offsets, for instance if the glyph is a ligature, the bounding box reported will include the entire glyph and therefore may apply to more than one character offset.
|
|
Deprecated in favor of getDefaultAttributeSet.
|
|
Return an AttributeSet containing the text attributes which apply to all text in the object by virtue of the default settings of the document, view, or user agent; e.g. those attributes which are implied rather than explicitly applied to the text object. For instance, an object whose entire text content has been explicitly marked as 'bold' will report the 'bold' attribute via getAttributeRun(), whereas an object whose text weight is inspecified may report the default or implied text weight in the default AttributeSet.
|
|
Obtain the number of separate, contiguous selections in the current Text object. Text objects which do not implement selection of discontiguous text regions will always return '0' or '1'. Note that "contiguous" is defined by continuity of the offsets, i.e. a text 'selection' is defined by a start/end offset pair. In the case of bidirectional text, this means that a continguous selection may appear visually discontiguous, and vice-versa.
|
|
Get the offset of the character at a given onscreen coordinate. The coordinate system used to interpret x and y is determined by parameter coordType.
|
|
Obtain the bounding box which entirely contains a given text range. Negative values may be returned for the bounding box parameters in the event that all or part of the text range is offscreen or not mapped to the screen.
|
|
The result of calling getSelection with an out-of-range selectionNum (i.e. for a selection which does not exist) is not strictly defined, but should set endOffset equal to startOffset. |
|
Obtain all or part of the onscreen textual content of a Text object. If endOffset is specified as "-1", then this method will return the entire onscreen textual contents of the Text object.
|
|
Obtain a subset of the text content of an object which entirely follows
|
|
Obtain a subset of the text content of an object which includes the specified
|
|
Obtain a subset of the text content of an object which entirely precedes
|
|
Deselect the text contained in the specified selectionNum, if such a selection exists, otherwise do nothing. Removal of a non-existant selectionNum has no effect.
|
|
Programmatically move the text caret (visible or virtual, as above) to a given position.
|
|
Modify an existing selection's start or ending offset. Calling setSelection for a selectionNum that is not already defined has no effect. The result of calling setSelection with a selectionNum greater than 0 for objects that do not include STATE_MULTISELECTABLE is undefined.
|
|
The current offset of the text caret in the Text object. This caret may be virtual, e.g. non-visual and notional-only, but if an onscreen representation of the caret position is visible, it will correspond to this offset. The caret offset is given as a character offset, as opposed to a byte offset into a text buffer or a column offset. |
|
The total current number of characters in the Text object, including whitespace and non-spacing characters. |