Text
Object Hierarchy:
Description:
[
CCode ( type_id =
"atspi_text_get_type ()" ) ]
public interface Text :
Object
An interface implemented by objects which place textual information onscreen.
The text interface should be implemented by objects which place textual information onscreen as character strings or glyphs. The text
interface allows access to textual content including display attributes and semantic hints associated with runs of text, and to bounding
information for glyphs and substrings. It also allows portions of text to be selected, if the objects StateSet includes
STATE_SELECTABLE_TEXT.
All known implementing classes:
Content:
Methods:
- public bool add_selection (int start_offset, int end_offset) throws Error
Selects some text (adds a text selection) in an
Text object.
- public HashTable<string,string> get_attribute_run (int offset, bool include_defaults, out int start_offset, out int end_offset) throws Error
Gets a set of attributes applied to a range of text from an
Text object, optionally including its 'default' attributes.
- public string? get_attribute_value (int offset, string attribute_name) throws Error
Gets the value of a named attribute at a given offset.
- public HashTable<string,string> get_attributes (int offset, out int start_offset, out int end_offset) throws Error
Gets the attributes applied to a range of text from an
Text object.
- public Array<TextRange> get_bounded_ranges (int x, int y, int width, int height, CoordType type, TextClipType clipTypeX, TextClipType clipTypeY) throws Error
Gets the ranges of text from an Text
object which lie within the bounds defined by (x, y) and (x+width, y
+height).
- public int get_caret_offset () throws Error
Gets the current offset of the text caret in an
Text object.
- public uint get_character_at_offset (int offset) throws Error
Gets the character at a given offset for an
Text object.
- public int get_character_count () throws Error
Gets the character count of an AccessibleText object.
- public Rect get_character_extents (int offset, CoordType type) throws Error
Gets a bounding box containing the glyph representing the character
at a particular text offset.
- public HashTable<string,string> get_default_attributes () throws Error
Gets the default attributes applied to an Text
object.
- public int get_n_selections () throws Error
Gets the number of active non-contiguous selections for an
Text object.
- public int get_offset_at_point (int x, int y, CoordType type) throws Error
Gets the character offset into the text at a given point.
- public Rect get_range_extents (int start_offset, int end_offset, CoordType type) throws Error
Gets the bounding box for text within a range in an
Text object.
- public Range get_selection (int selection_num) throws Error
Gets the bounds of the selection_num-th active text
selection for an Text object.
- public TextRange get_string_at_offset (int offset, TextGranularity granularity) throws Error
Gets a portion of the text exposed through an
Text 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.
- public string get_text (int start_offset, int end_offset) throws Error
Gets a range of text from an Text
object.
- public TextRange get_text_after_offset (int offset, TextBoundaryType type) throws Error
Gets delimited text from an Text object
which follows a given text offset.
- public TextRange get_text_at_offset (int offset, TextBoundaryType type) throws Error
Gets delimited text from an Text object
which includes a given text offset.
- public string? get_text_attribute_value (int offset, string attribute_name) throws Error
Gets the value of a named attribute at a given offset.
- public HashTable<string,string> get_text_attributes (int offset, out int start_offset, out int end_offset) throws Error
Gets the attributes applied to a range of text from an
Text object.
- public TextRange get_text_before_offset (int offset, TextBoundaryType type) throws Error
Gets delimited text from an Text object
which precedes a given text offset.
- public bool remove_selection (int selection_num) throws Error
De-selects a text selection.
- public bool scroll_substring_to (int start_offset, int end_offset, ScrollType type) throws Error
Scrolls whatever container of the Text
text range so it becomes visible on the screen.
- public bool scroll_substring_to_point (int start_offset, int end_offset, CoordType coords, int x, int y) throws Error
Scrolls whatever container of the Text
text range so it becomes visible on the screen at a given position.
- public bool set_caret_offset (int new_offset) throws Error
Moves the text caret to a given position.
- public bool set_selection (int selection_num, int start_offset, int end_offset) throws Error
Changes the bounds of an existing Text
text selection.
Inherited Members:
All known members inherited from class GLib.Object