AccessibleText.idl File Reference


Classes

struct  IA2TextSegment
interface  IAccessibleText
 This interface gives read-only access to text. More...

Enumerations

enum  IA2TextBoundaryType {
  IA2_TEXT_BOUNDARY_CHAR,
  IA2_TEXT_BOUNDARY_WORD,
  IA2_TEXT_BOUNDARY_SENTENCE,
  IA2_TEXT_BOUNDARY_PARAGRAPH,
  IA2_TEXT_BOUNDARY_LINE,
  IA2_TEXT_BOUNDARY_ALL
}

Enumeration Type Documentation

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  Range is from start of one word to the start of another word.
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.


To submit feedback on IAccessible2 API Version 1.0.2, please use the Bugzilla interface located at: http://bugs.linuxfoundation.org/. When using Bugzilla please be sure to select IAccessible2 from the list of components. Bugzilla is the preferred method for receiving feedback because it automatically logs one's feedback in the IAccessible2 tracking system without additional human intervention. One may also, however, send email to accessibility-rfc@a11y.org, a publicly archived emailing list. Please address any technical problems you encounter with this document or the resources to which it links, to the Open A11y Webmaster <webmaster@a11y.org>

A stable online reference version of the documentation for IAccessible2 API Version 1.0.2, is available at: http://a11y.org/ia2-spec. A list of known and reported errors in the documentation for IAccessible2 API Version 1.0.2 can be found at: http://a11y.org/ia2-errata


Generated on Mon Oct 13 23:32:04 2008 for IAccessible2 API Version 1.0.2 by  doxygen 1.5.6