get_text_at_offset


Description:

[ Version ( deprecated = true ) ]
public abstract string get_text_at_offset (int offset, TextBoundary boundary_type, out int start_offset, out int end_offset)

Warning: get_text_at_offset is deprecated.

Gets the specified text.

Note:

This method is deprecated since ATK version 2.9.4.

Please use get_string_at_offset instead.

If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character at the offset is returned.

If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string is from the word start at or before the offset to the word start after the offset.

The returned string will contain the word at the offset if the offset is inside a word and will contain the word before the offset if the offset is not inside a word.

If the boundary type is ATK_TEXT_BOUNDARY_SENTENCE_START the returned string is from the sentence start at or before the offset to the sentence start after the offset.

The returned string will contain the sentence at the offset if the offset is inside a sentence and will contain the sentence before the offset if the offset is not inside a sentence.

If the boundary type is ATK_TEXT_BOUNDARY_LINE_START the returned string is from the line start at or before the offset to the line start after the offset.

Parameters:

this

an Text

offset

position

boundary_type

An TextBoundary

start_offset

the starting character offset of the returned string

end_offset

the offset of the first character after the returned substring

Returns:

a newly allocated string containing the text at offset bounded by the specified boundary_type. Use g_free to free the returned string.




2022 vala-language.org