LibreOffice Module winaccessibility (master) 1
|
This interface exposes information about hypertext in a document. More...
import"ia2_api_all.idl";
Properties | |
long | nHyperlinks [get] |
Returns the number of links and link groups contained within this hypertext paragraph. More... | |
IAccessibleHyperlink | hyperlink ([in] long index) [get] |
Returns the specified link. More... | |
long | hyperlinkIndex ([in] long charIndex) [get] |
Returns the index of the hyperlink that is associated with this character index. More... | |
Properties inherited from IAccessibleText | |
BSTR | attributes ([in] long offset,[out] long startOffset,[out] long endOffset) [get] |
Returns text attributes. More... | |
long | caretOffset [get] |
Returns the position of the caret. More... | |
long | characterExtents ([in] long offset,[in] IA2CoordinateType coordType,[out] long x,[out] long y,[out] long width) [get] |
Returns the bounding box of the specified position. More... | |
long | nSelections [get] |
Returns the number of active non-contiguous selections. More... | |
long | offsetAtPoint ([in] long x,[in] long y,[in] IA2CoordinateType coordType) [get] |
Returns the text position for the specified screen position. More... | |
long | selection ([in] long selectionIndex,[out] long startOffset) [get] |
Returns the character offsets of Nth active text selection. More... | |
BSTR | text ([in] long startOffset,[in] long endOffset) [get] |
Returns the substring between the two given indices. More... | |
BSTR | textBeforeOffset ([in] long offset,[in] IA2TextBoundaryType boundaryType,[out] long startOffset,[out] long endOffset) [get] |
Returns a text portion before the given position. More... | |
BSTR | textAfterOffset ([in] long offset,[in] IA2TextBoundaryType boundaryType,[out] long startOffset,[out] long endOffset) [get] |
Returns a text portion after the given position. More... | |
BSTR | textAtOffset ([in] long offset,[in] IA2TextBoundaryType boundaryType,[out] long startOffset,[out] long endOffset) [get] |
Returns a text portion that spans the given position. More... | |
long | nCharacters [get] |
Returns total number of characters. More... | |
IA2TextSegment | newText [get] |
Returns any inserted text. More... | |
IA2TextSegment | oldText [get] |
Returns any removed text. More... | |
Additional Inherited Members | |
Public Member Functions inherited from IAccessibleText | |
HRESULT | addSelection ([in] long startOffset, [in] long endOffset) |
Adds a text selection. 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 | 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... | |
This interface exposes information about hypertext in a document.
The IAccessibleHypertext interface is the main interface to expose hyperlinks in a document, typically a text document, that are used to reference other documents. A typical implementation is to implement this interface on the smallest text object such as a paragraph of text.
Definition at line 3572 of file ia2_api_all.idl.
|
get |
Returns the specified link.
The returned IAccessibleHyperlink object encapsulates the hyperlink and provides several kinds of information describing it.
[in] | index | This 0 based index specifies the hyperlink to return. |
[out] | hyperlink | If the given index is valid, i.e. lies in the interval from 0 to the number of links minus one, a reference to the specified hyperlink object is returned. If the index is invalid then a NULL pointer is returned. |
S_OK | |
E_INVALIDARG | if bad [in] passed |
Referenced by CAccHypertext::get_hyperlink().
|
get |
Returns the index of the hyperlink that is associated with this character index.
This is the case when a link spans the given character index.
[in] | charIndex | A 0 based index of the character for which to return the link index. If IAccessibleText is used to represent the text containing the link, then the character index is only valid if it is greater than or equal to zero and lower than the number of characters in the text. |
[out] | hyperlinkIndex | Returns the 0 based index of the hyperlink that is associated with this character index, or -1 if charIndex is not on a link. |
S_OK | |
S_FALSE | if there is nothing to return, [out] value is -1 |
E_INVALIDARG | if bad [in] passed |
Referenced by CAccHypertext::get_hyperlinkIndex().
|
get |
Returns the number of links and link groups contained within this hypertext paragraph.
[out] | hyperlinkCount | The number of links and link groups within this hypertext paragraph. Returns 0 if there is no link. |
S_OK |