AT-SPI C Bindings Reference Manual | |||
---|---|---|---|
<<< Previous Page | Home | Up | Next Page >>> |
enum AccessibleTextBoundaryType; int AccessibleText_ref (AccessibleText *obj); int AccessibleText_unref (AccessibleText *obj); boolean AccessibleText_addSelection (AccessibleText *obj, long int startOffset, long int endOffset); char* AccessibleText_getAttributes (AccessibleText *obj, long int offset, long int *startOffset, long int *endOffset); long AccessibleText_getCaretOffset (AccessibleText *obj); long AccessibleText_getCharacterCount (AccessibleText *obj); void AccessibleText_getCharacterExtents (AccessibleText *obj, long int offset, long int *x, long int *y, long int *width, long int *height, AccessibleCoordType type); long AccessibleText_getNSelections (AccessibleText *obj); long AccessibleText_getOffsetAtPoint (AccessibleText *obj, long int x, long int y, AccessibleCoordType type); void AccessibleText_getSelection (AccessibleText *obj, long int selectionNum, long int *startOffset, long int *endOffset); char* AccessibleText_getText (AccessibleText *obj, long int startOffset, long int endOffset); char* AccessibleText_getTextBeforeOffset (AccessibleText *obj, long int offset, AccessibleTextBoundaryType type, long int *startOffset, long int *endOffset); char* AccessibleText_getTextAfterOffset (AccessibleText *obj, long int offset, AccessibleTextBoundaryType type, long int *startOffset, long int *endOffset); char* AccessibleText_getTextAtOffset (AccessibleText *obj, long int offset, AccessibleTextBoundaryType type, long int *startOffset, long int *endOffset); boolean AccessibleText_removeSelection (AccessibleText *obj, long int selectionNum); boolean AccessibleText_setCaretOffset (AccessibleText *obj, long int newOffset); boolean AccessibleText_setSelection (AccessibleText *obj, long int selectionNum, long int startOffset, long int endOffset); |
typedef enum { SPI_TEXT_BOUNDARY_CHAR, SPI_TEXT_BOUNDARY_CURSOR_POS, SPI_TEXT_BOUNDARY_WORD_START, SPI_TEXT_BOUNDARY_WORD_END, SPI_TEXT_BOUNDARY_SENTENCE_START, SPI_TEXT_BOUNDARY_SENTENCE_END, SPI_TEXT_BOUNDARY_LINE_START, SPI_TEXT_BOUNDARY_LINE_END, SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE } AccessibleTextBoundaryType; |
int AccessibleText_ref (AccessibleText *obj); |
Increment the reference count for an AccessibleText object.
int AccessibleText_unref (AccessibleText *obj); |
Decrement the reference count for an AccessibleText object.
boolean AccessibleText_addSelection (AccessibleText *obj, long int startOffset, long int endOffset); |
Select some text (add a text selection) in an AccessibleText object.
char* AccessibleText_getAttributes (AccessibleText *obj, long int offset, long int *startOffset, long int *endOffset); |
Get the attributes applied to a range of text from an AccessibleText object, and the bounds of the range.
obj : | a pointer to the AccessibleText object to query. |
offset : | a long integer indicating the offset from which the attribute search is based. |
startOffset : | a long indicating the start of the desired text range. |
endOffset : | a long indicating the first character past the desired range. |
Returns : | a text string describing the attributes occurring within the attribute run containing offset, encoded as UTF-8 and delimited by ':' |
long AccessibleText_getCaretOffset (AccessibleText *obj); |
Get the current offset of the text caret in an AccessibleText object.
long AccessibleText_getCharacterCount (AccessibleText *obj); |
Get the character count of an AccessibleText object.
void AccessibleText_getCharacterExtents (AccessibleText *obj, long int offset, long int *x, long int *y, long int *width, long int *height, AccessibleCoordType type); |
Get the bounding box containing the glyph representing the character at a particular text offset.
obj : | a pointer to the AccessibleText object on which to operate. |
offset : | an integer indicating the offset of the text character for whom boundary information is requested. |
x : | a pointer to a long integer into which the nominal x coordinate of the corresponding glyph will be returned. |
y : | a pointer to a long integer into which the nominal y coordinate of the corresponding glyph will be returned. |
width : | a pointer to a long integer into which the width of the corresponding glyph will be returned. |
height : | a pointer to a long integer into which the height of the corresponding glyph will be returned. |
type : | an AccessibleCoordType indicating the coordinate system to use for the returned values. |
long AccessibleText_getNSelections (AccessibleText *obj); |
Get the number of active non-contiguous selections for an AccessibleText object.
long AccessibleText_getOffsetAtPoint (AccessibleText *obj, long int x, long int y, AccessibleCoordType type); |
Get the bounding box for a glyph at a certain AccessibleText offset.
obj : | a pointer to the AccessibleText object on which to operate. |
x : | the x coordinate of the point to be queried. |
y : | the y coordinate of the point to be queried. |
type : | an AccessibleCoordType indicating the coordinate system in which the values should be returned. |
Returns : | the offset (as a long integer) at the point (x, y) in the specified coordinate system. |
void AccessibleText_getSelection (AccessibleText *obj, long int selectionNum, long int *startOffset, long int *endOffset); |
Get the bounds of the selectionNum-th active text selection for an AccessibleText object.
obj : | a pointer to the AccessibleText object on which to operate. |
selectionNum : | an integer indicating which selection to query. |
startOffset : | a pointer to a long integer into which the start offset of the selection will be returned. |
endOffset : | a pointer to a long integer into which the start offset of the selection will be returned. |
char* AccessibleText_getText (AccessibleText *obj, long int startOffset, long int endOffset); |
Get a range of text from an AccessibleText object. The number of bytes in the returned string may exceed endOffset-startOffset, since UTF-8 is a variable-width encoding.
obj : | a pointer to the AccessibleText object to query. |
startOffset : | a long indicating the start of the desired text range. |
endOffset : | a long indicating the first character past the desired range. |
Returns : | a text string containing characters from startOffset to endOffset-1, inclusive, encoded as UTF-8. |
char* AccessibleText_getTextBeforeOffset (AccessibleText *obj, long int offset, AccessibleTextBoundaryType type, long int *startOffset, long int *endOffset); |
Get delimited text from an AccessibleText object which precedes a given text offset.
obj : | a pointer to the AccessibleText object on which to operate. |
offset : | a long integer indicating the offset from which the delimiter search is based. |
type : | an AccessibleTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. |
startOffset : | a pointer to a long integer which is assigned the starting offset of the returned string, relative to the original AccessibleText. |
endOffset : | a pointer to a long integer which is assigned the ending offset of the returned string, relative to the original AccessibleText. |
Returns : | a UTF-8 string representing the delimited text, both of whose delimiting boundaries are before the current offset, or an empty string if no such text exists. |
char* AccessibleText_getTextAfterOffset (AccessibleText *obj, long int offset, AccessibleTextBoundaryType type, long int *startOffset, long int *endOffset); |
Get delimited text from an AccessibleText object which follows a given text offset.
obj : | a pointer to the AccessibleText object on which to operate. |
offset : | a long integer indicating the offset from which the delimiter search is based. |
type : | an AccessibleTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. |
startOffset : | a pointer to a long integer which is assigned the starting offset of the returned string, relative to the original AccessibleText. |
endOffset : | a pointer to a long integer which is assigned the ending offset of the returned string, relative to the original AccessibleText. |
Returns : | a UTF-8 string representing the delimited text, both of whose delimiting boundaries are after or inclusive of the current offset, or an empty string if no such text exists. |
char* AccessibleText_getTextAtOffset (AccessibleText *obj, long int offset, AccessibleTextBoundaryType type, long int *startOffset, long int *endOffset); |
Get delimited text from an AccessibleText object which includes a given text offset.
obj : | a pointer to the AccessibleText object on which to operate. |
offset : | a long integer indicating the offset from which the delimiter search is based. |
type : | an AccessibleTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. |
startOffset : | a pointer to a long integer which is assigned the starting offset of the returned string, relative to the original AccessibleText. |
endOffset : | a pointer to a long integer which is assigned the ending offset of the returned string, relative to the original AccessibleText. |
Returns : | a UTF-8 string representing the delimited text, whose delimiting boundaries bracket the current offset, or an empty string if no such text exists. |
boolean AccessibleText_removeSelection (AccessibleText *obj, long int selectionNum); |
De-select a text selection.
boolean AccessibleText_setCaretOffset (AccessibleText *obj, long int newOffset); |
Set the text caret position for an AccessibleText object.
boolean AccessibleText_setSelection (AccessibleText *obj, long int selectionNum, long int startOffset, long int endOffset); |
Change the bounds of an existing AccessibleText text selection.
obj : | a pointer to the AccessibleText object on which to operate. |
selectionNum : | a zero-offset index indicating which text selection to modify. |
startOffset : | a long int, the new starting offset for the selection. |
endOffset : | a long int, the desired new offset of the first character after the selection. |
Returns : | TRUE if successful, FALSE otherwise. |