Sets our main struct and passes it to the parent class
The "text-attributes-changed" signal is emitted when the text attributes of the text of an object which implements AtkText changes.
The "text-caret-moved" signal is emitted when the caret position of the text of an object which implements AtkText changes.
Warning AtkText::text-changed is deprecated and should not be used in newly-written code. Since 2.9.4. Use "text-insert" or "text-remove" instead. The "text-changed" signal is emitted when the text of the object which implements the AtkText interface changes, This signal will have a detail which is either "insert" or "delete" which identifies whether the text change was an insertion or a deletion.
The "text-insert" signal is emitted when a new text is inserted.
The "text-remove" signal is emitted when a new text is removed.
The "text-selection-changed" signal is emitted when the selected text of an object which implements AtkText changes.
Adds a selection bounded by the specified offsets.
Get the ranges of text in the specified bounding box. Since 1.3
Gets the offset position of the caret (cursor).
Gets the specified text.
Gets the character count.
Get the bounding box containing the glyph representing the character at a particular text offset.
Creates an AtkAttributeSet which consists of the default values of attributes for the text. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned.
Gets the number of selected regions.
Gets the offset of the character located at coordinates x and y. x and y are interpreted as being relative to the screen or this widget's window depending on coords.
Get the bounding box for text within the specified range. Since 1.3
Creates an AtkAttributeSet which consists of the attributes explicitly set at the position offset in the text. start_offset and end_offset are set to the start and end of the range around offset where the attributes are invariant. Note that end_offset is the offset of the first character after the range. See the enum AtkTextAttribute for types of text attributes that can be returned. Note that other attributes may also be returned.
Gets the text from the specified selection.
Gets a portion of the text exposed through an AtkText according to a given offset and a specific granularity, along with the start and end offsets defining the boundaries of such a portion of text. If granularity is ATK_TEXT_GRANULARITY_CHAR the character at the offset is returned. If granularity is ATK_TEXT_GRANULARITY_WORD 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 granularity is ATK_TEXT_GRANULARITY_SENTENCE 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 granularity is ATK_TEXT_GRANULARITY_LINE the returned string is from the line start at or before the offset to the line start after the offset. If granularity is ATK_TEXT_GRANULARITY_PARAGRAPH the returned string is from the start of the paragraph at or before the offset to the start of the following paragraph after the offset. Since 2.9.4
the main Gtk struct as a void*
Gets the specified text.
Warning atk_text_get_text_after_offset is deprecated and should not be used in newly-written code. This method is deprecated since ATK version 2.9.3. Please use atk_text_get_string_at_offset() instead. Gets the specified text.
Warning atk_text_get_text_at_offset is deprecated and should not be used in newly-written code. This method is deprecated since ATK version 2.9.4. Please use atk_text_get_string_at_offset() instead. Gets the specified text. 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.
Warning atk_text_get_text_before_offset is deprecated and should not be used in newly-written code. This method is deprecated since ATK version 2.9.3. Please use atk_text_get_string_at_offset() instead. Gets the specified text.
Removes the specified selection.
Sets the caret (cursor) position to the specified offset.
Changes the start and end offset of the specified selection.
Frees the memory used by an AtkAttributeSet, including all its AtkAttributes.
Get the AtkTextAttribute type corresponding to a text attribute name.
Gets the name corresponding to the AtkTextAttribute
Gets the value for the index of the AtkTextAttribute
Associate name with a new AtkTextAttribute
Frees the memory associated with an array of AtkTextRange. It is assumed that the array was returned by the function atk_text_get_bounded_ranges and is NULL terminated. Since 1.3
the main Gtk struct
AtkText should be implemented by AtkObjects on behalf of widgets that have text content which is either attributed or otherwise non-trivial. AtkObjects whose text content is simple, unattributed, and very brief may expose that content via atk_object_get_name instead; however if the text is editable, multi-line, typically longer than three or four words, attributed, selectable, or if the object already uses the 'name' ATK property for other information, the AtkText interface should be used to expose the text content. In the case of editable text content, AtkEditableText (a subtype of the AtkText interface) should be implemented instead.
AtkText provides not only traversal facilities and change notification for text content, but also caret tracking and glyph bounding box calculations. Note that the text strings are exposed as UTF-8, and are therefore potentially multi-byte, and caret-to-byte offset mapping makes no assumptions about the character length; also bounding box glyph-to-offset mapping may be complex for languages which use ligatures.