atkTextGetTextBeforeOffset: atkTextGetTextBeforeOffset
Description
Gets the specified text.Usage
atkTextGetTextBeforeOffset(object, offset, boundary.type)
Value
A list containing the following elements:
- retval
- [character] the text before
offset
bounded by the specified boundary.type
. start.offset
- [integer] the start offset of the returned string
end.offset
- [integer] the offset of the first character after the
returned substring
Details
If the boundary_type if ATK_TEXT_BOUNDARY_CHAR the character before the
offset is returned.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_START the returned string
is from the word start before the word start before the offset to
the word start before the offset.
The returned string will contain the word before the offset if the offset
is inside a word and will contain the word before the word before the
offset if the offset is not inside a word.
If the boundary_type is ATK_TEXT_BOUNDARY_WORD_END the returned string
is from the word end before the word end at or before the offset to the
word end at or before the offset.
The returned string will contain the word before the offset if the offset
is inside a word or 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 before the sentence start before
the offset to the sentence start before the offset.
The returned string will contain the sentence before the offset if the
offset is inside a sentence and will contain the sentence before the
sentence before the offset if the offset is not inside a sentence.
If the boundary_type is ATK_TEXT_BOUNDARY_SENTENCE_END the returned string
is from the sentence end before the sentence end at or before the offset to
the sentence end at or before the offset.
The returned string will contain the sentence before the offset if the
offset is inside a sentence or 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 before the line start ar or before the offset
to the line start ar or before the offset.
If the boundary_type is ATK_TEXT_BOUNDARY_LINE_END the returned string
is from the line end before the line end before the offset to the
line end before the offset.