IAccessible2 API  Version 1.3
Public Member Functions | List of all members
IAccessibleText2 Interface Reference

This interface gives read-only access to text. More...

import "AccessibleText2.idl";

Inheritance diagram for IAccessibleText2:
IAccessibleText

Public Member Functions

HRESULT attributeRange ([in] long offset,[in] BSTR filter,[out] long *startOffset,[out] long *endOffset,[out, retval] BSTR *attributeValues)
 Returns the range and of the specified set of attributes. More...
 
- Public Member Functions inherited from IAccessibleText
HRESULT addSelection ([in] long startOffset,[in] long endOffset)
 Adds a text selection. More...
 
HRESULT attributes ([in] long offset,[out] long *startOffset,[out] long *endOffset,[out, retval] BSTR *textAttributes)
 Returns text attributes. More...
 
HRESULT caretOffset ([out, retval] long *offset)
 Returns the position of the caret. More...
 
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. More...
 
HRESULT nSelections ([out, retval] long *nSelections)
 Returns the number of active non-contiguous selections. More...
 
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. More...
 
HRESULT selection ([in] long selectionIndex,[out] long *startOffset,[out, retval] long *endOffset)
 Returns the character offsets of Nth active text selection. More...
 
HRESULT text ([in] long startOffset,[in] long endOffset,[out, retval] BSTR *text)
 Returns the substring between the two given indices. More...
 
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. More...
 
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. More...
 
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. More...
 
HRESULT removeSelection ([in] long selectionIndex)
 Unselects a range of text. More...
 
HRESULT setCaretOffset ([in] long offset)
 Sets the position of the caret. More...
 
HRESULT setSelection ([in] long selectionIndex,[in] long startOffset,[in] long endOffset)
 Changes the bounds of an existing selection. More...
 
HRESULT nCharacters ([out, retval] long *nCharacters)
 Returns total number of characters. More...
 
HRESULT scrollSubstringTo ([in] long startIndex,[in] long endIndex,[in] enum IA2ScrollType scrollType)
 Makes a specific part of string visible on screen. More...
 
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. More...
 
HRESULT newText ([out, retval] IA2TextSegment *newText)
 Returns any inserted text. More...
 
HRESULT oldText ([out, retval] IA2TextSegment *oldText)
 Returns any removed text. More...
 

Detailed Description

This interface gives read-only access to text.

The IAccessibleText2 interface extends the functionality of the IAccessibleText interface.

Member Function Documentation

HRESULT IAccessibleText2::attributeRange ( [in] long  offset,
[in] BSTR  filter,
[out] long *  startOffset,
[out] long *  endOffset,
[out, retval] BSTR *  attributeValues 
)
get

Returns the range and of the specified set of attributes.

Return the range (start and end offsets) and text attributes that correspond to the given attributes filter at the given offset.

Parameters
[in]offsetThe offset at which to search for the attributes specified in the filter.
[in]filterThe requested attribute names. The filter format is "attribute1, attribute2".
[out]startOffsetThe starting (0-based) offset of the text containing the specified attributes.
[out]endOffsetThe (0-based) offset one past the last character of the text containing the specified attributes.
[out]attributeValuesThe values of the requested attributes.
Return values
S_OK
S_FALSEif nothing to return, [out] values are -1, -1, NULL respectively.
E_INVALIDARGif bad [in] passed.

The documentation for this interface was generated from the following file:
Generated on Wed Jul 10 2013 09:47:26 for IAccessible2 API Version 1.3 by  doxygen 1.8.3.1