get_text_at_offset


Description:

[ Version ( deprecated = true , deprecated_since = "2.10" ) ]
public TextRange get_text_at_offset (int offset, TextBoundaryType type) throws Error

Warning: get_text_at_offset is deprecated since 2.10.

Gets delimited text from an Text object which includes a given text offset.

Note:

Use atspi_text_get_string_at_offset.

Parameters:

this

a pointer to the Text object on which to operate.

offset

a int indicating the offset from which the delimiter search is based.

type

an TextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run.

Returns:

an TextRange containing a UTF-8 string representing the delimited text, whose delimiting boundaries bracket the current offset, or an empty string if no such text exists.