|
| Text (Text&& src) noexcept |
|
Text& | operator= (Text&& src) noexcept |
|
virtual | ~Text () noexcept |
|
AtkText* | gobj () |
| Provides access to the underlying C GObject. More...
|
|
const AtkText* | gobj () const |
| Provides access to the underlying C GObject. More...
|
|
Glib::ustring | get_text (int start_offset, int end_offset) const |
| Gets the specified text. More...
|
|
gunichar | get_character_at_offset (int offset) const |
| Gets the specified text. More...
|
|
Glib::ustring | get_text_after_offset (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const |
| Gets the specified text. More...
|
|
Glib::ustring | get_text_at_offset (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const |
| Gets the specified text. More...
|
|
Glib::ustring | get_text_before_offset (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const |
| Gets the specified text. More...
|
|
Glib::ustring | get_string_at_offset (int offset, TextGranularity granularity, int& start_offset, int& end_offset) |
| Gets a portion of the text exposed through an Atk::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. More...
|
|
int | get_caret_offset () const |
| Gets the offset position of the caret (cursor). More...
|
|
void | get_character_extents (int offset, int& x, int& y, int& width, int& height, CoordType coords) const |
| Get the bounding box containing the glyph representing the character at a particular text offset. More...
|
|
AttributeSet | get_run_attributes (int offset, int& start_offset, int& end_offset) const |
| Creates an Atk::AttributeSet which consists of the attributes explicitly set at the position offset in the text. More...
|
|
AttributeSet | get_default_attributes () const |
| Creates an Atk::AttributeSet which consists of the default values of attributes for the text. More...
|
|
int | get_character_count () const |
| Gets the character count. More...
|
|
int | get_offset_at_point (int x, int y, CoordType coords) const |
| Gets the offset of the character located at coordinates x and y. More...
|
|
int | get_n_selections () const |
| Gets the number of selected regions. More...
|
|
Glib::ustring | get_selection (int selection_num, int& start_offset, int& end_offset) const |
| Gets the text from the specified selection. More...
|
|
bool | add_selection (int start_offset, int end_offset) |
| Adds a selection bounded by the specified offsets. More...
|
|
bool | remove_selection (int selection_num) |
| Removes the specified selection. More...
|
|
bool | set_selection (int selection_num, int start_offset, int end_offset) |
| Changes the start and end offset of the specified selection. More...
|
|
bool | set_caret_offset (int offset) |
| Sets the caret (cursor) position to the specified offset. More...
|
|
void | get_range_extents (int start_offset, int end_offset, CoordType coord_type, Rectangle& rect) |
| Get the bounding box for text within the specified range. More...
|
|
AtkTextRange** | get_bounded_ranges (const Rectangle& rect, CoordType coord_type, TextClipType x_clip_type, TextClipType y_clip_type) |
| Get the ranges of text in the specified bounding box. More...
|
|
Glib::SignalProxy2< void, int, int > | signal_text_changed () |
|
Glib::SignalProxy1< void, int > | signal_text_caret_moved () |
|
Glib::SignalProxy0< void > | signal_text_selection_changed () |
|
Glib::SignalProxy0< void > | signal_text_attributes_changed () |
|
| Interface () |
|
| Interface (Interface &&src) noexcept |
|
Interface & | operator= (Interface &&src) noexcept |
|
| Interface (const Glib::Interface_Class &interface_class) |
|
| Interface (GObject *castitem) |
|
virtual | ~Interface () noexcept |
|
| Interface (const Interface &)=delete |
|
Interface & | operator= (const Interface &)=delete |
|
GObject * | gobj () |
|
const GObject * | gobj () const |
|
| ObjectBase (const ObjectBase &)=delete |
|
ObjectBase & | operator= (const ObjectBase &)=delete |
|
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
|
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
|
void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
|
void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
|
void | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot) |
|
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot) |
|
void | freeze_notify () |
|
void | thaw_notify () |
|
virtual void | reference () const |
|
virtual void | unreference () const |
|
GObject * | gobj () |
|
const GObject * | gobj () const |
|
GObject * | gobj_copy () const |
|
| trackable () noexcept |
|
| trackable (const trackable &src) noexcept |
|
| trackable (trackable &&src) |
|
| ~trackable () |
|
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
|
void | notify_callbacks () |
|
trackable & | operator= (const trackable &src) |
|
trackable & | operator= (trackable &&src) |
|
void | remove_destroy_notify_callback (void *data) const |
|
|
| Text () |
| You should derive from this class to use it. More...
|
|
virtual Glib::ustring | get_text_vfunc (int start_offset, int end_offset) const |
|
virtual gunichar | get_character_at_offset_vfunc (int offset) const |
|
virtual Glib::ustring | get_text_after_offset_vfunc (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const |
|
virtual Glib::ustring | get_text_at_offset_vfunc (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const |
|
virtual Glib::ustring | get_text_before_offset_vfunc (int offset, TextBoundary boundary_type, int& start_offset, int& end_offset) const |
|
virtual int | get_caret_offset_vfunc () const |
|
virtual void | get_character_extents_vfunc (int offset, int& x, int& y, int& width, int& height, CoordType coords) const |
|
virtual AtkAttributeSet* | get_run_attributes_vfunc (int offset, int& start_offset, int& end_offset) const |
|
virtual AtkAttributeSet* | get_default_attributes_vfunc () const |
|
virtual int | get_character_count_vfunc () const |
|
virtual int | get_offset_at_point_vfunc (int x, int y, CoordType coords) const |
|
virtual int | get_n_selections_vfunc () const |
|
virtual Glib::ustring | get_selection_vfunc (int selection_num, int& start_offset, int& end_offset) const |
|
virtual bool | add_selection_vfunc (int start_offset, int end_offset) |
|
virtual bool | remove_selection_vfunc (int selection_num) |
|
virtual bool | set_selection_vfunc (int selection_num, int start_offset, int end_offset) |
|
virtual bool | set_caret_offset_vfunc (int offset) |
|
virtual void | on_text_changed (int position, int length) |
| This is a default handler for the signal signal_text_changed(). More...
|
|
virtual void | on_text_caret_moved (int location) |
| This is a default handler for the signal signal_text_caret_moved(). More...
|
|
virtual void | on_text_selection_changed () |
| This is a default handler for the signal signal_text_selection_changed(). More...
|
|
virtual void | on_text_attributes_changed () |
| This is a default handler for the signal signal_text_attributes_changed(). More...
|
|
| ObjectBase () |
|
| ObjectBase (const char *custom_type_name) |
|
| ObjectBase (const std::type_info &custom_type_info) |
|
| ObjectBase (ObjectBase &&src) noexcept |
|
ObjectBase & | operator= (ObjectBase &&src) noexcept |
|
virtual | ~ObjectBase () noexcept=0 |
|
void | initialize (GObject *castitem) |
|
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
|
The ATK interface implemented by components with text content.
This should be implemented by Atk::Objects 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, this Text interface should be used to expose the text content. In the case of editable text content, Atk::EditableText (a subtype of the Atk::Text 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.
Gets a portion of the text exposed through an Atk::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.
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 atkmm 2.10:
- Parameters
-
offset | Position. |
granularity | An Atk::TextGranularity. |
start_offset | The start offset of the returned string, or -1 if an error has occurred (e.g. invalid offset, not implemented). |
end_offset | The offset of the first character after the returned string, or -1 if an error has occurred (e.g. invalid offset, not implemented). |
- Returns
- A newly allocated string containing the text at the offset bounded by the specified granularity. Use Glib::free() to free the returned string. Returns
nullptr
if the offset is invalid or no implementation is available.
Glib::ustring Atk::Text::get_text_at_offset |
( |
int |
offset, |
|
|
TextBoundary |
boundary_type, |
|
|
int & |
start_offset, |
|
|
int & |
end_offset |
|
) |
| const |
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.
Deprecated: This method is deprecated since ATK version 2.9.4. Please use get_string_at_offset() instead.
- Deprecated:
- Use get_string_at_offset() instead.
- Parameters
-
offset | Position. |
boundary_type | An Atk::TextBoundary. |
start_offset | The start 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 Glib::free() to free the returned string.