atkmm
2.36.0
|
The ATK interface implemented by components containing user-editable text content. More...
#include <atkmm/editabletext.h>
Public Member Functions | |
EditableText (EditableText&& src) noexcept | |
EditableText& | operator= (EditableText&& src) noexcept |
~EditableText () noexcept override | |
AtkEditableText* | gobj () |
Provides access to the underlying C GObject. More... | |
const AtkEditableText* | gobj () const |
Provides access to the underlying C GObject. More... | |
bool | set_run_attributes (const std::vector< Attribute >& attrib_set, int start_offset, int end_offset) |
Sets the attributes for a specified range. More... | |
void | set_text_contents (const Glib::ustring&string) |
Set text contents of text. More... | |
void | insert_text (const Glib::ustring&string, int length, int& position) |
Insert text at a given position. More... | |
void | copy_text (int start_pos, int end_pos) |
Copy text from start_pos up to, but not including end_pos to the clipboard. More... | |
void | cut_text (int start_pos, int end_pos) |
Copy text from start_pos up to, but not including end_pos to the clipboard and then delete from the widget. More... | |
void | delete_text (int start_pos, int end_pos) |
Delete text start_pos up to, but not including end_pos. More... | |
void | paste_text (int position) |
Paste text from clipboard to specified position. More... | |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
Public Member Functions inherited from Glib::ObjectBase | |
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 |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, 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 |
Public Member Functions inherited from sigc::trackable | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) const |
Static Public Member Functions | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
EditableText () | |
You should derive from this class to use it. More... | |
virtual bool | set_run_attributes_vfunc (AtkAttributeSet* attrib_set, int start_offset, int end_offset) |
virtual void | set_text_contents_vfunc (const Glib::ustring&string) |
virtual void | insert_text_vfunc (const Glib::ustring&string, int length, int& position) |
virtual void | copy_text_vfunc (int start_pos, int end_pos) |
virtual void | cut_text_vfunc (int start_pos, int end_pos) |
virtual void | delete_text_vfunc (int start_pos, int end_pos) |
virtual void | paste_text_vfunc (int position) |
Protected Member Functions inherited from Glib::ObjectBase | |
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) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Atk::EditableText > | wrap (AtkEditableText* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
Public Types inherited from sigc::trackable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Public Types inherited from sigc::notifiable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Detailed Description
The ATK interface implemented by components containing user-editable text content.
This should be implemented by UI components which contain text which the user can edit, via the Atk::Object corresponding to that component (see Atk::Object).
An object which implements EditableText shall also implement Atk::Text.
Constructor & Destructor Documentation
|
protected |
You should derive from this class to use it.
|
noexcept |
|
overridenoexcept |
Member Function Documentation
|
static |
void Atk::EditableText::copy_text | ( | int | start_pos, |
int | end_pos | ||
) |
Copy text from start_pos up to, but not including end_pos to the clipboard.
- Parameters
-
start_pos Start position. end_pos End position.
|
protectedvirtual |
void Atk::EditableText::cut_text | ( | int | start_pos, |
int | end_pos | ||
) |
Copy text from start_pos up to, but not including end_pos to the clipboard and then delete from the widget.
- Parameters
-
start_pos Start position. end_pos End position.
|
protectedvirtual |
void Atk::EditableText::delete_text | ( | int | start_pos, |
int | end_pos | ||
) |
Delete text start_pos up to, but not including end_pos.
- Parameters
-
start_pos Start position. end_pos End position.
|
protectedvirtual |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
void Atk::EditableText::insert_text | ( | const Glib::ustring & | string, |
int | length, | ||
int & | position | ||
) |
Insert text at a given position.
- Parameters
-
string The text to insert. length The length of text to insert, in bytes. position The caller initializes this to the position at which to insert the text. After the call it points at the position after the newly inserted text.
|
protectedvirtual |
|
noexcept |
void Atk::EditableText::paste_text | ( | int | position | ) |
Paste text from clipboard to specified position.
- Parameters
-
position Position to paste.
|
protectedvirtual |
bool Atk::EditableText::set_run_attributes | ( | const std::vector< Attribute >& | attrib_set, |
int | start_offset, | ||
int | end_offset | ||
) |
Sets the attributes for a specified range.
See the ATK_ATTRIBUTE macros (such as ATK_ATTRIBUTE_LEFT_MARGIN) for examples of attributes that can be set. Note that other attributes that do not have corresponding ATK_ATTRIBUTE macros may also be set for certain text widgets.
- Parameters
-
attrib_set An Atk::AttributeSet. start_offset Start of range in which to set attributes. end_offset End of range in which to set attributes.
- Returns
true
if attributes successfully set for the specified range, otherwisefalse
.
|
protectedvirtual |
void Atk::EditableText::set_text_contents | ( | const Glib::ustring & | string | ) |
Set text contents of text.
- Parameters
-
string String to set for text contents of text.
|
protectedvirtual |
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns
- A C++ instance that wraps this C instance.
Generated on Sat Dec 19 2020 09:14:21 for atkmm by 1.8.11