Module: Atk::Text
- Defined in:
- (unknown)
Overview
Atk::Text should be implemented by #AtkObjects on behalf of widgets that have text content which is either attributed or otherwise non-trivial. Atk::Objects 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 Atk::Text interface should be used to expose the text content. In the case of editable text content, Atk::EditableText (a subtype of the #AtkText interface) should be implemented instead.
Atk::Text 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.
Instance Method Summary collapse
-
#add_selection(text, start_offset, end_offset) ⇒ TrueClass
True if successful, false otherwise.
-
#caret_offset ⇒ Integer
Gets the offset of the position of the caret (cursor).
-
#caret_offset=(offset) ⇒ TrueClass
Sets the caret (cursor) position to the specified offset.
-
#character_count ⇒ Integer
Gets the character count.
-
#default_attributes ⇒ Atk::AttributeSet
Creates an Atk::AttributeSet which consists of the default values of attributes for the text.
-
#get_bounded_ranges(text, rect, coord_type, x_clip_type, y_clip_type) ⇒ Array<Atk::TextRange>
Array of AtkTextRange.
-
#get_caret_offset(text) ⇒ Integer
The character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure.
-
#get_character_at_offset(text, offset) ⇒ String
The character at offset or 0 in the case of failure.
-
#get_character_count(text) ⇒ Integer
The number of characters or -1 in case of failure.
- #get_character_extents(text, offset, x, y, width, height, coords) ⇒ nil
-
#get_default_attributes(text) ⇒ Atk::AttributeSet
An Atk::AttributeSet which contains the default text attributes for this Atk::Text.
-
#get_n_selections(text) ⇒ Integer
The number of selected regions, or -1 in the case of failure.
-
#get_offset_at_point(text, x, y, coords) ⇒ Integer
widget window.
- #get_range_extents(text, start_offset, end_offset, coord_type, rect) ⇒ nil
-
#get_run_attributes(text, offset, start_offset, end_offset) ⇒ Atk::AttributeSet
the character to be inserted at the caret location.
-
#get_selection(text, selection_num, start_offset, end_offset) ⇒ String
assigned numbers that correspond to how far the region is from the start of the text.
-
#get_string_at_offset(text, offset, granularity, start_offset, end_offset) ⇒ String
A newly allocated string containing the text at the offset bounded by the specified granularity.
-
#get_text(text, start_offset, end_offset) ⇒ String
A newly allocated string containing the text from start_offset up to, but not including end_offset.
-
#get_text_after_offset(text, offset, boundary_type, start_offset, end_offset) ⇒ String
A newly allocated string containing the text after offset bounded by the specified boundary_type.
-
#get_text_at_offset(text, offset, boundary_type, start_offset, end_offset) ⇒ String
A newly allocated string containing the text at offset bounded by the specified boundary_type.
-
#get_text_before_offset(text, offset, boundary_type, start_offset, end_offset) ⇒ String
A newly allocated string containing the text before offset bounded by the specified boundary_type.
-
#n_selections ⇒ Integer
Gets the number of selected regions.
-
#remove_selection(text, selection_num) ⇒ TrueClass
assigned numbers that correspond to how far the region is from the start of the text.
-
#scroll_substring_to(text, start_offset, end_offset, type) ⇒ TrueClass
Whether scrolling was successful.
-
#scroll_substring_to_point(text, start_offset, end_offset, coords, x, y) ⇒ TrueClass
parent object.
-
#set_caret_offset(text, offset) ⇒ TrueClass
True if successful, false otherwise.
-
#set_selection(text, selection_num, start_offset, end_offset) ⇒ TrueClass
assigned numbers that correspond to how far the region is from the start of the text.
- #text_attributes_changed(text) ⇒ nil
- #text_caret_moved(text, location) ⇒ nil
- #text_changed(text, position, length) ⇒ nil
- #text_selection_changed(text) ⇒ nil
Instance Method Details
#add_selection(text, start_offset, end_offset) ⇒ TrueClass
Returns true if successful, false otherwise.
#caret_offset ⇒ Integer
Gets the offset of the position of the caret (cursor).
#caret_offset=(offset) ⇒ TrueClass
Sets the caret (cursor) position to the specified offset.
#character_count ⇒ Integer
Gets the character count.
#default_attributes ⇒ Atk::AttributeSet
Creates an Atk::AttributeSet 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.
#get_bounded_ranges(text, rect, coord_type, x_clip_type, y_clip_type) ⇒ Array<Atk::TextRange>
Returns Array of AtkTextRange. The last element of the array returned by this function will be NULL.
#get_caret_offset(text) ⇒ Integer
Returns the character offset of the position of the caret or -1 if the caret is not located inside the element or in the case of any other failure.
#get_character_at_offset(text, offset) ⇒ String
Returns the character at offset or 0 in the case of failure.
#get_character_count(text) ⇒ Integer
Returns the number of characters or -1 in case of failure.
#get_character_extents(text, offset, x, y, width, height, coords) ⇒ nil
#get_default_attributes(text) ⇒ Atk::AttributeSet
Returns an Atk::AttributeSet which contains the default text attributes for this Atk::Text. This #AtkAttributeSet should be freed by a call to atk_attribute_set_free().
#get_n_selections(text) ⇒ Integer
Returns The number of selected regions, or -1 in the case of failure.
#get_offset_at_point(text, x, y, coords) ⇒ Integer
widget window
#get_range_extents(text, start_offset, end_offset, coord_type, rect) ⇒ nil
#get_run_attributes(text, offset, start_offset, end_offset) ⇒ Atk::AttributeSet
the character to be inserted at the caret location.
#get_selection(text, selection_num, start_offset, end_offset) ⇒ String
assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. of the selected region
#get_string_at_offset(text, offset, granularity, start_offset, end_offset) ⇒ String
Returns a newly allocated string containing the text at the offset bounded by the specified granularity. Use g_free() to free the returned string. Returns nil if the offset is invalid or no implementation is available.
#get_text(text, start_offset, end_offset) ⇒ String
Returns a newly allocated string containing the text from start_offset up to, but not including end_offset. Use g_free() to free the returned string.
#get_text_after_offset(text, offset, boundary_type, start_offset, end_offset) ⇒ String
Returns a newly allocated string containing the text after offset bounded by the specified boundary_type. Use g_free() to free the returned string.
#get_text_at_offset(text, offset, boundary_type, start_offset, end_offset) ⇒ String
Returns a newly allocated string containing the text at offset bounded by the specified boundary_type. Use g_free() to free the returned string.
#get_text_before_offset(text, offset, boundary_type, start_offset, end_offset) ⇒ String
Returns a newly allocated string containing the text before offset bounded by the specified boundary_type. Use g_free() to free the returned string.
#n_selections ⇒ Integer
Gets the number of selected regions.
#remove_selection(text, selection_num) ⇒ TrueClass
assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering.
#scroll_substring_to(text, start_offset, end_offset, type) ⇒ TrueClass
Returns whether scrolling was successful.
#scroll_substring_to_point(text, start_offset, end_offset, coords, x, y) ⇒ TrueClass
parent object.
#set_caret_offset(text, offset) ⇒ TrueClass
Returns true if successful, false otherwise.
#set_selection(text, selection_num, start_offset, end_offset) ⇒ TrueClass
assigned numbers that correspond to how far the region is from the start of the text. The selected region closest to the beginning of the text region is assigned the number 0, etc. Note that adding, moving or deleting a selected region can change the numbering. the selection