gtkmm: Gtk::Text Class Reference
A simple single-line text entry field. More...
#include <gtkmm/text.h>
Public Member Functions | |
Text (Text&& src) noexcept | |
Text& | operator= (Text&& src) noexcept |
Text (const Text&)=delete | |
Text& | operator= (const Text&)=delete |
~Text () noexcept override | |
GtkText* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkText* | gobj () const |
Provides access to the underlying C GObject. More... | |
Text () | |
Text (const Glib::RefPtr< EntryBuffer >& buffer) | |
Glib::RefPtr< EntryBuffer > | get_buffer () |
Get the Gtk::EntryBuffer object which holds the text for this self. More... | |
Glib::RefPtr< const EntryBuffer > | get_buffer () const |
Get the Gtk::EntryBuffer object which holds the text for this self. More... | |
void | set_buffer (const Glib::RefPtr< EntryBuffer >& buffer) |
Set the Gtk::EntryBuffer object which holds the text for this widget. More... | |
void | set_visibility (bool visible=true) |
Sets whether the contents of the self are visible or not. More... | |
bool | get_visibility () const |
Retrieves whether the text in self is visible. More... | |
void | set_invisible_char (gunichar ch) |
Sets the character to use in place of the actual text when set_visibility() has been called to set text visibility to false . More... | |
void | unset_invisible_char () |
Unsets the invisible char previously set with set_invisible_char(). More... | |
gunichar | get_invisible_char () const |
Retrieves the character displayed in place of the real characters for entries with visibility set to false. More... | |
void | set_overwrite_mode (bool overwrite=true) |
Sets whether the text is overwritten when typing in the Gtk::Text. More... | |
bool | get_overwrite_mode () const |
Gets the value set by set_overwrite_mode(). More... | |
void | set_max_length (int max) |
Sets the maximum allowed length of the contents of the widget. More... | |
int | get_max_length () const |
Retrieves the maximum allowed length of the text in self. More... | |
guint16 | get_text_length () const |
Retrieves the current length of the text in self. More... | |
void | set_activates_default (bool setting=true) |
If setting is true , pressing Enter in the self will activate the default widget for the window containing the self. More... | |
bool | get_activates_default () const |
Retrieves the value set by set_activates_default(). More... | |
Glib::ustring | get_placeholder_text () const |
Retrieves the text that will be displayed when self is empty and unfocused. More... | |
void | set_placeholder_text (const Glib::ustring& text) |
Sets text to be displayed in self when it is empty. More... | |
void | set_input_purpose (InputPurpose purpose) |
Sets the Gtk::Text::property_input_purpose() property which can be used by on-screen keyboards and other input methods to adjust their behaviour. More... | |
InputPurpose | get_input_purpose () const |
Gets the value of the Gtk::Text::property_input_purpose() property. More... | |
void | set_input_hints (InputHints hints) |
Sets the Gtk::Text::property_input_hints() property, which allows input methods to fine-tune their behaviour. More... | |
InputHints | get_input_hints () const |
Gets the value of the Gtk::Text::property_input_hints() property. More... | |
void | set_attributes (Pango::AttrList& attrs) |
Sets a Pango::AttrList; the attributes in the list are applied to the text. More... | |
Pango::AttrList | get_attributes () const |
Gets the attribute list that was set on the self using set_attributes(), if any. More... | |
void | set_tabs (const Pango::TabArray& tabs) |
Sets a Pango::TabArray; the tabstops in the array are applied to the self text. More... | |
Pango::TabArray | get_tabs () const |
Gets the tabstops that were set on the self using set_tabs(), if any. More... | |
bool | grab_focus_without_selecting () |
Causes self to have keyboard focus. More... | |
void | set_extra_menu (const Glib::RefPtr< Gio::MenuModel >& model) |
Sets a menu model to add when constructing the context menu for self. More... | |
Glib::RefPtr< Gio::MenuModel > | get_extra_menu () |
Gets the menu model set with set_extra_menu(). More... | |
Glib::RefPtr< const Gio::MenuModel > | get_extra_menu () const |
Gets the menu model set with set_extra_menu(). More... | |
void | set_enable_emoji_completion (bool enable_emoji_completion=true) |
Sets whether Emoji completion is enabled. More... | |
bool | get_enable_emoji_completion () const |
Returns whether Emoji completion is enabled for this GtkText widget. More... | |
void | set_propagate_text_width (bool propagate_text_width=true) |
Sets whether the GtkText should grow and shrink with the content. More... | |
bool | get_propagate_text_width () const |
Returns whether the Gtk::Text will grow and shrink with the content. More... | |
void | set_truncate_multiline (bool truncate_multiline=true) |
Sets whether the GtkText should truncate multi-line text that is pasted into the widget. More... | |
bool | get_truncate_multiline () const |
Returns whether the Gtk::Text will truncate multi-line text that is pasted into the widget. More... | |
Glib::PropertyProxy< Glib::RefPtr< EntryBuffer > > | property_buffer () |
Text buffer object which actually stores self text. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< EntryBuffer > > | property_buffer () const |
Text buffer object which actually stores self text. More... | |
Glib::PropertyProxy< int > | property_max_length () |
Maximum number of characters for this self. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_max_length () const |
Maximum number of characters for this self. More... | |
Glib::PropertyProxy< bool > | property_visibility () |
false displays the “invisible char” instead of the actual text (password mode). More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_visibility () const |
false displays the “invisible char” instead of the actual text (password mode). More... | |
Glib::PropertyProxy< gunichar > | property_invisible_char () |
The character to use when masking self contents (in “password mode”). More... | |
Glib::PropertyProxy_ReadOnly< gunichar > | property_invisible_char () const |
The character to use when masking self contents (in “password mode”). More... | |
Glib::PropertyProxy< bool > | property_invisible_char_set () |
Whether the invisible char has been set for the Gtk::Text. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_invisible_char_set () const |
Whether the invisible char has been set for the Gtk::Text. More... | |
Glib::PropertyProxy< bool > | property_activates_default () |
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_activates_default () const |
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_scroll_offset () const |
Number of pixels of the self scrolled off the screen to the left. More... | |
Glib::PropertyProxy< bool > | property_truncate_multiline () |
When true , pasted multi-line text is truncated to the first line. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_truncate_multiline () const |
When true , pasted multi-line text is truncated to the first line. More... | |
Glib::PropertyProxy< bool > | property_overwrite_mode () |
If text is overwritten when typing in the Gtk::Text. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_overwrite_mode () const |
If text is overwritten when typing in the Gtk::Text. More... | |
Glib::PropertyProxy< Glib::ustring > | property_im_module () |
Which IM (input method) module should be used for this self. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_im_module () const |
Which IM (input method) module should be used for this self. More... | |
Glib::PropertyProxy< Glib::ustring > | property_placeholder_text () |
The text that will be displayed in the Gtk::Text when it is empty and unfocused. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_placeholder_text () const |
The text that will be displayed in the Gtk::Text when it is empty and unfocused. More... | |
Glib::PropertyProxy< InputPurpose > | property_input_purpose () |
The purpose of this text field. More... | |
Glib::PropertyProxy_ReadOnly< InputPurpose > | property_input_purpose () const |
The purpose of this text field. More... | |
Glib::PropertyProxy< InputHints > | property_input_hints () |
Additional hints (beyond Gtk::Text::property_input_purpose()) that allow input methods to fine-tune their behaviour. More... | |
Glib::PropertyProxy_ReadOnly< InputHints > | property_input_hints () const |
Additional hints (beyond Gtk::Text::property_input_purpose()) that allow input methods to fine-tune their behaviour. More... | |
Glib::PropertyProxy< Pango::AttrList > | property_attributes () |
A list of Pango attributes to apply to the text of the self. More... | |
Glib::PropertyProxy_ReadOnly< Pango::AttrList > | property_attributes () const |
A list of Pango attributes to apply to the text of the self. More... | |
Glib::PropertyProxy< Pango::TabArray > | property_tabs () |
A list of tabstops to apply to the text of the self. More... | |
Glib::PropertyProxy_ReadOnly< Pango::TabArray > | property_tabs () const |
A list of tabstops to apply to the text of the self. More... | |
Glib::PropertyProxy< bool > | property_enable_emoji_completion () |
Whether to suggest Emoji replacements. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_enable_emoji_completion () const |
Whether to suggest Emoji replacements. More... | |
Glib::PropertyProxy< bool > | property_propagate_text_width () |
Whether the entry should grow and shrink with the content. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_propagate_text_width () const |
Whether the entry should grow and shrink with the content. More... | |
Glib::PropertyProxy< Glib::RefPtr< Gio::MenuModel > > | property_extra_menu () |
A menu model whose contents will be appended to the context menu. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::MenuModel > > | property_extra_menu () const |
A menu model whose contents will be appended to the context menu. More... | |
Public Member Functions inherited from Gtk::Widget | |
Widget (Widget&& src) noexcept | |
Widget& | operator= (Widget&& src) noexcept |
Widget (const Widget&)=delete | |
Widget& | operator= (const Widget&)=delete |
~Widget () noexcept override | |
Destroys the widget. More... | |
GtkWidget* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkWidget* | gobj () const |
Provides access to the underlying C GObject. More... | |
Glib::RefPtr< ConstraintTarget > | make_refptr_constrainttarget () |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
Glib::RefPtr< const ConstraintTarget > | make_refptr_constrainttarget () const |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
void | show () |
Flags a widget to be displayed. More... | |
void | hide () |
Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More... | |
void | queue_draw () |
Schedules this widget to be redrawn in paint phase of the current or the next frame. More... | |
void | queue_resize () |
This function is only for use in widget implementations. More... | |
void | queue_allocate () |
This function is only for use in widget implementations. More... | |
void | size_allocate (const Allocation& allocation, int baseline) |
This is a simple form of allocate() that takes the new position of widget as part of allocation. More... | |
SizeRequestMode | get_request_mode () const |
Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More... | |
void | measure (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
Measures widget in the orientation orientation and for the given for_size. More... | |
void | get_preferred_size (Requisition& minimum_size, Requisition& natural_size) const |
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More... | |
void | set_layout_manager (const Glib::RefPtr< LayoutManager >& layout_manager) |
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More... | |
void | unset_layout_manager () |
Undoes the effect of a previous call to set_layout_manager(). More... | |
Glib::RefPtr< LayoutManager > | get_layout_manager () |
Retrieves the layout manager set using set_layout_manager(). More... | |
Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
Retrieves the layout manager set using set_layout_manager(). More... | |
bool | mnemonic_activate (bool group_cycling) |
Emits the Gtk::Widget::signal_mnemonic_activate() signal. More... | |
bool | activate () |
For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More... | |
void | set_can_focus (bool can_focus=true) |
Specifies whether the input focus can enter the widget or any of its children. More... | |
bool | get_can_focus () const |
Determines whether the input focus can enter widget or any of its children. More... | |
void | set_focusable (bool focusable=true) |
Specifies whether widget can own the input focus. More... | |
bool | get_focusable () const |
Determines whether widget can own the input focus. More... | |
bool | has_focus () const |
Determines if the widget has the global input focus. More... | |
bool | is_focus () const |
Determines if the widget is the focus widget within its toplevel. More... | |
bool | has_visible_focus () const |
Determines if the widget should show a visible indication that it has the global input focus. More... | |
bool | grab_focus () |
Causes widget (or one of its descendents) to have the keyboard focus for the Gtk::Window it's inside. More... | |
void | set_focus_on_click (bool focus_on_click=true) |
Sets whether the widget should grab focus when it is clicked with the mouse. More... | |
bool | get_focus_on_click () const |
Returns whether the widget should grab focus when it is clicked with the mouse. More... | |
void | set_can_target (bool can_target=true) |
Sets whether widget can be the target of pointer events. More... | |
bool | get_can_target () const |
Queries whether widget can be the target of pointer events. More... | |
bool | has_default () const |
Determines whether widget is the current default widget within its toplevel. More... | |
void | set_receives_default (bool receives_default=true) |
Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More... | |
bool | get_receives_default () const |
Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More... | |
void | set_name (const Glib::ustring& name) |
Widgets can be named, which allows you to refer to them from a CSS file. More... | |
void | unset_name () |
Glib::ustring | get_name () const |
Retrieves the name of a widget. More... | |
void | set_state_flags (StateFlags flags, bool clear=true) |
This function is for use in widget implementations. More... | |
void | unset_state_flags (StateFlags flags) |
This function is for use in widget implementations. More... | |
StateFlags | get_state_flags () const |
Returns the widget state as a flag set. More... | |
void | set_sensitive (bool sensitive=true) |
Sets the sensitivity of a widget. More... | |
bool | get_sensitive () const |
Returns the widget’s sensitivity (in the sense of returning the value that has been set using set_sensitive()). More... | |
bool | is_sensitive () const |
Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. More... | |
void | set_visible (bool visible=true) |
Sets the visibility state of widget. More... | |
bool | get_visible () const |
Determines whether the widget is visible. More... | |
bool | is_visible () const |
Determines whether the widget and all its parents are marked as visible. More... | |
bool | is_drawable () const |
Determines whether widget can be drawn to. More... | |
bool | get_realized () const |
Determines whether widget is realized. More... | |
bool | get_mapped () const |
Whether the widget is mapped. More... | |
void | set_child_visible (bool visible=true) |
Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show(). More... | |
bool | get_child_visible () const |
Gets the value set with set_child_visible(). More... | |
int | get_allocated_width () const |
Returns the width that has currently been allocated to widget. More... | |
int | get_allocated_height () const |
Returns the height that has currently been allocated to widget. More... | |
int | get_allocated_baseline () const |
Returns the baseline that has currently been allocated to widget. More... | |
Allocation | get_allocation () const |
Retrieves the widget’s location. More... | |
int | get_width () const |
Returns the content width of the widget, as passed to its size-allocate implementation. More... | |
int | get_height () const |
Returns the content height of the widget, as passed to its size-allocate implementation. More... | |
int | get_size (Orientation orientation) const |
Returns the content width or height of the widget, depending on orientation. More... | |
Widget* | get_parent () |
Returns the parent widget of widget. More... | |
const Widget* | get_parent () const |
Returns the parent widget of widget. More... | |
Root* | get_root () |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
const Root* | get_root () const |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
Native* | get_native () |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. More... | |
const Native* | get_native () const |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. More... | |
bool | child_focus (DirectionType direction) |
This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget. More... | |
bool | keynav_failed (DirectionType direction) |
This function should be called whenever keyboard navigation within a single widget hits a boundary. More... | |
void | error_bell () |
Notifies the user about an input-related error on this widget. More... | |
void | set_size_request (int width=-1, int height=-1) |
Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. More... | |
void | get_size_request (int& width, int& height) const |
Gets the size request that was explicitly set for the widget using set_size_request(). More... | |
void | set_opacity (double opacity) |
Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. More... | |
double | get_opacity () const |
Fetches the requested opacity for this widget. More... | |
void | set_overflow (Overflow overflow) |
Sets how widget treats content that is drawn outside the widget's content area. More... | |
Overflow | get_overflow () const |
Returns the value set via set_overflow(). More... | |
Widget* | get_ancestor (GType widget_type) |
Gets the first ancestor of widget with type widget_type. More... | |
const Widget* | get_ancestor (GType widget_type) const |
Gets the first ancestor of widget with type widget_type. More... | |
int | get_scale_factor () const |
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More... | |
Glib::RefPtr< Gdk::Display > | get_display () |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< const Gdk::Display > | get_display () const |
Get the Gdk::Display for the toplevel window associated with this widget. More... | |
Glib::RefPtr< Settings > | get_settings () |
Gets the settings object holding the settings used for this widget. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_clipboard () |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_primary_clipboard () |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_primary_clipboard () const |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
bool | get_hexpand () const |
Gets whether the widget would like any available extra horizontal space. More... | |
void | set_hexpand (bool expand=true) |
Sets whether the widget would like any available extra horizontal space. More... | |
bool | get_hexpand_set () const |
Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More... | |
void | set_hexpand_set (bool set=true) |
Sets whether the hexpand flag (see get_hexpand()) will be used. More... | |
bool | get_vexpand () const |
Gets whether the widget would like any available extra vertical space. More... | |
void | set_vexpand (bool expand=true) |
Sets whether the widget would like any available extra vertical space. More... | |
bool | get_vexpand_set () const |
Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More... | |
void | set_vexpand_set (bool set=true) |
Sets whether the vexpand flag (see get_vexpand()) will be used. More... | |
bool | compute_expand (Orientation orientation) |
Computes whether a container should give this widget extra space when possible. More... | |
void | set_expand (bool expand=true) |
Sets whether the widget would like any available extra space in both directions. More... | |
Align | get_halign () const |
Gets the value of the Gtk::Widget::property_halign() property. More... | |
void | set_halign (Align align) |
Sets the horizontal alignment of widget. More... | |
Align | get_valign () const |
Gets the value of the Gtk::Widget::property_valign() property. More... | |
void | set_valign (Align align) |
Sets the vertical alignment of widget. More... | |
int | get_margin_start () const |
Gets the value of the Gtk::Widget::property_margin_start() property. More... | |
void | set_margin_start (int margin) |
Sets the start margin of widget. More... | |
int | get_margin_end () const |
Gets the value of the Gtk::Widget::property_margin_end() property. More... | |
void | set_margin_end (int margin) |
Sets the end margin of widget. More... | |
int | get_margin_top () const |
Gets the value of the Gtk::Widget::property_margin_top() property. More... | |
void | set_margin_top (int margin) |
Sets the top margin of widget. More... | |
int | get_margin_bottom () const |
Gets the value of the Gtk::Widget::property_margin_bottom() property. More... | |
void | set_margin_bottom (int margin) |
Sets the bottom margin of widget. More... | |
void | set_margin (int margin) |
Set all 4 margins to the same value. More... | |
bool | is_ancestor (Widget& ancestor) const |
Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More... | |
bool | translate_coordinates (Widget& dest_widget, double src_x, double src_y, double& dest_x, double& dest_y) |
Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More... | |
bool | contains (double x, double y) const |
Tests if the point at ( x, y) is contained in widget. More... | |
Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
const Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const |
Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
void | add_controller (const Glib::RefPtr< EventController >& controller) |
Adds controller to widget so that it will receive events. More... | |
void | remove_controller (const Glib::RefPtr< EventController >& controller) |
Removes controller from widget, so that it doesn't process events anymore. More... | |
Glib::RefPtr< Pango::Context > | create_pango_context () |
Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More... | |
Glib::RefPtr< Pango::Context > | get_pango_context () |
Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More... | |
void | set_font_options (const Cairo::FontOptions& options) |
Sets the #cairo_font_options_t used for Pango rendering in this widget. More... | |
void | unset_font_options () |
Undoes the effect of previous calls to set_font_options(). More... | |
Cairo::FontOptions | get_font_options () const |
Returns the #cairo_font_options_t used for Pango rendering. More... | |
Glib::RefPtr< Pango::Layout > | create_pango_layout (const Glib::ustring& text) |
Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More... | |
void | set_direction (TextDirection dir) |
Sets the reading direction on a particular widget. More... | |
TextDirection | get_direction () const |
Gets the reading direction for a particular widget. More... | |
void | set_cursor (const Glib::RefPtr< Gdk::Cursor >& cursor) |
Sets the cursor to be shown when pointer devices point towards widget. More... | |
void | set_cursor (const Glib::ustring& name={}) |
Sets a named cursor to be shown when pointer devices point towards the widget. More... | |
Glib::RefPtr< Gdk::Cursor > | get_cursor () |
Queries the cursor set via set_cursor(). More... | |
Glib::RefPtr< const Gdk::Cursor > | get_cursor () const |
Queries the cursor set via set_cursor(). More... | |
std::vector< Widget* > | list_mnemonic_labels () |
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
std::vector< const Widget* > | list_mnemonic_labels () const |
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
void | add_mnemonic_label (Widget& label) |
Adds a widget to the list of mnemonic labels for this widget. More... | |
void | remove_mnemonic_label (Widget& label) |
Removes a widget from the list of mnemonic labels for this widget. More... | |
bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
Checks to see if a mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK drag threshold, and thus should trigger the beginning of a drag-and-drop operation. More... | |
Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
Obtains the frame clock for a widget. More... | |
Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
Obtains the frame clock for a widget. More... | |
void | set_parent (Widget& parent) |
This function is useful only when implementing subclasses of Gtk::Widget. More... | |
void | unparent () |
This function is only for use in widget implementations. More... | |
void | map () |
This function is only for use in widget implementations. More... | |
void | unmap () |
This function is only for use in widget implementations. More... | |
void | trigger_tooltip_query () |
Triggers a tooltip query on the display where the toplevel of widget is located. More... | |
void | set_tooltip_text (const Glib::ustring& text) |
Sets text as the contents of the tooltip. More... | |
Glib::ustring | get_tooltip_text () const |
Gets the contents of the tooltip for widget. More... | |
void | set_tooltip_markup (const Glib::ustring& markup) |
Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More... | |
Glib::ustring | get_tooltip_markup () const |
Gets the contents of the tooltip for widget set using set_tooltip_markup(). More... | |
void | set_has_tooltip (bool has_tooltip=TRUE) |
Sets the has-tooltip property on widget to has_tooltip. More... | |
bool | get_has_tooltip () const |
Returns the current value of the has-tooltip property. More... | |
bool | in_destruction () const |
Returns whether the widget is currently being destroyed. More... | |
Glib::RefPtr< StyleContext > | get_style_context () |
Returns the style context associated to widget. More... | |
Glib::RefPtr< const StyleContext > | get_style_context () const |
Returns the style context associated to widget. More... | |
guint | add_tick_callback (const SlotTick& slot) |
Queues an animation frame update and adds a callback to be called before each frame. More... | |
void | remove_tick_callback (guint id) |
Removes a tick callback previously registered with add_tick_callback(). More... | |
void | insert_action_group (const Glib::ustring& name, const Glib::RefPtr< Gio::ActionGroup >& group) |
Inserts group into widget. More... | |
void | remove_action_group (const Glib::ustring& name) |
Removes a group from the widget. More... | |
bool | activate_action (const Glib::ustring& name, const Glib::VariantBase& args={}) |
Looks up the action in the action groups associated with the widget and its ancestors, and activates it. More... | |
void | activate_default () |
Activate the default.activate action from widget. More... | |
void | set_font_map (const Glib::RefPtr< Pango::FontMap >& font_map) |
Sets the font map to use for Pango rendering. More... | |
Glib::RefPtr< Pango::FontMap > | get_font_map () |
Gets the font map that has been set with set_font_map(). More... | |
Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
Gets the font map that has been set with set_font_map(). More... | |
Widget* | get_first_child () |
Returns the widgets first child. More... | |
const Widget* | get_first_child () const |
Returns the widgets first child. More... | |
Widget* | get_last_child () |
Returns the widgets last child. More... | |
const Widget* | get_last_child () const |
Returns the widgets last child. More... | |
Widget* | get_next_sibling () |
Returns the widgets next sibling. More... | |
const Widget* | get_next_sibling () const |
Returns the widgets next sibling. More... | |
Widget* | get_prev_sibling () |
Returns the widgets previous sibling. More... | |
const Widget* | get_prev_sibling () const |
Returns the widgets previous sibling. More... | |
Glib::RefPtr< Gio::ListModel > | observe_children () |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_children () const |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< Gio::ListModel > | observe_controllers () |
Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_controllers () const |
Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
void | insert_after (Widget& parent, const Widget& previous_sibling) |
Inserts the Widget into the child widget list of parent after previous_sibling. More... | |
void | insert_before (Widget& parent, const Widget& next_sibling) |
Inserts the Widget into the child widget list of parent before next_sibling. More... | |
void | insert_at_start (Widget& parent) |
Inserts the Widget at the beginning of the child widget list of parent. More... | |
void | insert_at_end (Widget& parent) |
Inserts the Widget at the end of the child widget list of parent. More... | |
void | snapshot_child (Widget& child, const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
When a widget receives a call to the snapshot function, it must send synthetic Gtk::WidgetClass.snapshot() calls to all children. More... | |
bool | should_layout () const |
Returns whether widget should contribute to the measuring and allocation of its parent. More... | |
Glib::ustring | get_css_name () const |
Returns the CSS name that is used for self. More... | |
void | add_css_class (const Glib::ustring& css_class) |
Adds css_class to widget. More... | |
void | remove_css_class (const Glib::ustring& css_class) |
Removes css_class from widget. More... | |
bool | has_css_class (const Glib::ustring& css_class) const |
Returns whether css_class is currently applied to widget. More... | |
std::vector< Glib::ustring > | get_css_classes () const |
Returns the list of css classes applied to widget. More... | |
void | set_css_classes (const std::vector< Glib::ustring >& classes) |
Will clear all css classes applied to widget and replace them with classes. More... | |
Glib::SignalProxy< void()> | signal_show () |
Glib::SignalProxy< void()> | signal_hide () |
Glib::SignalProxy< void()> | signal_map () |
Emitted on mapping of a widget to the screen. More... | |
Glib::SignalProxy< void()> | signal_unmap () |
Glib::SignalProxy< void()> | signal_realize () |
Emitted on realization of a widget. More... | |
Glib::SignalProxy< void()> | signal_unrealize () |
Glib::SignalProxy< void(Gtk::StateFlags)> | signal_state_flags_changed () |
Glib::SignalProxy< void(TextDirection)> | signal_direction_changed () |
Glib::SignalProxy< bool(bool)> | signal_mnemonic_activate () |
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip >&)> | signal_query_tooltip () |
Glib::PropertyProxy< Glib::ustring > | property_name () |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Widget* > | property_parent () const |
The parent widget of this widget. More... | |
Glib::PropertyProxy_ReadOnly< Root* > | property_root () const |
The Gtk::Root widget of the widget tree containing this widget or nullptr if the widget is not contained in a root widget. More... | |
Glib::PropertyProxy< int > | property_width_request () |
Override for width request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_width_request () const |
Override for width request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy< int > | property_height_request () |
Override for height request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_height_request () const |
Override for height request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy< bool > | property_visible () |
Whether the widget is visible. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_visible () const |
Whether the widget is visible. More... | |
Glib::PropertyProxy< bool > | property_sensitive () |
Whether the widget responds to input. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_sensitive () const |
Whether the widget responds to input. More... | |
Glib::PropertyProxy< bool > | property_can_focus () |
Whether the widget or any of its descendents can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_focus () const |
Whether the widget or any of its descendents can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_focus () const |
Whether the widget has the input focus. More... | |
Glib::PropertyProxy< bool > | property_can_target () |
Whether the widget can receive pointer events. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_target () const |
Whether the widget can receive pointer events. More... | |
Glib::PropertyProxy< bool > | property_focus_on_click () |
Whether the widget should grab focus when it is clicked with the mouse. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_focus_on_click () const |
Whether the widget should grab focus when it is clicked with the mouse. More... | |
Glib::PropertyProxy< bool > | property_focusable () |
Whether this widget itself will accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_focusable () const |
Whether this widget itself will accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_default () const |
Whether the widget is the default widget. More... | |
Glib::PropertyProxy< bool > | property_receives_default () |
If true , the widget will receive the default action when it is focused. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_receives_default () const |
If true , the widget will receive the default action when it is focused. More... | |
Glib::PropertyProxy< Glib::RefPtr< Gdk::Cursor > > | property_cursor () |
The cursor used by widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > | property_cursor () const |
The cursor used by widget. More... | |
Glib::PropertyProxy< bool > | property_has_tooltip () |
Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_tooltip () const |
Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More... | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_markup () |
Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_markup () const |
Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_text () |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy< Align > | property_halign () |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy< Align > | property_valign () |
How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_valign () const |
How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy< int > | property_margin_start () |
Margin on start of widget, horizontally. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_start () const |
Margin on start of widget, horizontally. More... | |
Glib::PropertyProxy< int > | property_margin_end () |
Margin on end of widget, horizontally. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_end () const |
Margin on end of widget, horizontally. More... | |
Glib::PropertyProxy< int > | property_margin_top () |
Margin on top side of widget. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_top () const |
Margin on top side of widget. More... | |
Glib::PropertyProxy< int > | property_margin_bottom () |
Margin on bottom side of widget. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_bottom () const |
Margin on bottom side of widget. More... | |
Glib::PropertyProxy< bool > | property_hexpand () |
Whether to expand horizontally. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand () const |
Whether to expand horizontally. More... | |
Glib::PropertyProxy< bool > | property_hexpand_set () |
Whether to use the Gtk::Widget::property_hexpand() property. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand_set () const |
Whether to use the Gtk::Widget::property_hexpand() property. More... | |
Glib::PropertyProxy< bool > | property_vexpand () |
Whether to expand vertically. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand () const |
Whether to expand vertically. More... | |
Glib::PropertyProxy< bool > | property_vexpand_set () |
Whether to use the Gtk::Widget::property_vexpand() property. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand_set () const |
Whether to use the Gtk::Widget::property_vexpand() property. More... | |
Glib::PropertyProxy< double > | property_opacity () |
The requested opacity of the widget. More... | |
Glib::PropertyProxy_ReadOnly< double > | property_opacity () const |
The requested opacity of the widget. More... | |
Glib::PropertyProxy< Overflow > | property_overflow () |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< Overflow > | property_overflow () const |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_scale_factor () const |
The scale factor of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_css_name () const |
The name of this widget in the CSS tree. More... | |
Glib::PropertyProxy< std::vector< Glib::ustring > > | property_css_classes () |
A list of css classes applied to this widget. More... | |
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > | property_css_classes () const |
A list of css classes applied to this widget. More... | |
Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > | property_layout_manager () |
The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > | property_layout_manager () const |
The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
Public Member Functions inherited from Gtk::Object | |
Object (Object&& src) noexcept | |
Object& | operator= (Object&& src) noexcept |
~Object () noexcept override | |
Public Member Functions inherited from Glib::Object | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (Object &&src) noexcept |
void * | get_data (const QueryQuark &key) |
void | set_data (const Quark &key, void *data) |
void | set_data (const Quark &key, void *data, DestroyNotify notify) |
void | remove_data (const QueryQuark &quark) |
void * | steal_data (const QueryQuark &quark) |
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
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 |
Public Member Functions inherited from Gtk::Accessible | |
Accessible (Accessible&& src) noexcept | |
Accessible& | operator= (Accessible&& src) noexcept |
~Accessible () noexcept override | |
GtkAccessible* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkAccessible* | gobj () const |
Provides access to the underlying C GObject. More... | |
Role | get_accessible_role () const |
Retrieves the Gtk::Accessible::Role for the given Gtk::Accessible. More... | |
void | update_state (State state, const Glib::ValueBase& value) |
Updates an accessible state. More... | |
void | update_property (Property property, const Glib::ValueBase& value) |
Updates an accessible property. More... | |
void | update_relation (Relation relation, const Glib::ValueBase& value) |
Updates an accessible relation. More... | |
void | reset_state (State state) |
Resets the accessible state to its default value. More... | |
void | reset_property (Property property) |
Resets the accessible property to its default value. More... | |
void | reset_relation (Relation relation) |
Resets the accessible relation to its default value. More... | |
Glib::PropertyProxy< Role > | property_accessible_role () |
The accessible role of the given Gtk::Accessible implementation. More... | |
Glib::PropertyProxy_ReadOnly< Role > | property_accessible_role () const |
The accessible role of the given Gtk::Accessible implementation. 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 Gtk::Buildable | |
Buildable (Buildable&& src) noexcept | |
Buildable& | operator= (Buildable&& src) noexcept |
~Buildable () noexcept override | |
GtkBuildable* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkBuildable* | gobj () const |
Provides access to the underlying C GObject. More... | |
Glib::ustring | get_buildable_id () const |
Gets the ID of the buildable object. More... | |
Public Member Functions inherited from Gtk::ConstraintTarget | |
ConstraintTarget (ConstraintTarget&& src) noexcept | |
ConstraintTarget& | operator= (ConstraintTarget&& src) noexcept |
~ConstraintTarget () noexcept override | |
GtkConstraintTarget* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkConstraintTarget* | gobj () const |
Provides access to the underlying C GObject. More... | |
Public Member Functions inherited from Gtk::Editable | |
Editable (Editable&& src) noexcept | |
Editable& | operator= (Editable&& src) noexcept |
~Editable () noexcept override | |
GtkEditable* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkEditable* | gobj () const |
Provides access to the underlying C GObject. More... | |
Glib::ustring | get_text () const |
Retrieves the contents of editable. More... | |
void | set_text (const Glib::ustring& text) |
Sets the text in the editable to the given value, replacing the current contents. More... | |
void | delete_selection () |
Deletes the currently selected text of the editable. More... | |
void | set_editable (bool is_editable=true) |
Determines if the user can edit the text in the editable widget or not. More... | |
bool | get_editable () const |
Retrieves whether editable is editable. More... | |
void | insert_text (const Glib::ustring& new_text, int new_text_length, int& position) |
Inserts new_text_length bytes of new_text into the contents of the widget, at position position. More... | |
void | delete_text (int start_pos, int end_pos) |
Deletes a sequence of characters. More... | |
Glib::ustring | get_chars (int start_pos, int end_pos) const |
Retrieves a sequence of characters. More... | |
void | select_region (int start_pos, int end_pos) |
Selects a region of text. More... | |
bool | get_selection_bounds (int& start_pos, int& end_pos) const |
Retrieves the selection bound of the editable. More... | |
void | set_position (int position) |
Sets the cursor position in the editable to the given value. More... | |
int | get_position () const |
Retrieves the current position of the cursor relative to the start of the content of the editable. More... | |
float | get_alignment () const |
Gets the value set by set_alignment(). More... | |
void | set_alignment (float xalign) |
Sets the alignment for the contents of the editable. More... | |
int | get_width_chars () const |
Gets the value set by set_width_chars(). More... | |
void | set_width_chars (int n_chars) |
Changes the size request of the editable to be about the right size for n_chars characters. More... | |
int | get_max_width_chars () const |
Retrieves the desired maximum width of editable, in characters. More... | |
void | set_max_width_chars (int n_chars) |
Sets the desired maximum width in characters of editable. More... | |
bool | get_enable_undo () const |
Gets if undo/redo actions are enabled for editable. More... | |
void | set_enable_undo (bool enable_undo=true) |
If enabled, changes to editable will be saved for undo/redo actions. More... | |
Glib::SignalProxy< void(const Glib::ustring&, int*)> | signal_insert_text () |
Glib::SignalProxy< void(int, int)> | signal_delete_text () |
Glib::SignalProxy< void()> | signal_changed () |
Glib::PropertyProxy< Glib::ustring > | property_text () |
The contents of the entry. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_text () const |
The contents of the entry. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_cursor_position () const |
The current position of the insertion cursor in chars. More... | |
Glib::PropertyProxy< bool > | property_enable_undo () |
If undo/redo should be enabled for the editable. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_enable_undo () const |
If undo/redo should be enabled for the editable. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_selection_bound () const |
The position of the opposite end of the selection from the cursor in chars. More... | |
Glib::PropertyProxy< bool > | property_editable () |
Whether the entry contents can be edited. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_editable () const |
Whether the entry contents can be edited. More... | |
Glib::PropertyProxy< int > | property_width_chars () |
Number of characters to leave space for in the entry. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_width_chars () const |
Number of characters to leave space for in the entry. More... | |
Glib::PropertyProxy< int > | property_max_width_chars () |
The desired maximum width of the entry, in characters. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_max_width_chars () const |
The desired maximum width of the entry, in characters. More... | |
Glib::PropertyProxy< float > | property_xalign () |
The horizontal alignment, from 0 (left) to 1 (right). More... | |
Glib::PropertyProxy_ReadOnly< float > | property_xalign () const |
The horizontal alignment, from 0 (left) to 1 (right). More... | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Static Public Member Functions inherited from Gtk::Widget | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static void | set_default_direction (TextDirection dir) |
Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction(). More... | |
static TextDirection | get_default_direction () |
Obtains the current default reading direction. More... | |
Static Public Member Functions inherited from Gtk::Accessible | |
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... | |
Static Public Member Functions inherited from Gtk::Buildable | |
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... | |
Static Public Member Functions inherited from Gtk::ConstraintTarget | |
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... | |
Static Public Member Functions inherited from Gtk::Editable | |
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... | |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::Text* | wrap (GtkText* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Widget | |
Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Accessible | |
Glib::RefPtr< Gtk::Accessible > | wrap (GtkAccessible* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Buildable | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::ConstraintTarget | |
Glib::RefPtr< Gtk::ConstraintTarget > | wrap (GtkConstraintTarget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Editable | |
Glib::RefPtr< Gtk::Editable > | wrap (GtkEditable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
Public Types inherited from Gtk::Widget | |
using | SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock >&)> |
Callback type for adding a function to update animations. More... | |
Public Types inherited from Glib::Object | |
typedef void(*)(gpointer data | DestroyNotify) |
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 |
Public Types inherited from Gtk::Accessible | |
enum | Role { Role::ALERT, Role::ALERT_DIALOG, Role::BANNER, Role::BUTTON, Role::CAPTION, Role::CELL, Role::CHECKBOX, Role::COLUMN_HEADER, Role::COMBO_BOX, Role::COMMAND, Role::COMPOSITE, Role::DIALOG, Role::DOCUMENT, Role::FEED, Role::FORM, Role::GENERIC, Role::GRID, Role::GRID_CELL, Role::GROUP, Role::HEADING, Role::IMG, Role::INPUT, Role::LABEL, Role::LANDMARK, Role::LEGEND, Role::LINK, Role::LIST, Role::LIST_BOX, Role::LIST_ITEM, Role::LOG, Role::MAIN, Role::MARQUEE, Role::MATH, Role::METER, Role::MENU, Role::MENU_BAR, Role::MENU_ITEM, Role::MENU_ITEM_CHECKBOX, Role::MENU_ITEM_RADIO, Role::NAVIGATION, Role::NONE, Role::NOTE, Role::OPTION, Role::PRESENTATION, Role::PROGRESS_BAR, Role::RADIO, Role::RADIO_GROUP, Role::RANGE, Role::REGION, Role::ROW, Role::ROW_GROUP, Role::ROW_HEADER, Role::SCROLLBAR, Role::SEARCH, Role::SEARCH_BOX, Role::SECTION, Role::SECTION_HEAD, Role::SELECT, Role::SEPARATOR, Role::SLIDER, Role::SPIN_BUTTON, Role::STATUS, Role::STRUCTURE, Role::SWITCH, Role::TAB, Role::TABLE, Role::TAB_LIST, Role::TAB_PANEL, Role::TEXT_BOX, Role::TIME, Role::TIMER, Role::TOOLBAR, Role::TOOLTIP, Role::TREE, Role::TREE_GRID, Role::TREE_ITEM, Role::WIDGET, Role::WINDOW } |
The accessible role for a Gtk::Accessible implementation. More... | |
enum | State { State::BUSY, State::CHECKED, State::DISABLED, State::EXPANDED, State::HIDDEN, State::INVALID, State::PRESSED, State::SELECTED } |
The possible accessible states of a Gtk::Accessible. More... | |
enum | Property { Property::AUTOCOMPLETE, Property::DESCRIPTION, Property::HAS_POPUP, Property::KEY_SHORTCUTS, Property::LABEL, Property::LEVEL, Property::MODAL, Property::MULTI_LINE, Property::MULTI_SELECTABLE, Property::ORIENTATION, Property::PLACEHOLDER, Property::READ_ONLY, Property::REQUIRED, Property::ROLE_DESCRIPTION, Property::SORT, Property::VALUE_MAX, Property::VALUE_MIN, Property::VALUE_NOW, Property::VALUE_TEXT } |
The possible accessible properties of a Gtk::Accessible. More... | |
enum | Relation { Relation::ACTIVE_DESCENDANT, Relation::COL_COUNT, Relation::COL_INDEX, Relation::COL_INDEX_TEXT, Relation::COL_SPAN, Relation::CONTROLS, Relation::DESCRIBED_BY, Relation::DETAILS, Relation::ERROR_MESSAGE, Relation::FLOW_TO, Relation::LABELLED_BY, Relation::OWNS, Relation::POS_IN_SET, Relation::ROW_COUNT, Relation::ROW_INDEX, Relation::ROW_INDEX_TEXT, Relation::ROW_SPAN, Relation::SET_SIZE } |
The possible accessible relations of a Gtk::Accessible. More... | |
Protected Member Functions inherited from Gtk::Widget | |
virtual void | root_vfunc () |
virtual void | unroot_vfunc () |
virtual void | size_allocate_vfunc (int width, int height, int baseline) |
virtual SizeRequestMode | get_request_mode_vfunc () const |
virtual void | measure_vfunc (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
virtual bool | grab_focus_vfunc () |
virtual void | set_focus_child_vfunc (Widget* child) |
Sets the focused child of widget. More... | |
virtual void | compute_expand_vfunc (bool& hexpand_p, bool& vexpand_p) |
virtual bool | contains_vfunc (double x, double y) const |
virtual void | snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
Widget () | |
void | realize () |
Creates the GDK (windowing system) resources associated with a widget. More... | |
void | unrealize () |
This function is only useful in widget implementations. More... | |
void | realize_if_needed () |
void | set_focus_child (Widget& child) |
Set child as the current focus child of widget. More... | |
void | unset_focus_child () |
Unsets the focus child of the widget. More... | |
Widget* | get_focus_child () |
Returns the current focus child of widget. More... | |
const Widget* | get_focus_child () const |
Returns the current focus child of widget. More... | |
virtual void | on_show () |
This is a default handler for the signal signal_show(). More... | |
virtual void | on_hide () |
This is a default handler for the signal signal_hide(). More... | |
virtual void | on_map () |
This is a default handler for the signal signal_map(). More... | |
virtual void | on_unmap () |
This is a default handler for the signal signal_unmap(). More... | |
virtual void | on_realize () |
This is a default handler for the signal signal_realize(). More... | |
virtual void | on_unrealize () |
This is a default handler for the signal signal_unrealize(). More... | |
virtual void | on_state_flags_changed (Gtk::StateFlags previous_state_flags) |
This is a default handler for the signal signal_state_flags_changed(). More... | |
virtual void | on_direction_changed (TextDirection direction) |
This is a default handler for the signal signal_direction_changed(). More... | |
virtual bool | on_mnemonic_activate (bool group_cycling) |
This is a default handler for the signal signal_mnemonic_activate(). More... | |
virtual bool | on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip >& tooltip) |
This is a default handler for the signal signal_query_tooltip(). More... | |
Protected Member Functions inherited from Glib::Object | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
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) |
Protected Member Functions inherited from Gtk::Accessible | |
Accessible () | |
You should derive from this class to use it. More... | |
Protected Member Functions inherited from Gtk::Buildable | |
Buildable () | |
You should derive from this class to use it. More... | |
Protected Member Functions inherited from Gtk::ConstraintTarget | |
ConstraintTarget () | |
You should derive from this class to use it. More... | |
Protected Member Functions inherited from Gtk::Editable | |
Editable () | |
You should derive from this class to use it. More... | |
virtual void | delete_text_vfunc (int start_pos, int end_pos) |
virtual Glib::ustring | get_text_vfunc () const |
virtual void | select_region_vfunc (int start_pos, int end_pos) |
virtual bool | get_selection_bounds_vfunc (int& start_pos, int& end_pos) const |
virtual void | insert_text_vfunc (const Glib::ustring& text, int& position) |
virtual void | on_insert_text (const Glib::ustring& text, int* position) |
This is a default handler for the signal signal_insert_text(). More... | |
virtual void | on_delete_text (int start_pos, int end_pos) |
This is a default handler for the signal signal_delete_text(). More... | |
virtual void | on_changed () |
This is a default handler for the signal signal_changed(). More... | |
Detailed Description
A simple single-line text entry field.
The Gtk::Text widget is a single-line text entry widget. A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.
When using an entry for passwords and other sensitive information, it can be put into “password mode” using set_visibility(). In this mode, entered text is displayed using an “invisible” character. By default, GTK picks the best invisible character that is available in the current font, but it can be changed with set_invisible_char().
If you are looking to add icons or progress display in an entry, look at Gtk::Entry. There are other alternatives for more specialized use cases, such as Gtk::SearchEntry. If you need multi-line editable text, look at Gtk::TextView.
Constructor & Destructor Documentation
|
noexcept |
|
delete |
|
overridenoexcept |
Gtk::Text::Text | ( | ) |
|
explicit |
Member Function Documentation
bool Gtk::Text::get_activates_default | ( | ) | const |
Retrieves the value set by set_activates_default().
- Returns
true
if the self will activate the default widget.
Pango::AttrList Gtk::Text::get_attributes | ( | ) | const |
Gets the attribute list that was set on the self using set_attributes(), if any.
- Returns
- The attribute list, or
nullptr
if none was set.
Glib::RefPtr<EntryBuffer> Gtk::Text::get_buffer | ( | ) |
Get the Gtk::EntryBuffer object which holds the text for this self.
- Returns
- A Gtk::EntryBuffer object.
Glib::RefPtr<const EntryBuffer> Gtk::Text::get_buffer | ( | ) | const |
Get the Gtk::EntryBuffer object which holds the text for this self.
- Returns
- A Gtk::EntryBuffer object.
bool Gtk::Text::get_enable_emoji_completion | ( | ) | const |
Returns whether Emoji completion is enabled for this GtkText widget.
- Returns
true
if Emoji completion is enabled.
Glib::RefPtr<Gio::MenuModel> Gtk::Text::get_extra_menu | ( | ) |
Gets the menu model set with set_extra_menu().
- Returns
- The menu model.
Glib::RefPtr<const Gio::MenuModel> Gtk::Text::get_extra_menu | ( | ) | const |
Gets the menu model set with set_extra_menu().
- Returns
- The menu model.
InputHints Gtk::Text::get_input_hints | ( | ) | const |
Gets the value of the Gtk::Text::property_input_hints() property.
InputPurpose Gtk::Text::get_input_purpose | ( | ) | const |
Gets the value of the Gtk::Text::property_input_purpose() property.
gunichar Gtk::Text::get_invisible_char | ( | ) | const |
Retrieves the character displayed in place of the real characters for entries with visibility set to false.
Note that GTK does not compute this value unless it needs it, so the value returned by this function is not very useful unless it has been explicitly set with set_invisible_char()
- Returns
- The current invisible char, or 0, if text does not show invisible text at all.
int Gtk::Text::get_max_length | ( | ) | const |
Retrieves the maximum allowed length of the text in self.
See set_max_length().
This is equivalent to getting self's Gtk::EntryBuffer and calling Gtk::EntryBuffer::get_max_length() on it.
- Returns
- The maximum allowed number of characters in Gtk::Text, or 0 if there is no maximum.
bool Gtk::Text::get_overwrite_mode | ( | ) | const |
Gets the value set by set_overwrite_mode().
- Returns
- Whether the text is overwritten when typing.
Glib::ustring Gtk::Text::get_placeholder_text | ( | ) | const |
Retrieves the text that will be displayed when self is empty and unfocused.
- Returns
- A pointer to the placeholder text as a string. This string points to internally allocated storage in the widget and must not be freed, modified or stored. If no placeholder text has been set,
nullptr
will be returned.
bool Gtk::Text::get_propagate_text_width | ( | ) | const |
Returns whether the Gtk::Text will grow and shrink with the content.
- Returns
true
if self will propagate the text width.
Pango::TabArray Gtk::Text::get_tabs | ( | ) | const |
Gets the tabstops that were set on the self using set_tabs(), if any.
- Returns
- The tabstops, or
nullptr
if none was set.
guint16 Gtk::Text::get_text_length | ( | ) | const |
Retrieves the current length of the text in self.
This is equivalent to getting self's Gtk::EntryBuffer and calling Gtk::EntryBuffer::get_length() on it.
- Returns
- The current number of characters in Gtk::Text, or 0 if there are none.
bool Gtk::Text::get_truncate_multiline | ( | ) | const |
Returns whether the Gtk::Text will truncate multi-line text that is pasted into the widget.
- Returns
true
if self will truncate multi-line text.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
bool Gtk::Text::get_visibility | ( | ) | const |
Retrieves whether the text in self is visible.
See set_visibility().
- Returns
true
if the text is currently visible.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
bool Gtk::Text::grab_focus_without_selecting | ( | ) |
Causes self to have keyboard focus.
It behaves like Gtk::Widget::grab_focus(), except that it doesn't select the contents of self. You only want to call this on some special entries which the user usually doesn't want to replace all text in, such as search-as-you-type entries.
- Returns
true
if focus is now inside self.
Glib::PropertyProxy< bool > Gtk::Text::property_activates_default | ( | ) |
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Text::property_activates_default | ( | ) | const |
Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Pango::AttrList > Gtk::Text::property_attributes | ( | ) |
A list of Pango attributes to apply to the text of the self.
This is mainly useful to change the size or weight of the text.
The Pango::Attribute's start_index and end_index must refer to the Gtk::EntryBuffer text, i.e. without the preedit string.
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Pango::AttrList > Gtk::Text::property_attributes | ( | ) | const |
A list of Pango attributes to apply to the text of the self.
This is mainly useful to change the size or weight of the text.
The Pango::Attribute's start_index and end_index must refer to the Gtk::EntryBuffer text, i.e. without the preedit string.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::RefPtr<EntryBuffer> > Gtk::Text::property_buffer | ( | ) |
Text buffer object which actually stores self text.
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<EntryBuffer> > Gtk::Text::property_buffer | ( | ) | const |
Text buffer object which actually stores self text.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Text::property_enable_emoji_completion | ( | ) |
Whether to suggest Emoji replacements.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Text::property_enable_emoji_completion | ( | ) | const |
Whether to suggest Emoji replacements.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::RefPtr<Gio::MenuModel> > Gtk::Text::property_extra_menu | ( | ) |
A menu model whose contents will be appended to the context menu.
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::MenuModel> > Gtk::Text::property_extra_menu | ( | ) | const |
A menu model whose contents will be appended to the context menu.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::Text::property_im_module | ( | ) |
Which IM (input method) module should be used for this self.
See Gtk::IMContext.
Setting this to a non-nullptr
value overrides the system-wide IM module setting. See the GtkSettings Gtk::Settings::property_gtk_im_module() property.
Default value: ""
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Text::property_im_module | ( | ) | const |
Which IM (input method) module should be used for this self.
See Gtk::IMContext.
Setting this to a non-nullptr
value overrides the system-wide IM module setting. See the GtkSettings Gtk::Settings::property_gtk_im_module() property.
Default value: ""
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< InputHints > Gtk::Text::property_input_hints | ( | ) |
Additional hints (beyond Gtk::Text::property_input_purpose()) that allow input methods to fine-tune their behaviour.
Default value: Gtk::InputHints::NONE
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< InputHints > Gtk::Text::property_input_hints | ( | ) | const |
Additional hints (beyond Gtk::Text::property_input_purpose()) that allow input methods to fine-tune their behaviour.
Default value: Gtk::InputHints::NONE
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< InputPurpose > Gtk::Text::property_input_purpose | ( | ) |
The purpose of this text field.
This property can be used by on-screen keyboards and other input methods to adjust their behaviour.
Note that setting the purpose to Gtk::InputPurpose::PASSWORD or Gtk::InputPurpose::PIN is independent from setting Gtk::Text::property_visibility().
Default value: Gtk::InputPurpose::FREE_FORM
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< InputPurpose > Gtk::Text::property_input_purpose | ( | ) | const |
The purpose of this text field.
This property can be used by on-screen keyboards and other input methods to adjust their behaviour.
Note that setting the purpose to Gtk::InputPurpose::PASSWORD or Gtk::InputPurpose::PIN is independent from setting Gtk::Text::property_visibility().
Default value: Gtk::InputPurpose::FREE_FORM
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< gunichar > Gtk::Text::property_invisible_char | ( | ) |
The character to use when masking self contents (in “password mode”).
Default value: 42
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< gunichar > Gtk::Text::property_invisible_char | ( | ) | const |
The character to use when masking self contents (in “password mode”).
Default value: 42
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Text::property_invisible_char_set | ( | ) |
Whether the invisible char has been set for the Gtk::Text.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Text::property_invisible_char_set | ( | ) | const |
Whether the invisible char has been set for the Gtk::Text.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::Text::property_max_length | ( | ) |
Maximum number of characters for this self.
Zero if no maximum.
Default value: 0
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::Text::property_max_length | ( | ) | const |
Maximum number of characters for this self.
Zero if no maximum.
Default value: 0
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Text::property_overwrite_mode | ( | ) |
If text is overwritten when typing in the Gtk::Text.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Text::property_overwrite_mode | ( | ) | const |
If text is overwritten when typing in the Gtk::Text.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Gtk::Text::property_placeholder_text | ( | ) |
The text that will be displayed in the Gtk::Text when it is empty and unfocused.
Default value: ""
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Text::property_placeholder_text | ( | ) | const |
The text that will be displayed in the Gtk::Text when it is empty and unfocused.
Default value: ""
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Text::property_propagate_text_width | ( | ) |
Whether the entry should grow and shrink with the content.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Text::property_propagate_text_width | ( | ) | const |
Whether the entry should grow and shrink with the content.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::Text::property_scroll_offset | ( | ) | const |
Number of pixels of the self scrolled off the screen to the left.
Default value: 0
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Pango::TabArray > Gtk::Text::property_tabs | ( | ) |
A list of tabstops to apply to the text of the self.
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Pango::TabArray > Gtk::Text::property_tabs | ( | ) | const |
A list of tabstops to apply to the text of the self.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Text::property_truncate_multiline | ( | ) |
When true
, pasted multi-line text is truncated to the first line.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Text::property_truncate_multiline | ( | ) | const |
When true
, pasted multi-line text is truncated to the first line.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::Text::property_visibility | ( | ) |
false
displays the “invisible char” instead of the actual text (password mode).
Default value: true
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::Text::property_visibility | ( | ) | const |
false
displays the “invisible char” instead of the actual text (password mode).
Default value: true
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::Text::set_activates_default | ( | bool | setting = true | ) |
If setting is true
, pressing Enter in the self will activate the default widget for the window containing the self.
This usually means that the dialog box containing the self will be closed, since the default widget is usually one of the dialog buttons.
- Parameters
-
setting true
to activate window’s default widget on Enter keypress.
void Gtk::Text::set_attributes | ( | Pango::AttrList & | attrs | ) |
Sets a Pango::AttrList; the attributes in the list are applied to the text.
- Parameters
-
attrs A Pango::AttrList or nullptr
to unset.
void Gtk::Text::set_buffer | ( | const Glib::RefPtr< EntryBuffer >& | buffer | ) |
Set the Gtk::EntryBuffer object which holds the text for this widget.
- Parameters
-
buffer A Gtk::EntryBuffer.
void Gtk::Text::set_enable_emoji_completion | ( | bool | enable_emoji_completion = true | ) |
Sets whether Emoji completion is enabled.
If it is, typing ':', followed by a recognized keyword, will pop up a window with suggested Emojis matching the keyword.
- Parameters
-
enable_emoji_completion true
to enable Emoji completion.
void Gtk::Text::set_extra_menu | ( | const Glib::RefPtr< Gio::MenuModel > & | model | ) |
Sets a menu model to add when constructing the context menu for self.
- Parameters
-
model A Gio::MenuModel.
void Gtk::Text::set_input_hints | ( | InputHints | hints | ) |
Sets the Gtk::Text::property_input_hints() property, which allows input methods to fine-tune their behaviour.
- Parameters
-
hints The hints.
void Gtk::Text::set_input_purpose | ( | InputPurpose | purpose | ) |
Sets the Gtk::Text::property_input_purpose() property which can be used by on-screen keyboards and other input methods to adjust their behaviour.
- Parameters
-
purpose The purpose.
void Gtk::Text::set_invisible_char | ( | gunichar | ch | ) |
Sets the character to use in place of the actual text when set_visibility() has been called to set text visibility to false
.
i.e. this is the character used in “password mode” to show the user how many characters have been typed.
By default, GTK picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.
- Parameters
-
ch A Unicode character.
void Gtk::Text::set_max_length | ( | int | max | ) |
Sets the maximum allowed length of the contents of the widget.
If the current contents are longer than the given length, then they will be truncated to fit.
This is equivalent to getting self's Gtk::EntryBuffer and calling Gtk::EntryBuffer::set_max_length() on it. ]|
- Parameters
-
max The maximum length of the self, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536.
void Gtk::Text::set_overwrite_mode | ( | bool | overwrite = true | ) |
Sets whether the text is overwritten when typing in the Gtk::Text.
- Parameters
-
overwrite New value.
void Gtk::Text::set_placeholder_text | ( | const Glib::ustring & | text | ) |
Sets text to be displayed in self when it is empty.
This can be used to give a visual hint of the expected contents of the self.
- Parameters
-
text A string to be displayed when self is empty and unfocused, or nullptr
.
void Gtk::Text::set_propagate_text_width | ( | bool | propagate_text_width = true | ) |
Sets whether the GtkText should grow and shrink with the content.
- Parameters
-
propagate_text_width true
to propagate the text width.
void Gtk::Text::set_tabs | ( | const Pango::TabArray & | tabs | ) |
Sets a Pango::TabArray; the tabstops in the array are applied to the self text.
- Parameters
-
tabs A Pango::TabArray.
void Gtk::Text::set_truncate_multiline | ( | bool | truncate_multiline = true | ) |
Sets whether the GtkText should truncate multi-line text that is pasted into the widget.
- Parameters
-
truncate_multiline true
to truncate multi-line text.
void Gtk::Text::set_visibility | ( | bool | visible = true | ) |
Sets whether the contents of the self are visible or not.
When visibility is set to false
, characters are displayed as the invisible char, and will also appear that way when the text in the self widget is copied to the clipboard.
By default, GTK picks the best invisible character available in the current font, but it can be changed with set_invisible_char().
Note that you probably want to set Gtk::Text::property_input_purpose() to Gtk::InputPurpose::PASSWORD or Gtk::InputPurpose::PIN to inform input methods about the purpose of this self, in addition to setting visibility to false
.
- Parameters
-
visible true
if the contents of the self are displayed as plaintext.
void Gtk::Text::unset_invisible_char | ( | ) |
Unsets the invisible char previously set with set_invisible_char().
So that the default invisible char is used again.
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.