gtkmm 4.18.0
|
A single line text entry field. More...
#include <gtkmm/entry.h>
Public Member Functions | |
Entry (Entry &&src) noexcept | |
Entry & | operator= (Entry &&src) noexcept |
Entry (const Entry &)=delete | |
Entry & | operator= (const Entry &)=delete |
~Entry () noexcept override | |
GtkEntry * | gobj () |
Provides access to the underlying C GObject. | |
const GtkEntry * | gobj () const |
Provides access to the underlying C GObject. | |
Entry () | |
Entry (const Glib::RefPtr< EntryBuffer > &buffer) | |
Glib::RefPtr< EntryBuffer > | get_buffer () |
Get the Gtk::EntryBuffer object which holds the text for this widget. | |
Glib::RefPtr< const EntryBuffer > | get_buffer () const |
Get the Gtk::EntryBuffer object which holds the text for this widget. | |
void | set_buffer (const Glib::RefPtr< EntryBuffer > &buffer) |
Set the Gtk::EntryBuffer object which holds the text for this widget. | |
void | set_visibility (bool visible=true) |
Sets whether the contents of the entry are visible or not. | |
bool | get_visibility () const |
Retrieves whether the text in entry is visible. | |
void | set_invisible_char (gunichar ch) |
Sets the character to use in place of the actual text in “password mode”. | |
void | unset_invisible_char () |
Unsets the invisible char, so that the default invisible char is used again. | |
gunichar | get_invisible_char () const |
Retrieves the character displayed in place of the actual text in “password mode”. | |
void | set_has_frame (bool setting=true) |
Sets whether the entry has a beveled frame around it. | |
bool | get_has_frame () const |
Gets the value set by set_has_frame(). | |
void | set_overwrite_mode (bool overwrite=true) |
Sets whether the text is overwritten when typing in the Gtk::Entry . | |
bool | get_overwrite_mode () const |
Gets whether the Gtk::Entry is in overwrite mode. | |
void | set_max_length (int max) |
Sets the maximum allowed length of the contents of the widget. | |
int | get_max_length () const |
Retrieves the maximum allowed length of the text in entry. | |
guint16 | get_text_length () const |
Retrieves the current length of the text in entry. | |
void | set_activates_default (bool setting=true) |
Sets whether pressing Enter in the entry will activate the default widget for the window containing the entry. | |
gboolean | get_activates_default () const |
Retrieves the value set by set_activates_default(). | |
void | set_alignment (float xalign) |
Sets the alignment for the contents of the entry. | |
void | set_alignment (Align xalign) |
Sets the alignment for the contents of the entry. | |
float | get_alignment () const |
Gets the value set by set_alignment(). | |
void | set_completion (const Glib::RefPtr< EntryCompletion > &completion) |
Sets completion to be the auxiliary completion object to use with entry. | |
Glib::RefPtr< EntryCompletion > | get_completion () |
Returns the auxiliary completion object currently in use by entry. | |
Glib::RefPtr< const EntryCompletion > | get_completion () const |
Returns the auxiliary completion object currently in use by entry. | |
void | set_progress_fraction (double fraction) |
Causes the entry’s progress indicator to “fill in” the given fraction of the bar. | |
double | get_progress_fraction () const |
Returns the current fraction of the task that’s been completed. | |
void | set_progress_pulse_step (double fraction) |
Sets the fraction of total entry width to move the progress bouncing block for each pulse. | |
double | get_progress_pulse_step () |
Retrieves the pulse step set with set_progress_pulse_step(). | |
void | progress_pulse () |
Indicates that some progress is made, but you don’t know how much. | |
Glib::ustring | get_placeholder_text () const |
Retrieves the text that will be displayed when entry is empty and unfocused. | |
void | set_placeholder_text (const Glib::ustring &text) |
Sets text to be displayed in entry when it is empty. | |
void | set_icon_from_paintable (const Glib::RefPtr< Gdk::Paintable > &paintable, IconPosition icon_pos=IconPosition::PRIMARY) |
Sets the icon shown in the specified position using a Gdk::Paintable . | |
void | set_icon_from_icon_name (const Glib::ustring &icon_name, IconPosition icon_pos=IconPosition::PRIMARY) |
Sets the icon shown in the entry at the specified position from the current icon theme. | |
void | set_icon_from_gicon (const Glib::RefPtr< Gio::Icon > &icon, IconPosition icon_pos=IconPosition::PRIMARY) |
Sets the icon shown in the entry at the specified position from the current icon theme. | |
void | unset_icon (IconPosition icon_pos=IconPosition::PRIMARY) |
Do not show any icon in the specified position. | |
Image::Type | get_icon_storage_type (IconPosition icon_pos=IconPosition::PRIMARY) const |
Gets the type of representation being used by the icon to store image data. | |
Glib::RefPtr< Gdk::Paintable > | get_icon_paintable (IconPosition icon_pos=IconPosition::PRIMARY) |
Retrieves the Gdk::Paintable used for the icon. | |
Glib::RefPtr< const Gdk::Paintable > | get_icon_paintable (IconPosition icon_pos=IconPosition::PRIMARY) const |
Retrieves the Gdk::Paintable used for the icon. | |
Glib::ustring | get_icon_name (IconPosition icon_pos=IconPosition::PRIMARY) const |
Retrieves the icon name used for the icon. | |
Glib::RefPtr< Gio::Icon > | get_icon_gicon (IconPosition icon_pos=IconPosition::PRIMARY) |
Retrieves the Gio::Icon used for the icon. | |
Glib::RefPtr< const Gio::Icon > | get_icon_gicon (IconPosition icon_pos=IconPosition::PRIMARY) const |
Retrieves the Gio::Icon used for the icon. | |
void | set_icon_activatable (bool activatable=true, IconPosition icon_pos=IconPosition::PRIMARY) |
Sets whether the icon is activatable. | |
bool | get_icon_activatable (IconPosition icon_pos=IconPosition::PRIMARY) const |
Returns whether the icon is activatable. | |
void | set_icon_sensitive (IconPosition icon_pos=IconPosition::PRIMARY, bool sensitive=true) |
Sets the sensitivity for the specified icon. | |
bool | get_icon_sensitive (IconPosition icon_pos=IconPosition::PRIMARY) |
Returns whether the icon appears sensitive or insensitive. | |
int | get_icon_at_pos (int x, int y) const |
Finds the icon at the given position and return its index. | |
void | set_icon_tooltip_text (const Glib::ustring &tooltip, IconPosition icon_pos=IconPosition::PRIMARY) |
Sets tooltip as the contents of the tooltip for the icon at the specified position. | |
Glib::ustring | get_icon_tooltip_text (IconPosition icon_pos=IconPosition::PRIMARY) const |
Gets the contents of the tooltip on the icon at the specified position in entry. | |
void | set_icon_tooltip_markup (const Glib::ustring &tooltip, IconPosition icon_pos=IconPosition::PRIMARY) |
Sets tooltip as the contents of the tooltip for the icon at the specified position. | |
Glib::ustring | get_icon_tooltip_markup (IconPosition icon_pos=IconPosition::PRIMARY) const |
Gets the contents of the tooltip on the icon at the specified position in entry. | |
void | set_icon_drag_source (const Glib::RefPtr< Gdk::ContentProvider > &provider, Gdk::DragAction actions=Gdk::DragAction::COPY, IconPosition icon_pos=IconPosition::PRIMARY) |
Sets up the icon at the given position as drag source. | |
Gdk::Rectangle | get_icon_area (IconPosition icon_pos=IconPosition::PRIMARY) const |
Returns the area where entry's icon at icon_pos is drawn. | |
int | get_current_icon_drag_source () |
Returns the index of the icon which is the source of the current DND operation, or -1. | |
void | reset_im_context () |
Reset the input method context of the entry if needed. | |
void | set_input_purpose (InputPurpose purpose) |
Sets the input purpose which can be used by input methods to adjust their behavior. | |
InputPurpose | get_input_purpose () const |
Gets the input purpose of the Gtk::Entry . | |
void | set_input_hints (InputHints hints) |
Set additional hints which allow input methods to fine-tune their behavior. | |
InputHints | get_input_hints () const |
Gets the input hints of this Gtk::Entry . | |
void | set_attributes (Pango::AttrList &attrs) |
Sets a Pango::AttrList . | |
Pango::AttrList | get_attributes () const |
Gets the attribute list of the Gtk::Entry . | |
void | set_tabs (const Pango::TabArray &tabs) |
Sets a Pango::TabArray . | |
Pango::TabArray | get_tabs () const |
Gets the tabstops of the Gtk::Entry . | |
void | grab_focus_without_selecting () |
Causes entry to have keyboard focus. | |
void | set_extra_menu (const Glib::RefPtr< Gio::MenuModel > &model) |
Sets a menu model to add when constructing the context menu for entry. | |
Glib::RefPtr< Gio::MenuModel > | get_extra_menu () |
Gets the menu model set with set_extra_menu(). | |
Glib::RefPtr< const Gio::MenuModel > | get_extra_menu () const |
Gets the menu model set with set_extra_menu(). | |
Glib::SignalProxy< void()> | signal_activate () |
Glib::SignalProxy< void(IconPosition)> | signal_icon_release () |
Glib::SignalProxy< void(IconPosition)> | signal_icon_press () |
Glib::PropertyProxy< Glib::RefPtr< EntryBuffer > > | property_buffer () |
The buffer object which actually stores the text. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< EntryBuffer > > | property_buffer () const |
The buffer object which actually stores the text. | |
Glib::PropertyProxy< int > | property_max_length () |
Maximum number of characters for this entry. | |
Glib::PropertyProxy_ReadOnly< int > | property_max_length () const |
Maximum number of characters for this entry. | |
Glib::PropertyProxy< bool > | property_visibility () |
Whether the entry should show the “invisible char” instead of the actual text (“password mode”). | |
Glib::PropertyProxy_ReadOnly< bool > | property_visibility () const |
Whether the entry should show the “invisible char” instead of the actual text (“password mode”). | |
Glib::PropertyProxy< bool > | property_has_frame () |
Whether the entry should draw a frame. | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_frame () const |
Whether the entry should draw a frame. | |
Glib::PropertyProxy< gunichar > | property_invisible_char () |
The character to use when masking entry contents (“password mode”). | |
Glib::PropertyProxy_ReadOnly< gunichar > | property_invisible_char () const |
The character to use when masking entry contents (“password mode”). | |
Glib::PropertyProxy< bool > | property_invisible_char_set () |
Whether the invisible char has been set for the Gtk::Entry . | |
Glib::PropertyProxy_ReadOnly< bool > | property_invisible_char_set () const |
Whether the invisible char has been set for the Gtk::Entry . | |
Glib::PropertyProxy< bool > | property_activates_default () |
Whether to activate the default widget when Enter is pressed. | |
Glib::PropertyProxy_ReadOnly< bool > | property_activates_default () const |
Whether to activate the default widget when Enter is pressed. | |
Glib::PropertyProxy_ReadOnly< int > | property_scroll_offset () const |
Number of pixels of the entry scrolled off the screen to the left. | |
Glib::PropertyProxy< bool > | property_truncate_multiline () |
When true , pasted multi-line text is truncated to the first line. | |
Glib::PropertyProxy_ReadOnly< bool > | property_truncate_multiline () const |
When true , pasted multi-line text is truncated to the first line. | |
Glib::PropertyProxy< bool > | property_overwrite_mode () |
If text is overwritten when typing in the Gtk::Entry . | |
Glib::PropertyProxy_ReadOnly< bool > | property_overwrite_mode () const |
If text is overwritten when typing in the Gtk::Entry . | |
Glib::PropertyProxy_ReadOnly< guint > | property_text_length () const |
The length of the text in the Gtk::Entry . | |
Glib::PropertyProxy< double > | property_progress_fraction () |
The current fraction of the task that's been completed. | |
Glib::PropertyProxy_ReadOnly< double > | property_progress_fraction () const |
The current fraction of the task that's been completed. | |
Glib::PropertyProxy< double > | property_progress_pulse_step () |
The fraction of total entry width to move the progress bouncing block for each pulse. | |
Glib::PropertyProxy_ReadOnly< double > | property_progress_pulse_step () const |
The fraction of total entry width to move the progress bouncing block for each pulse. | |
Glib::PropertyProxy< Glib::RefPtr< Gdk::Paintable > > | property_primary_icon_paintable () |
A Gdk::Paintable to use as the primary icon for the entry. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Paintable > > | property_primary_icon_paintable () const |
A Gdk::Paintable to use as the primary icon for the entry. | |
Glib::PropertyProxy< Glib::RefPtr< Gdk::Paintable > > | property_secondary_icon_paintable () |
A Gdk::Paintable to use as the secondary icon for the entry. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Paintable > > | property_secondary_icon_paintable () const |
A Gdk::Paintable to use as the secondary icon for the entry. | |
Glib::PropertyProxy< Glib::ustring > | property_primary_icon_name () |
The icon name to use for the primary icon for the entry. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_primary_icon_name () const |
The icon name to use for the primary icon for the entry. | |
Glib::PropertyProxy< Glib::ustring > | property_secondary_icon_name () |
The icon name to use for the secondary icon for the entry. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_secondary_icon_name () const |
The icon name to use for the secondary icon for the entry. | |
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > | property_primary_icon_gicon () |
The Gio::Icon to use for the primary icon for the entry. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > | property_primary_icon_gicon () const |
The Gio::Icon to use for the primary icon for the entry. | |
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > | property_secondary_icon_gicon () |
The Gio::Icon to use for the secondary icon for the entry. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > | property_secondary_icon_gicon () const |
The Gio::Icon to use for the secondary icon for the entry. | |
Glib::PropertyProxy_ReadOnly< Image::Type > | property_primary_icon_storage_type () const |
The representation which is used for the primary icon of the entry. | |
Glib::PropertyProxy_ReadOnly< Image::Type > | property_secondary_icon_storage_type () const |
The representation which is used for the secondary icon of the entry. | |
Glib::PropertyProxy< bool > | property_primary_icon_activatable () |
Whether the primary icon is activatable. | |
Glib::PropertyProxy_ReadOnly< bool > | property_primary_icon_activatable () const |
Whether the primary icon is activatable. | |
Glib::PropertyProxy< bool > | property_secondary_icon_activatable () |
Whether the secondary icon is activatable. | |
Glib::PropertyProxy_ReadOnly< bool > | property_secondary_icon_activatable () const |
Whether the secondary icon is activatable. | |
Glib::PropertyProxy< bool > | property_primary_icon_sensitive () |
Whether the primary icon is sensitive. | |
Glib::PropertyProxy_ReadOnly< bool > | property_primary_icon_sensitive () const |
Whether the primary icon is sensitive. | |
Glib::PropertyProxy< bool > | property_secondary_icon_sensitive () |
Whether the secondary icon is sensitive. | |
Glib::PropertyProxy_ReadOnly< bool > | property_secondary_icon_sensitive () const |
Whether the secondary icon is sensitive. | |
Glib::PropertyProxy< bool > | property_primary_icon_tooltip_text () |
The contents of the tooltip on the primary icon. | |
Glib::PropertyProxy_ReadOnly< bool > | property_primary_icon_tooltip_text () const |
The contents of the tooltip on the primary icon. | |
Glib::PropertyProxy< bool > | property_secondary_icon_tooltip_text () |
The contents of the tooltip on the secondary icon. | |
Glib::PropertyProxy_ReadOnly< bool > | property_secondary_icon_tooltip_text () const |
The contents of the tooltip on the secondary icon. | |
Glib::PropertyProxy< bool > | property_primary_icon_tooltip_markup () |
The contents of the tooltip on the primary icon, with markup. | |
Glib::PropertyProxy_ReadOnly< bool > | property_primary_icon_tooltip_markup () const |
The contents of the tooltip on the primary icon, with markup. | |
Glib::PropertyProxy< bool > | property_secondary_icon_tooltip_markup () |
The contents of the tooltip on the secondary icon, with markup. | |
Glib::PropertyProxy_ReadOnly< bool > | property_secondary_icon_tooltip_markup () const |
The contents of the tooltip on the secondary icon, with markup. | |
Glib::PropertyProxy< Glib::ustring > | property_im_module () |
Which IM (input method) module should be used for this entry. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_im_module () const |
Which IM (input method) module should be used for this entry. | |
Glib::PropertyProxy< Glib::ustring > | property_placeholder_text () |
The text that will be displayed in the Gtk::Entry when it is empty and unfocused. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_placeholder_text () const |
The text that will be displayed in the Gtk::Entry when it is empty and unfocused. | |
Glib::PropertyProxy< Glib::RefPtr< EntryCompletion > > | property_completion () |
The auxiliary completion object to use with the entry. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< EntryCompletion > > | property_completion () const |
The auxiliary completion object to use with the entry. | |
Glib::PropertyProxy< InputPurpose > | property_input_purpose () |
The purpose of this text field. | |
Glib::PropertyProxy_ReadOnly< InputPurpose > | property_input_purpose () const |
The purpose of this text field. | |
Glib::PropertyProxy< InputHints > | property_input_hints () |
Additional hints that allow input methods to fine-tune their behavior. | |
Glib::PropertyProxy_ReadOnly< InputHints > | property_input_hints () const |
Additional hints that allow input methods to fine-tune their behavior. | |
Glib::PropertyProxy< Pango::AttrList > | property_attributes () |
A list of Pango attributes to apply to the text of the entry. | |
Glib::PropertyProxy_ReadOnly< Pango::AttrList > | property_attributes () const |
A list of Pango attributes to apply to the text of the entry. | |
Glib::PropertyProxy< Pango::TabArray > | property_tabs () |
A list of tabstops to apply to the text of the entry. | |
Glib::PropertyProxy_ReadOnly< Pango::TabArray > | property_tabs () const |
A list of tabstops to apply to the text of the entry. | |
Glib::PropertyProxy< Glib::RefPtr< Gio::MenuModel > > | property_extra_menu () |
A menu model whose contents will be appended to the context menu. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::MenuModel > > | property_extra_menu () const |
A menu model whose contents will be appended to the context menu. | |
Glib::PropertyProxy< bool > | property_show_emoji_icon () |
Whether the entry will show an Emoji icon in the secondary icon position to open the Emoji chooser. | |
Glib::PropertyProxy_ReadOnly< bool > | property_show_emoji_icon () const |
Whether the entry will show an Emoji icon in the secondary icon position to open the Emoji chooser. | |
Glib::PropertyProxy< bool > | property_enable_emoji_completion () |
Whether to suggest Emoji replacements for :-delimited names like :heart: . | |
Glib::PropertyProxy_ReadOnly< bool > | property_enable_emoji_completion () const |
Whether to suggest Emoji replacements for :-delimited names like :heart: . | |
![]() | |
Widget (Widget &&src) noexcept | |
Widget & | operator= (Widget &&src) noexcept |
Widget (const Widget &)=delete | |
Widget & | operator= (const Widget &)=delete |
~Widget () noexcept override | |
Destroys the widget. | |
GtkWidget * | gobj () |
Provides access to the underlying C GObject. | |
const GtkWidget * | gobj () const |
Provides access to the underlying C GObject. | |
Glib::RefPtr< ConstraintTarget > | make_refptr_constrainttarget () |
Converts this widget to a reference counted Gtk::ConstraintTarget. | |
Glib::RefPtr< const ConstraintTarget > | make_refptr_constrainttarget () const |
Converts this widget to a reference counted Gtk::ConstraintTarget. | |
void | show () |
Flags a widget to be displayed. | |
void | hide () |
Reverses the effects of [method.Gtk.Widget.show]. | |
void | queue_draw () |
Schedules this widget to be redrawn. | |
void | queue_resize () |
Flags a widget to have its size renegotiated. | |
void | queue_allocate () |
Flags the widget for a rerun of the size_allocate_vfunc() function. | |
void | size_allocate (const Allocation &allocation, int baseline) |
Allocates widget with a transformation that translates the origin to the position in allocation. | |
SizeRequestMode | get_request_mode () const |
Gets whether the widget prefers a height-for-width layout or a width-for-height layout. | |
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. | |
Measurements | measure (Orientation orientation, int for_size=-1) const |
Like the other overload of measure() but returns a structure holding the sizes/baselines instead of using output parameters. | |
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. | |
PreferredSize | get_preferred_size () const |
Like the other overload of get_preferred_size() but returns a structure holding the sizes instead of using output parameters. | |
void | set_layout_manager (const Glib::RefPtr< LayoutManager > &layout_manager) |
Sets the layout manager to use for measuring and allocating children of the widget. | |
void | unset_layout_manager () |
Undoes the effect of a previous call to set_layout_manager(). | |
Glib::RefPtr< LayoutManager > | get_layout_manager () |
Retrieves the layout manager of the widget. | |
Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
Retrieves the layout manager of the widget. | |
bool | mnemonic_activate (bool group_cycling) |
Emits the signal_mnemonic_activate() signal. | |
bool | activate () |
For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. | |
void | set_can_focus (bool can_focus=true) |
Sets whether the input focus can enter the widget or any of its children. | |
bool | get_can_focus () const |
Determines whether the input focus can enter the widget or any of its children. | |
void | set_focusable (bool focusable=true) |
Sets whether the widget can own the input focus. | |
bool | get_focusable () const |
Determines whether the widget can own the input focus. | |
bool | has_focus () const |
Determines if the widget has the global input focus. | |
bool | is_focus () const |
Determines if the widget is the focus widget within its toplevel. | |
bool | has_visible_focus () const |
Determines if the widget should show a visible indication that it has the global input focus. | |
bool | grab_focus () |
Causes widget to have the keyboard focus for the window that it belongs to. | |
void | set_focus_on_click (bool focus_on_click=true) |
Sets whether the widget should grab focus when it is clicked with the mouse. | |
bool | get_focus_on_click () const |
Returns whether the widget should grab focus when it is clicked with the mouse. | |
void | set_can_target (bool can_target=true) |
Sets whether the widget can be the target of pointer events. | |
bool | get_can_target () const |
Queries whether the widget can be the target of pointer events. | |
bool | has_default () const |
Determines whether the widget is the current default widget within its toplevel. | |
void | set_receives_default (bool receives_default=true) |
Sets whether the widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. | |
bool | get_receives_default () const |
Determines whether the widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. | |
void | set_name (const Glib::ustring & name) |
Sets a widgets name. | |
void | unset_name () |
Glib::ustring | get_name () const |
Retrieves the name of a widget. | |
void | set_state_flags (StateFlags flags, bool clear=true) |
Turns on flag values in the current widget state. | |
void | unset_state_flags (StateFlags flags) |
Turns off flag values for the current widget state. | |
StateFlags | get_state_flags () const |
Returns the widget state as a flag set. | |
void | set_sensitive (bool sensitive=true) |
Sets the sensitivity of the widget. | |
bool | get_sensitive () const |
Returns the widget’s sensitivity. | |
bool | is_sensitive () const |
Returns the widget’s effective sensitivity. | |
void | set_visible (bool visible=true) |
Sets the visibility state of widget. | |
bool | get_visible () const |
Determines whether the widget is visible. | |
bool | is_visible () const |
Determines whether the widget and all its parents are marked as visible. | |
bool | is_drawable () const |
Determines whether the widget can be drawn to. | |
bool | get_realized () const |
Determines whether the widget is realized. | |
bool | get_mapped () const |
Returns whether the widget is mapped. | |
void | set_child_visible (bool visible=true) |
Sets whether the widget should be mapped along with its parent. | |
bool | get_child_visible () const |
Gets the value set with set_child_visible(). | |
int | get_allocated_width () const |
Returns the width that has currently been allocated to the widget. | |
int | get_allocated_height () const |
Returns the height that has currently been allocated to the widget. | |
int | get_allocated_baseline () const |
Returns the baseline that has currently been allocated to the widget. | |
Allocation | get_allocation () const |
Retrieves the widget’s location. | |
std::optional< Gdk::Graphene::Rect > | compute_bounds (const Widget & target) const |
Computes the bounds for the widget in the coordinate space of target. | |
std::optional< Gdk::Graphene::Point > | compute_point (const Widget & target, const Gdk::Graphene::Point &point) const |
Translates the given point in the widget's coordinates to coordinates relative to target’s coordinate system. | |
int | get_width () const |
Returns the content width of the widget. | |
int | get_height () const |
Returns the content height of the widget. | |
int | get_baseline () const |
Returns the baseline that has currently been allocated to the widget. | |
int | get_size (Orientation orientation) const |
Returns the content width or height of the widget. | |
Widget * | get_parent () |
Returns the parent widget of the widget. | |
const Widget * | get_parent () const |
Returns the parent widget of the widget. | |
Root * | get_root () |
Returns the Gtk::Root widget of the widget. | |
const Root * | get_root () const |
Returns the Gtk::Root widget of the widget. | |
Native * | get_native () |
Returns the nearest Gtk::Native ancestor of the widget. | |
const Native * | get_native () const |
Returns the nearest Gtk::Native ancestor of the widget. | |
bool | child_focus (DirectionType direction) |
Called by widgets as the user moves around the window using keyboard shortcuts. | |
bool | keynav_failed (DirectionType direction) |
Emits the signal_keynav_failed() signal on the widget. | |
void | error_bell () |
Notifies the user about an input-related error on the widget. | |
void | set_size_request (int width=-1, int height=-1) |
Sets the minimum size of the widget. | |
void | get_size_request (int & width, int &height) const |
Gets the size request that was explicitly set for the widget. | |
Requisition | get_size_request () const |
Like the other overload of get_size_request() but returns a structure holding the sizes instead of using output parameters. | |
void | set_opacity (double opacity) |
Requests the widget to be rendered partially transparent. | |
double | get_opacity () const |
Fetches the requested opacity for the widget. | |
void | set_overflow (Overflow overflow) |
Sets how the widget treats content that is drawn outside the it's content area. | |
Overflow | get_overflow () const |
Returns the widget’s overflow value. | |
Widget * | get_ancestor (GType widget_type) |
Gets the first ancestor of the widget with type widget_type. | |
const Widget * | get_ancestor (GType widget_type) const |
Gets the first ancestor of the widget with type widget_type. | |
int | get_scale_factor () const |
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. | |
Glib::RefPtr< Gdk::Display > | get_display () |
Get the display for the window that the widget belongs to. | |
Glib::RefPtr< const Gdk::Display > | get_display () const |
Get the display for the window that the widget belongs to. | |
Glib::RefPtr< Settings > | get_settings () |
Gets the settings object holding the settings used for the widget. | |
Glib::RefPtr< Gdk::Clipboard > | get_clipboard () |
Gets the clipboard object for the widget. | |
Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
Gets the clipboard object for the widget. | |
Glib::RefPtr< Gdk::Clipboard > | get_primary_clipboard () |
Gets the primary clipboard of the widget. | |
Glib::RefPtr< const Gdk::Clipboard > | get_primary_clipboard () const |
Gets the primary clipboard of the widget. | |
bool | get_hexpand () const |
Gets whether the widget would like any available extra horizontal space. | |
void | set_hexpand (bool expand=true) |
Sets whether the widget would like any available extra horizontal space. | |
bool | get_hexpand_set () const |
Gets whether the hexpand flag has been explicitly set. | |
void | set_hexpand_set (bool set=true) |
Sets whether the hexpand flag will be used. | |
bool | get_vexpand () const |
Gets whether the widget would like any available extra vertical space. | |
void | set_vexpand (bool expand=true) |
Sets whether the widget would like any available extra vertical space. | |
bool | get_vexpand_set () const |
Gets whether the vexpand flag has been explicitly set. | |
void | set_vexpand_set (bool set=true) |
Sets whether the vexpand flag will be used. | |
bool | compute_expand (Orientation orientation) |
Computes whether a parent widget should give this widget extra space when possible. | |
void | set_expand (bool expand=true) |
Sets whether the widget would like any available extra space in both directions. | |
Align | get_halign () const |
Gets the horizontal alignment of the widget. | |
void | set_halign (Align align) |
Sets the horizontal alignment of the widget. | |
Align | get_valign () const |
Gets the vertical alignment of the widget. | |
void | set_valign (Align align) |
Sets the vertical alignment of the widget. | |
int | get_margin_start () const |
Gets the start margin of the widget. | |
void | set_margin_start (int margin) |
Sets the start margin of the widget. | |
int | get_margin_end () const |
Gets the end margin of the widget. | |
void | set_margin_end (int margin) |
Sets the end margin of the widget. | |
int | get_margin_top () const |
Gets the top margin of the widget. | |
void | set_margin_top (int margin) |
Sets the top margin of the widget. | |
int | get_margin_bottom () const |
Gets the bottom margin of the widget. | |
void | set_margin_bottom (int margin) |
Sets the bottom margin of the widget. | |
void | set_margin (int margin) |
Set all 4 margins to the same value. | |
bool | is_ancestor (Widget &ancestor) const |
Determines whether the widget is a descendent of ancestor. | |
bool | translate_coordinates (Widget &dest_widget, double src_x, double src_y, double &dest_x, double &dest_y) |
Translates coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. | |
bool | contains (double x, double y) const |
Tests if a given point is contained in the widget. | |
Widget * | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) |
Finds the descendant of the widget closest to a point. | |
const Widget * | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const |
Finds the descendant of the widget closest to a point. | |
void | add_controller (const Glib::RefPtr< EventController > &controller) |
Adds an event controller to the widget. | |
void | remove_controller (const Glib::RefPtr< EventController > &controller) |
Removes an event controller from the widget. | |
Glib::RefPtr< Pango::Context > | create_pango_context () |
Creates a new Pango::Context that is configured for the widget. | |
Glib::RefPtr< Pango::Context > | get_pango_context () |
Gets a Pango::Context that is configured for the widget. | |
void | set_font_options (const Cairo::FontOptions &options) |
Sets the cairo_font_options_t used for text rendering in the widget. | |
void | unset_font_options () |
Undoes the effect of previous calls to set_font_options(). | |
Cairo::FontOptions | get_font_options () const |
Returns the cairo_font_options_t of the widget. | |
Glib::RefPtr< Pango::Layout > | create_pango_layout (const Glib::ustring &text) |
Creates a new Pango::Layout that is configured for the widget. | |
void | set_direction (TextDirection dir) |
Sets the reading direction on the widget. | |
TextDirection | get_direction () const |
Gets the reading direction for the widget. | |
void | set_cursor (const Glib::RefPtr< Gdk::Cursor > &cursor) |
Sets the cursor to be shown when the pointer hovers over the widget. | |
void | set_cursor (const Glib::ustring & name={}) |
Sets a named cursor to be shown when pointer devices point towards the widget. | |
Glib::RefPtr< Gdk::Cursor > | get_cursor () |
Gets the cursor set on the widget. | |
Glib::RefPtr< const Gdk::Cursor > | get_cursor () const |
Gets the cursor set on the widget. | |
std::vector< Widget * > | list_mnemonic_labels () |
Returns the widgets for which this widget is the target of a mnemonic. | |
std::vector< const Widget * > | list_mnemonic_labels () const |
Returns the widgets for which this widget is the target of a mnemonic. | |
void | add_mnemonic_label (Widget &label) |
Adds a widget to the list of mnemonic labels for this widget. | |
void | remove_mnemonic_label (Widget &label) |
Removes a widget from the list of mnemonic labels for this widget. | |
bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
Checks to see if a drag movement has passed the GTK drag threshold. | |
Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
Obtains the frame clock for a widget. | |
Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
Obtains the frame clock for a widget. | |
void | set_parent (Widget & parent) |
Sets the parent widget of the widget. | |
void | unparent () |
Removes widget from its parent. | |
void | map () |
Causes a widget to be mapped if it isn’t already. | |
void | unmap () |
Causes a widget to be unmapped if it’s currently mapped. | |
void | trigger_tooltip_query () |
Triggers a tooltip query on the display of the widget. | |
void | set_tooltip_text (const Glib::ustring &text) |
Sets the contents of the tooltip for the widget. | |
Glib::ustring | get_tooltip_text () const |
Gets the contents of the tooltip for the widget. | |
void | set_tooltip_markup (const Glib::ustring &markup) |
Sets the contents of the tooltip for widget. | |
Glib::ustring | get_tooltip_markup () const |
Gets the contents of the tooltip for the widget. | |
void | set_has_tooltip (bool has_tooltip=TRUE) |
Sets the has-tooltip property on the widget. | |
bool | get_has_tooltip () const |
Returns the current value of the has-tooltip property. | |
bool | in_destruction () const |
Returns whether the widget is currently being destroyed. | |
Glib::RefPtr< StyleContext > | get_style_context () |
Returns the style context associated to the widget. | |
Glib::RefPtr< const StyleContext > | get_style_context () const |
Returns the style context associated to the widget. | |
guint | add_tick_callback (const SlotTick & slot) |
Queues an animation frame update and adds a callback to be called before each frame. | |
void | remove_tick_callback (guint id) |
Removes a tick callback previously registered with add_tick_callback(). | |
void | insert_action_group (const Glib::ustring & name, const Glib::RefPtr< Gio::ActionGroup > & group) |
Inserts an action group into the widget's actions. | |
void | remove_action_group (const Glib::ustring & name) |
Removes a group from the widget. | |
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. | |
void | activate_default () |
Activates the default.activate action for the widget. | |
void | set_font_map (const Glib::RefPtr< Pango::FontMap > &font_map) |
Sets the font map to use for text rendering in the widget. | |
Glib::RefPtr< Pango::FontMap > | get_font_map () |
Gets the font map of the widget. | |
Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
Gets the font map of the widget. | |
Widget * | get_first_child () |
Returns the widget’s first child. | |
const Widget * | get_first_child () const |
Returns the widget’s first child. | |
Widget * | get_last_child () |
Returns the widget’s last child. | |
const Widget * | get_last_child () const |
Returns the widget’s last child. | |
Widget * | get_next_sibling () |
Returns the widget’s next sibling. | |
const Widget * | get_next_sibling () const |
Returns the widget’s next sibling. | |
Widget * | get_prev_sibling () |
Returns the widget’s previous sibling. | |
const Widget * | get_prev_sibling () const |
Returns the widget’s previous sibling. | |
std::vector< Widget * > | get_children () |
Gets a vector of the widgetʼs current children, from first child to last. | |
std::vector< const Widget * > | get_children () const |
Gets a vector of the widgetʼs current children, from first child to last. | |
Glib::RefPtr< Gio::ListModel > | observe_children () |
Returns a list model to track the children of the widget. | |
Glib::RefPtr< const Gio::ListModel > | observe_children () const |
Returns a list model to track the children of the widget. | |
Glib::RefPtr< Gio::ListModel > | observe_controllers () |
Returns a list model to track the event controllers of the widget. | |
Glib::RefPtr< const Gio::ListModel > | observe_controllers () const |
Returns a list model to track the event controllers of the widget. | |
void | insert_after (Widget & parent, const Widget &previous_sibling) |
Inserts the Widget into the child widget list of parent after previous_sibling. | |
void | insert_before (Widget & parent, const Widget & next_sibling) |
Inserts the Widget into the child widget list of parent before next_sibling. | |
void | insert_at_start (Widget & parent) |
Inserts the Widget at the beginning of the child widget list of parent. | |
void | insert_at_end (Widget & parent) |
Inserts the Widget at the end of the child widget list of parent. | |
void | snapshot_child (Widget &child, const Glib::RefPtr< Gtk::Snapshot > & snapshot) |
Snapshots a child of the widget. | |
bool | should_layout () const |
Returns whether the widget should contribute to the measuring and allocation of its parent. | |
Glib::ustring | get_css_name () const |
Returns the CSS name of the widget. | |
void | add_css_class (const Glib::ustring &css_class) |
Adds a style class to the widget. | |
void | remove_css_class (const Glib::ustring &css_class) |
Removes a style from the widget. | |
bool | has_css_class (const Glib::ustring &css_class) const |
Returns whether a style class is currently applied to the widget. | |
std::vector< Glib::ustring > | get_css_classes () const |
Returns the list of style classes applied to the widget. | |
void | set_css_classes (const std::vector< Glib::ustring > &classes) |
Replaces the current style classes of the widget with classes. | |
Gdk::RGBA | get_color () const |
Gets the current foreground color for the widget's CSS style. | |
void | set_limit_events (bool limit_events=true) |
Sets whether the widget acts like a modal dialog, with respect to event delivery. | |
bool | get_limit_events () const |
Gets the value of the property_limit_events() property. | |
Glib::SignalProxy< void()> | signal_show () |
Glib::SignalProxy< void()> | signal_hide () |
Glib::SignalProxy< void()> | signal_map () |
Emitted on mapping of a widget to the screen. | |
Glib::SignalProxy< void()> | signal_unmap () |
Glib::SignalProxy< void()> | signal_realize () |
Emitted on realization of a widget. | |
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< void()> | signal_destroy () |
Emitted during the dispose phase. | |
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip > &)> | signal_query_tooltip () |
Glib::PropertyProxy< Glib::ustring > | property_name () |
The name of the widget. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
The name of the widget. | |
Glib::PropertyProxy_ReadOnly< Widget * > | property_parent () const |
The parent widget of this widget. | |
Glib::PropertyProxy_ReadOnly< Root * > | property_root () const |
The Gtk::Root widget of the widget tree containing this widget. | |
Glib::PropertyProxy< int > | property_width_request () |
Overrides for width request of the widget. | |
Glib::PropertyProxy_ReadOnly< int > | property_width_request () const |
Overrides for width request of the widget. | |
Glib::PropertyProxy< int > | property_height_request () |
Overrides for height request of the widget. | |
Glib::PropertyProxy_ReadOnly< int > | property_height_request () const |
Overrides for height request of the widget. | |
Glib::PropertyProxy< bool > | property_visible () |
Whether the widget is visible. | |
Glib::PropertyProxy_ReadOnly< bool > | property_visible () const |
Whether the widget is visible. | |
Glib::PropertyProxy< bool > | property_sensitive () |
Whether the widget responds to input. | |
Glib::PropertyProxy_ReadOnly< bool > | property_sensitive () const |
Whether the widget responds to input. | |
Glib::PropertyProxy< bool > | property_can_focus () |
Whether the widget or any of its descendents can accept the input focus. | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_focus () const |
Whether the widget or any of its descendents can accept the input focus. | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_focus () const |
Whether the widget has the input focus. | |
Glib::PropertyProxy< bool > | property_can_target () |
Whether the widget can receive pointer events. | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_target () const |
Whether the widget can receive pointer events. | |
Glib::PropertyProxy< bool > | property_focus_on_click () |
Whether the widget should grab focus when it is clicked with the mouse. | |
Glib::PropertyProxy_ReadOnly< bool > | property_focus_on_click () const |
Whether the widget should grab focus when it is clicked with the mouse. | |
Glib::PropertyProxy< bool > | property_focusable () |
Whether this widget itself will accept the input focus. | |
Glib::PropertyProxy_ReadOnly< bool > | property_focusable () const |
Whether this widget itself will accept the input focus. | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_default () const |
Whether the widget is the default widget. | |
Glib::PropertyProxy< bool > | property_receives_default () |
Whether the widget will receive the default action when it is focused. | |
Glib::PropertyProxy_ReadOnly< bool > | property_receives_default () const |
Whether the widget will receive the default action when it is focused. | |
Glib::PropertyProxy< Glib::RefPtr< Gdk::Cursor > > | property_cursor () |
The cursor used by widget. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > | property_cursor () const |
The cursor used by widget. | |
Glib::PropertyProxy< bool > | property_has_tooltip () |
Enables or disables the emission of the signal_query_tooltip() signal on widget. | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_tooltip () const |
Enables or disables the emission of the signal_query_tooltip() signal on widget. | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_markup () |
Sets the text of tooltip to be the given string, which is marked up with Pango markup. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_markup () const |
Sets the text of tooltip to be the given string, which is marked up with Pango markup. | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_text () |
Sets the text of tooltip to be the given string. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
Sets the text of tooltip to be the given string. | |
Glib::PropertyProxy< Align > | property_halign () |
How to distribute horizontal space if widget gets extra space. | |
Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
How to distribute horizontal space if widget gets extra space. | |
Glib::PropertyProxy< Align > | property_valign () |
How to distribute vertical space if widget gets extra space. | |
Glib::PropertyProxy_ReadOnly< Align > | property_valign () const |
How to distribute vertical space if widget gets extra space. | |
Glib::PropertyProxy< int > | property_margin_start () |
Margin on start of widget, horizontally. | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_start () const |
Margin on start of widget, horizontally. | |
Glib::PropertyProxy< int > | property_margin_end () |
Margin on end of widget, horizontally. | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_end () const |
Margin on end of widget, horizontally. | |
Glib::PropertyProxy< int > | property_margin_top () |
Margin on top side of widget. | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_top () const |
Margin on top side of widget. | |
Glib::PropertyProxy< int > | property_margin_bottom () |
Margin on bottom side of widget. | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_bottom () const |
Margin on bottom side of widget. | |
Glib::PropertyProxy< bool > | property_hexpand () |
Whether to expand horizontally. | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand () const |
Whether to expand horizontally. | |
Glib::PropertyProxy< bool > | property_hexpand_set () |
Whether to use the hexpand property. | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand_set () const |
Whether to use the hexpand property. | |
Glib::PropertyProxy< bool > | property_vexpand () |
Whether to expand vertically. | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand () const |
Whether to expand vertically. | |
Glib::PropertyProxy< bool > | property_vexpand_set () |
Whether to use the vexpand property. | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand_set () const |
Whether to use the vexpand property. | |
Glib::PropertyProxy< double > | property_opacity () |
The requested opacity of the widget. | |
Glib::PropertyProxy_ReadOnly< double > | property_opacity () const |
The requested opacity of the widget. | |
Glib::PropertyProxy< Overflow > | property_overflow () |
How content outside the widget's content area is treated. | |
Glib::PropertyProxy_ReadOnly< Overflow > | property_overflow () const |
How content outside the widget's content area is treated. | |
Glib::PropertyProxy_ReadOnly< int > | property_scale_factor () const |
The scale factor of the widget. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_css_name () const |
The name of this widget in the CSS tree. | |
Glib::PropertyProxy< std::vector< Glib::ustring > > | property_css_classes () |
A list of css classes applied to this widget. | |
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > | property_css_classes () const |
A list of css classes applied to this widget. | |
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. | |
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. | |
Glib::PropertyProxy< bool > | property_limit_events () |
Makes this widget act like a modal dialog, with respect to event delivery. | |
Glib::PropertyProxy_ReadOnly< bool > | property_limit_events () const |
Makes this widget act like a modal dialog, with respect to event delivery. | |
![]() | |
Object (Object &&src) noexcept | |
Object & | operator= (Object &&src) noexcept |
~Object () noexcept override | |
![]() | |
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_with_c_callback (const Quark &key, void *data, GDestroyNotify notify) |
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) |
![]() | |
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 |
![]() | |
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 |
![]() | |
Accessible (Accessible &&src) noexcept | |
Accessible & | operator= (Accessible &&src) noexcept |
~Accessible () noexcept override | |
GtkAccessible * | gobj () |
Provides access to the underlying C GObject. | |
const GtkAccessible * | gobj () const |
Provides access to the underlying C GObject. | |
Glib::RefPtr< ATContext > | get_at_context () |
Retrieves the implementation for the given accessible object. | |
Glib::RefPtr< const ATContext > | get_at_context () const |
Retrieves the implementation for the given accessible object. | |
bool | get_platform_state (PlatformState state) const |
Queries a platform state, such as focus. | |
void | update_platform_state (PlatformState state) |
Informs ATs that the platform state has changed. | |
Glib::RefPtr< Accessible > | get_accessible_parent () |
Retrieves the accessible parent for an accessible object. | |
Glib::RefPtr< const Accessible > | get_accessible_parent () const |
Retrieves the accessible parent for an accessible object. | |
void | set_accessible_parent (const Glib::RefPtr< Accessible > & parent, const Glib::RefPtr< Accessible > & next_sibling) |
Sets the parent and sibling of an accessible object. | |
Glib::RefPtr< Accessible > | get_first_accessible_child () |
Retrieves the first accessible child of an accessible object. | |
Glib::RefPtr< const Accessible > | get_first_accessible_child () const |
Retrieves the first accessible child of an accessible object. | |
Glib::RefPtr< Accessible > | get_next_accessible_sibling () |
Retrieves the next accessible sibling of an accessible object. | |
Glib::RefPtr< const Accessible > | get_next_accessible_sibling () const |
Retrieves the next accessible sibling of an accessible object. | |
void | update_next_accessible_sibling (const Glib::RefPtr< Accessible > &new_sibling) |
Updates the next accessible sibling. | |
bool | get_bounds (int &x, int &y, int & width, int &height) const |
Queries the coordinates and dimensions of this accessible. | |
Role | get_accessible_role () const |
Retrieves the accessible role of an accessible object. | |
void | update_state (State state, const Glib::ValueBase & value) |
Updates an accessible state. | |
void | update_property (Property property, const Glib::ValueBase & value) |
Updates an accessible property. | |
void | update_relation (Relation relation, const Glib::ValueBase & value) |
Updates an accessible relation. | |
void | reset_state (State state) |
Resets the accessible state to its default value. | |
void | reset_property (Property property) |
Resets the accessible property to its default value. | |
void | reset_relation (Relation relation) |
Resets the accessible relation to its default value. | |
void | announce (const Glib::ustring & message, AnnouncementPriority priority) |
Requests the user's screen reader to announce the given message. | |
Glib::PropertyProxy< Role > | property_accessible_role () |
The accessible role of the given Gtk::Accessible implementation. | |
Glib::PropertyProxy_ReadOnly< Role > | property_accessible_role () const |
The accessible role of the given Gtk::Accessible implementation. | |
![]() | |
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 |
![]() | |
Buildable (Buildable &&src) noexcept | |
Buildable & | operator= (Buildable &&src) noexcept |
~Buildable () noexcept override | |
GtkBuildable * | gobj () |
Provides access to the underlying C GObject. | |
const GtkBuildable * | gobj () const |
Provides access to the underlying C GObject. | |
Glib::ustring | get_buildable_id () const |
Gets the ID of the buildable object. | |
![]() | |
ConstraintTarget (ConstraintTarget &&src) noexcept | |
ConstraintTarget & | operator= (ConstraintTarget &&src) noexcept |
~ConstraintTarget () noexcept override | |
GtkConstraintTarget * | gobj () |
Provides access to the underlying C GObject. | |
const GtkConstraintTarget * | gobj () const |
Provides access to the underlying C GObject. | |
![]() | |
Editable (Editable &&src) noexcept | |
Editable & | operator= (Editable &&src) noexcept |
~Editable () noexcept override | |
GtkEditable * | gobj () |
Provides access to the underlying C GObject. | |
const GtkEditable * | gobj () const |
Provides access to the underlying C GObject. | |
Glib::ustring | get_text () const |
Retrieves the contents of editable. | |
void | set_text (const Glib::ustring &text) |
Sets the text in the editable to the given value. | |
void | delete_selection () |
Deletes the currently selected text of the editable. | |
void | set_editable (bool is_editable=true) |
Determines if the user can edit the text in the editable widget. | |
bool | get_editable () const |
Retrieves whether editable is editable. | |
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. | |
void | delete_text (int start_pos, int end_pos) |
Deletes a sequence of characters. | |
Glib::ustring | get_chars (int start_pos, int end_pos) const |
Retrieves a sequence of characters. | |
void | select_region (int start_pos, int end_pos) |
Selects a region of text. | |
bool | get_selection_bounds (int &start_pos, int &end_pos) const |
Retrieves the selection bound of the editable. | |
void | set_position (int position) |
Sets the cursor position in the editable to the given value. | |
int | get_position () const |
Retrieves the current position of the cursor relative to the start of the content of the editable. | |
float | get_alignment () const |
Gets the alignment of the editable. | |
void | set_alignment (float xalign) |
Sets the alignment for the contents of the editable. | |
int | get_width_chars () const |
Gets the number of characters of space reserved for the contents of the editable. | |
void | set_width_chars (int n_chars) |
Changes the size request of the editable to be about the right size for n_chars characters. | |
int | get_max_width_chars () const |
Retrieves the desired maximum width of editable, in characters. | |
void | set_max_width_chars (int n_chars) |
Sets the desired maximum width in characters of editable. | |
bool | get_enable_undo () const |
Gets if undo/redo actions are enabled for editable. | |
void | set_enable_undo (bool enable_undo=true) |
If enabled, changes to editable will be saved for undo/redo actions. | |
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. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_text () const |
The contents of the entry. | |
Glib::PropertyProxy_ReadOnly< int > | property_cursor_position () const |
The current position of the insertion cursor in chars. | |
Glib::PropertyProxy< bool > | property_enable_undo () |
If undo/redo should be enabled for the editable. | |
Glib::PropertyProxy_ReadOnly< bool > | property_enable_undo () const |
If undo/redo should be enabled for the editable. | |
Glib::PropertyProxy_ReadOnly< int > | property_selection_bound () const |
The position of the opposite end of the selection from the cursor in chars. | |
Glib::PropertyProxy< bool > | property_editable () |
Whether the entry contents can be edited. | |
Glib::PropertyProxy_ReadOnly< bool > | property_editable () const |
Whether the entry contents can be edited. | |
Glib::PropertyProxy< int > | property_width_chars () |
Number of characters to leave space for in the entry. | |
Glib::PropertyProxy_ReadOnly< int > | property_width_chars () const |
Number of characters to leave space for in the entry. | |
Glib::PropertyProxy< int > | property_max_width_chars () |
The desired maximum width of the entry, in characters. | |
Glib::PropertyProxy_ReadOnly< int > | property_max_width_chars () const |
The desired maximum width of the entry, in characters. | |
Glib::PropertyProxy< float > | property_xalign () |
The horizontal alignment, from 0 (left) to 1 (right). | |
Glib::PropertyProxy_ReadOnly< float > | property_xalign () const |
The horizontal alignment, from 0 (left) to 1 (right). | |
![]() | |
CellEditable (CellEditable &&src) noexcept | |
CellEditable & | operator= (CellEditable &&src) noexcept |
~CellEditable () noexcept override | |
GtkCellEditable * | gobj () |
Provides access to the underlying C GObject. | |
const GtkCellEditable * | gobj () const |
Provides access to the underlying C GObject. | |
void | start_editing (const Glib::RefPtr< const Gdk::Event > & event) |
Begins editing on a cell_editable. | |
void | editing_done () |
Emits the GtkCellEditable::editing-done signal. | |
void | remove_widget () |
Emits the GtkCellEditable::remove-widget signal. | |
Glib::SignalProxy< void()> | signal_editing_done () |
Glib::SignalProxy< void()> | signal_remove_widget () |
Glib::PropertyProxy< bool > | property_editing_canceled () |
Indicates whether editing on the cell has been canceled. | |
Glib::PropertyProxy_ReadOnly< bool > | property_editing_canceled () const |
Indicates whether editing on the cell has been canceled. | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
static void | set_default_direction (TextDirection dir) |
Sets the default reading direction for widgets. | |
static TextDirection | get_default_direction () |
Obtains the default reading direction. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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. | |
A single line text entry field.
The Gtk::Entry 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.
The Entry widget looks like this:
|
noexcept |
|
overridenoexcept |
Gtk::Entry::Entry | ( | ) |
|
explicit |
gboolean Gtk::Entry::get_activates_default | ( | ) | const |
Retrieves the value set by set_activates_default().
true
if the entry will activate the default widget. float Gtk::Entry::get_alignment | ( | ) | const |
Gets the value set by set_alignment().
See also: Gtk::Editable::property_xalign()
Pango::AttrList Gtk::Entry::get_attributes | ( | ) | const |
Glib::RefPtr< EntryBuffer > Gtk::Entry::get_buffer | ( | ) |
Get the Gtk::EntryBuffer
object which holds the text for this widget.
Gtk::EntryBuffer
object. Glib::RefPtr< const EntryBuffer > Gtk::Entry::get_buffer | ( | ) | const |
Get the Gtk::EntryBuffer
object which holds the text for this widget.
Gtk::EntryBuffer
object. Glib::RefPtr< EntryCompletion > Gtk::Entry::get_completion | ( | ) |
Returns the auxiliary completion object currently in use by entry.
Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5.
Glib::RefPtr< const EntryCompletion > Gtk::Entry::get_completion | ( | ) | const |
Returns the auxiliary completion object currently in use by entry.
Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5.
int Gtk::Entry::get_current_icon_drag_source | ( | ) |
Returns the index of the icon which is the source of the current DND operation, or -1.
Glib::RefPtr< Gio::MenuModel > Gtk::Entry::get_extra_menu | ( | ) |
Gets the menu model set with set_extra_menu().
Glib::RefPtr< const Gio::MenuModel > Gtk::Entry::get_extra_menu | ( | ) | const |
Gets the menu model set with set_extra_menu().
bool Gtk::Entry::get_has_frame | ( | ) | const |
Gets the value set by set_has_frame().
bool Gtk::Entry::get_icon_activatable | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) | const |
Returns whether the icon is activatable.
icon_pos | Icon position. |
true
if the icon is activatable. Gdk::Rectangle Gtk::Entry::get_icon_area | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) | const |
Returns the area where entry's icon at icon_pos is drawn.
This function is useful when drawing something to the entry in a draw callback.
icon_pos | Icon position. |
int Gtk::Entry::get_icon_at_pos | ( | int | x, |
int | y | ||
) | const |
Finds the icon at the given position and return its index.
The position’s coordinates are relative to the entry’s top left corner. If x, y doesn’t lie inside an icon, -1 is returned. This function is intended for use in a Gtk::Widget::signal_query_tooltip() signal handler.
x | The x coordinate of the position to find, relative to entry. |
y | The y coordinate of the position to find, relative to entry. |
Glib::RefPtr< Gio::Icon > Gtk::Entry::get_icon_gicon | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) |
Retrieves the Gio::Icon
used for the icon.
nullptr
will be returned if there is no icon or if the icon was set by some other method (e.g., by Gdk::Paintable
or icon name).
icon_pos | Icon position. |
Gio::Icon
. Glib::RefPtr< const Gio::Icon > Gtk::Entry::get_icon_gicon | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) | const |
Retrieves the Gio::Icon
used for the icon.
nullptr
will be returned if there is no icon or if the icon was set by some other method (e.g., by Gdk::Paintable
or icon name).
icon_pos | Icon position. |
Gio::Icon
. Glib::ustring Gtk::Entry::get_icon_name | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) | const |
Retrieves the icon name used for the icon.
nullptr
is returned if there is no icon or if the icon was set by some other method (e.g., by Gdk::Paintable
or gicon).
icon_pos | Icon position. |
Glib::RefPtr< Gdk::Paintable > Gtk::Entry::get_icon_paintable | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) |
Retrieves the Gdk::Paintable
used for the icon.
If no Gdk::Paintable
was used for the icon, nullptr
is returned.
icon_pos | Icon position. |
Gdk::Paintable
if no icon is set for this position or the icon set is not a Gdk::Paintable
. Glib::RefPtr< const Gdk::Paintable > Gtk::Entry::get_icon_paintable | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) | const |
Retrieves the Gdk::Paintable
used for the icon.
If no Gdk::Paintable
was used for the icon, nullptr
is returned.
icon_pos | Icon position. |
Gdk::Paintable
if no icon is set for this position or the icon set is not a Gdk::Paintable
. bool Gtk::Entry::get_icon_sensitive | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) |
Returns whether the icon appears sensitive or insensitive.
icon_pos | Icon position. |
true
if the icon is sensitive. Image::Type Gtk::Entry::get_icon_storage_type | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) | const |
Gets the type of representation being used by the icon to store image data.
If the icon has no image data, the return value will be Gtk::Image::Type::EMPTY.
icon_pos | Icon position. |
Glib::ustring Gtk::Entry::get_icon_tooltip_markup | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) | const |
Gets the contents of the tooltip on the icon at the specified position in entry.
icon_pos | The icon position. |
Glib::ustring Gtk::Entry::get_icon_tooltip_text | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) | const |
Gets the contents of the tooltip on the icon at the specified position in entry.
icon_pos | The icon position. |
InputHints Gtk::Entry::get_input_hints | ( | ) | const |
Gets the input hints of this Gtk::Entry
.
InputPurpose Gtk::Entry::get_input_purpose | ( | ) | const |
Gets the input purpose of the Gtk::Entry
.
gunichar Gtk::Entry::get_invisible_char | ( | ) | const |
Retrieves the character displayed in place of the actual text in “password mode”.
int Gtk::Entry::get_max_length | ( | ) | const |
Retrieves the maximum allowed length of the text in entry.
See set_max_length().
Gtk::Entry
, or 0 if there is no maximum. bool Gtk::Entry::get_overwrite_mode | ( | ) | const |
Gets whether the Gtk::Entry
is in overwrite mode.
Glib::ustring Gtk::Entry::get_placeholder_text | ( | ) | const |
Retrieves the text that will be displayed when entry is empty and unfocused.
nullptr
will be returned. double Gtk::Entry::get_progress_fraction | ( | ) | const |
Returns the current fraction of the task that’s been completed.
double Gtk::Entry::get_progress_pulse_step | ( | ) |
Retrieves the pulse step set with set_progress_pulse_step().
Pango::TabArray Gtk::Entry::get_tabs | ( | ) | const |
guint16 Gtk::Entry::get_text_length | ( | ) | const |
Retrieves the current length of the text in entry.
This is equivalent to getting entry's Gtk::EntryBuffer
and calling Gtk::EntryBuffer::get_length() on it.
Gtk::Entry
, or 0 if there are none.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
bool Gtk::Entry::get_visibility | ( | ) | const |
Retrieves whether the text in entry is visible.
See set_visibility().
true
if the text is currently visible.
|
inline |
Provides access to the underlying C GObject.
void Gtk::Entry::grab_focus_without_selecting | ( | ) |
Causes entry to have keyboard focus.
It behaves like Gtk::Widget::grab_focus(), except that it doesn't select the contents of the entry. 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.
void Gtk::Entry::progress_pulse | ( | ) |
Indicates that some progress is made, but you don’t know how much.
Causes the entry’s progress indicator to enter “activity mode”, where a block bounces back and forth. Each call to progress_pulse() causes the block to move by a little bit (the amount of movement per pulse is determined by set_progress_pulse_step()).
Glib::PropertyProxy< bool > Gtk::Entry::property_activates_default | ( | ) |
Whether to activate the default widget when Enter is pressed.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_activates_default | ( | ) | const |
Whether to activate the default widget when Enter is pressed.
Default value: false
Glib::PropertyProxy< Pango::AttrList > Gtk::Entry::property_attributes | ( | ) |
A list of Pango attributes to apply to the text of the entry.
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.
Glib::PropertyProxy_ReadOnly< Pango::AttrList > Gtk::Entry::property_attributes | ( | ) | const |
A list of Pango attributes to apply to the text of the entry.
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.
Glib::PropertyProxy< Glib::RefPtr< EntryBuffer > > Gtk::Entry::property_buffer | ( | ) |
The buffer object which actually stores the text.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< EntryBuffer > > Gtk::Entry::property_buffer | ( | ) | const |
The buffer object which actually stores the text.
Glib::PropertyProxy< Glib::RefPtr< EntryCompletion > > Gtk::Entry::property_completion | ( | ) |
The auxiliary completion object to use with the entry.
Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< EntryCompletion > > Gtk::Entry::property_completion | ( | ) | const |
The auxiliary completion object to use with the entry.
Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5.
Glib::PropertyProxy< bool > Gtk::Entry::property_enable_emoji_completion | ( | ) |
Whether to suggest Emoji replacements for :-delimited names like :heart:
.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_enable_emoji_completion | ( | ) | const |
Whether to suggest Emoji replacements for :-delimited names like :heart:
.
Default value: false
Glib::PropertyProxy< Glib::RefPtr< Gio::MenuModel > > Gtk::Entry::property_extra_menu | ( | ) |
A menu model whose contents will be appended to the context menu.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::MenuModel > > Gtk::Entry::property_extra_menu | ( | ) | const |
A menu model whose contents will be appended to the context menu.
Glib::PropertyProxy< bool > Gtk::Entry::property_has_frame | ( | ) |
Whether the entry should draw a frame.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_has_frame | ( | ) | const |
Whether the entry should draw a frame.
Default value: true
Glib::PropertyProxy< Glib::ustring > Gtk::Entry::property_im_module | ( | ) |
Which IM (input method) module should be used for this entry.
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: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Entry::property_im_module | ( | ) | const |
Which IM (input method) module should be used for this entry.
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: ""
Glib::PropertyProxy< InputHints > Gtk::Entry::property_input_hints | ( | ) |
Additional hints that allow input methods to fine-tune their behavior.
Also see property_input_purpose()
Default value: Gtk::InputHints::NONE
Glib::PropertyProxy_ReadOnly< InputHints > Gtk::Entry::property_input_hints | ( | ) | const |
Additional hints that allow input methods to fine-tune their behavior.
Also see property_input_purpose()
Default value: Gtk::InputHints::NONE
Glib::PropertyProxy< InputPurpose > Gtk::Entry::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 property_visibility().
Default value: Gtk::InputPurpose::FREE_FORM
Glib::PropertyProxy_ReadOnly< InputPurpose > Gtk::Entry::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 property_visibility().
Default value: Gtk::InputPurpose::FREE_FORM
Glib::PropertyProxy< gunichar > Gtk::Entry::property_invisible_char | ( | ) |
The character to use when masking entry contents (“password mode”).
Default value: 42
Glib::PropertyProxy_ReadOnly< gunichar > Gtk::Entry::property_invisible_char | ( | ) | const |
The character to use when masking entry contents (“password mode”).
Default value: 42
Glib::PropertyProxy< bool > Gtk::Entry::property_invisible_char_set | ( | ) |
Whether the invisible char has been set for the Gtk::Entry
.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_invisible_char_set | ( | ) | const |
Whether the invisible char has been set for the Gtk::Entry
.
Default value: false
Glib::PropertyProxy< int > Gtk::Entry::property_max_length | ( | ) |
Maximum number of characters for this entry.
Default value: 0
Glib::PropertyProxy_ReadOnly< int > Gtk::Entry::property_max_length | ( | ) | const |
Maximum number of characters for this entry.
Default value: 0
Glib::PropertyProxy< bool > Gtk::Entry::property_overwrite_mode | ( | ) |
If text is overwritten when typing in the Gtk::Entry
.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_overwrite_mode | ( | ) | const |
If text is overwritten when typing in the Gtk::Entry
.
Default value: false
Glib::PropertyProxy< Glib::ustring > Gtk::Entry::property_placeholder_text | ( | ) |
The text that will be displayed in the Gtk::Entry
when it is empty and unfocused.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Entry::property_placeholder_text | ( | ) | const |
The text that will be displayed in the Gtk::Entry
when it is empty and unfocused.
Default value: ""
Glib::PropertyProxy< bool > Gtk::Entry::property_primary_icon_activatable | ( | ) |
Whether the primary icon is activatable.
GTK emits the signal_icon_press() and signal_icon_release() signals only on sensitive, activatable icons.
Sensitive, but non-activatable icons can be used for purely informational purposes.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_primary_icon_activatable | ( | ) | const |
Whether the primary icon is activatable.
GTK emits the signal_icon_press() and signal_icon_release() signals only on sensitive, activatable icons.
Sensitive, but non-activatable icons can be used for purely informational purposes.
Default value: true
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > Gtk::Entry::property_primary_icon_gicon | ( | ) |
The Gio::Icon
to use for the primary icon for the entry.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > Gtk::Entry::property_primary_icon_gicon | ( | ) | const |
The Gio::Icon
to use for the primary icon for the entry.
Glib::PropertyProxy< Glib::ustring > Gtk::Entry::property_primary_icon_name | ( | ) |
The icon name to use for the primary icon for the entry.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Entry::property_primary_icon_name | ( | ) | const |
The icon name to use for the primary icon for the entry.
Default value: ""
Glib::PropertyProxy< Glib::RefPtr< Gdk::Paintable > > Gtk::Entry::property_primary_icon_paintable | ( | ) |
A Gdk::Paintable
to use as the primary icon for the entry.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Paintable > > Gtk::Entry::property_primary_icon_paintable | ( | ) | const |
A Gdk::Paintable
to use as the primary icon for the entry.
Glib::PropertyProxy< bool > Gtk::Entry::property_primary_icon_sensitive | ( | ) |
Whether the primary icon is sensitive.
An insensitive icon appears grayed out. GTK does not emit the signal_icon_press() and signal_icon_release() signals and does not allow DND from insensitive icons.
An icon should be set insensitive if the action that would trigger when clicked is currently not available.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_primary_icon_sensitive | ( | ) | const |
Whether the primary icon is sensitive.
An insensitive icon appears grayed out. GTK does not emit the signal_icon_press() and signal_icon_release() signals and does not allow DND from insensitive icons.
An icon should be set insensitive if the action that would trigger when clicked is currently not available.
Default value: true
Glib::PropertyProxy_ReadOnly< Image::Type > Gtk::Entry::property_primary_icon_storage_type | ( | ) | const |
The representation which is used for the primary icon of the entry.
Default value: Gtk::Image::Type::EMPTY
Glib::PropertyProxy< bool > Gtk::Entry::property_primary_icon_tooltip_markup | ( | ) |
The contents of the tooltip on the primary icon, with markup.
Also see Gtk::Entry::set_icon_tooltip_markup().
Default value: ""
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_primary_icon_tooltip_markup | ( | ) | const |
The contents of the tooltip on the primary icon, with markup.
Also see Gtk::Entry::set_icon_tooltip_markup().
Default value: ""
Glib::PropertyProxy< bool > Gtk::Entry::property_primary_icon_tooltip_text | ( | ) |
The contents of the tooltip on the primary icon.
Also see Gtk::Entry::set_icon_tooltip_text().
Default value: ""
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_primary_icon_tooltip_text | ( | ) | const |
The contents of the tooltip on the primary icon.
Also see Gtk::Entry::set_icon_tooltip_text().
Default value: ""
Glib::PropertyProxy< double > Gtk::Entry::property_progress_fraction | ( | ) |
The current fraction of the task that's been completed.
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Gtk::Entry::property_progress_fraction | ( | ) | const |
The current fraction of the task that's been completed.
Default value: 0
Glib::PropertyProxy< double > Gtk::Entry::property_progress_pulse_step | ( | ) |
The fraction of total entry width to move the progress bouncing block for each pulse.
See Gtk::Entry::progress_pulse().
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Gtk::Entry::property_progress_pulse_step | ( | ) | const |
The fraction of total entry width to move the progress bouncing block for each pulse.
See Gtk::Entry::progress_pulse().
Default value: 0
Glib::PropertyProxy_ReadOnly< int > Gtk::Entry::property_scroll_offset | ( | ) | const |
Number of pixels of the entry scrolled off the screen to the left.
Default value: 0
Glib::PropertyProxy< bool > Gtk::Entry::property_secondary_icon_activatable | ( | ) |
Whether the secondary icon is activatable.
GTK emits the signal_icon_press() and signal_icon_release() signals only on sensitive, activatable icons.
Sensitive, but non-activatable icons can be used for purely informational purposes.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_secondary_icon_activatable | ( | ) | const |
Whether the secondary icon is activatable.
GTK emits the signal_icon_press() and signal_icon_release() signals only on sensitive, activatable icons.
Sensitive, but non-activatable icons can be used for purely informational purposes.
Default value: true
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > Gtk::Entry::property_secondary_icon_gicon | ( | ) |
The Gio::Icon
to use for the secondary icon for the entry.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > Gtk::Entry::property_secondary_icon_gicon | ( | ) | const |
The Gio::Icon
to use for the secondary icon for the entry.
Glib::PropertyProxy< Glib::ustring > Gtk::Entry::property_secondary_icon_name | ( | ) |
The icon name to use for the secondary icon for the entry.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Entry::property_secondary_icon_name | ( | ) | const |
The icon name to use for the secondary icon for the entry.
Default value: ""
Glib::PropertyProxy< Glib::RefPtr< Gdk::Paintable > > Gtk::Entry::property_secondary_icon_paintable | ( | ) |
A Gdk::Paintable
to use as the secondary icon for the entry.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Paintable > > Gtk::Entry::property_secondary_icon_paintable | ( | ) | const |
A Gdk::Paintable
to use as the secondary icon for the entry.
Glib::PropertyProxy< bool > Gtk::Entry::property_secondary_icon_sensitive | ( | ) |
Whether the secondary icon is sensitive.
An insensitive icon appears grayed out. GTK does not emit the [signa.nosp@m.l@Gt.nosp@m.k.Ent.nosp@m.ryicon-press[ and [signal Gtk.Entry::icon-release] signals and does not allow DND from insensitive icons.
An icon should be set insensitive if the action that would trigger when clicked is currently not available.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_secondary_icon_sensitive | ( | ) | const |
Whether the secondary icon is sensitive.
An insensitive icon appears grayed out. GTK does not emit the [signa.nosp@m.l@Gt.nosp@m.k.Ent.nosp@m.ryicon-press[ and [signal Gtk.Entry::icon-release] signals and does not allow DND from insensitive icons.
An icon should be set insensitive if the action that would trigger when clicked is currently not available.
Default value: true
Glib::PropertyProxy_ReadOnly< Image::Type > Gtk::Entry::property_secondary_icon_storage_type | ( | ) | const |
The representation which is used for the secondary icon of the entry.
Default value: Gtk::Image::Type::EMPTY
Glib::PropertyProxy< bool > Gtk::Entry::property_secondary_icon_tooltip_markup | ( | ) |
The contents of the tooltip on the secondary icon, with markup.
Also see Gtk::Entry::set_icon_tooltip_markup().
Default value: ""
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_secondary_icon_tooltip_markup | ( | ) | const |
The contents of the tooltip on the secondary icon, with markup.
Also see Gtk::Entry::set_icon_tooltip_markup().
Default value: ""
Glib::PropertyProxy< bool > Gtk::Entry::property_secondary_icon_tooltip_text | ( | ) |
The contents of the tooltip on the secondary icon.
Also see Gtk::Entry::set_icon_tooltip_text().
Default value: ""
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_secondary_icon_tooltip_text | ( | ) | const |
The contents of the tooltip on the secondary icon.
Also see Gtk::Entry::set_icon_tooltip_text().
Default value: ""
Glib::PropertyProxy< bool > Gtk::Entry::property_show_emoji_icon | ( | ) |
Whether the entry will show an Emoji icon in the secondary icon position to open the Emoji chooser.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_show_emoji_icon | ( | ) | const |
Whether the entry will show an Emoji icon in the secondary icon position to open the Emoji chooser.
Default value: false
Glib::PropertyProxy< Pango::TabArray > Gtk::Entry::property_tabs | ( | ) |
A list of tabstops to apply to the text of the entry.
Glib::PropertyProxy_ReadOnly< Pango::TabArray > Gtk::Entry::property_tabs | ( | ) | const |
A list of tabstops to apply to the text of the entry.
Glib::PropertyProxy_ReadOnly< guint > Gtk::Entry::property_text_length | ( | ) | const |
The length of the text in the Gtk::Entry
.
Default value: 0
Glib::PropertyProxy< bool > Gtk::Entry::property_truncate_multiline | ( | ) |
When true
, pasted multi-line text is truncated to the first line.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_truncate_multiline | ( | ) | const |
When true
, pasted multi-line text is truncated to the first line.
Default value: false
Glib::PropertyProxy< bool > Gtk::Entry::property_visibility | ( | ) |
Whether the entry should show the “invisible char” instead of the actual text (“password mode”).
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Entry::property_visibility | ( | ) | const |
Whether the entry should show the “invisible char” instead of the actual text (“password mode”).
Default value: true
void Gtk::Entry::reset_im_context | ( | ) |
Reset the input method context of the entry if needed.
This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.
Sets whether pressing Enter in the entry will activate the default widget for the window containing the entry.
This usually means that the dialog containing the entry will be closed, since the default widget is usually one of the dialog buttons.
setting | true to activate window’s default widget on Enter keypress. |
Sets the alignment for the contents of the entry.
This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry.
See also: Gtk::Editable::property_xalign()
xalign | The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts. |
Sets the alignment for the contents of the entry.
This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry.
See also: Gtk::Editable::property_xalign()
xalign | The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts. |
void Gtk::Entry::set_attributes | ( | Pango::AttrList & | attrs | ) |
Sets a Pango::AttrList
.
The attributes in the list are applied to the entry text.
Since the attributes will be applied to text that changes as the user types, it makes most sense to use attributes with unlimited extent.
attrs | A Pango::AttrList . |
void Gtk::Entry::set_buffer | ( | const Glib::RefPtr< EntryBuffer > & | buffer | ) |
Set the Gtk::EntryBuffer
object which holds the text for this widget.
buffer | A Gtk::EntryBuffer . |
void Gtk::Entry::set_completion | ( | const Glib::RefPtr< EntryCompletion > & | completion | ) |
Sets completion to be the auxiliary completion object to use with entry.
All further configuration of the completion mechanism is done on completion using the Gtk::EntryCompletion
API. Completion is disabled if completion is set to nullptr
.
Deprecated: 4.10: GtkEntryCompletion will be removed in GTK 5.
completion | The Gtk::EntryCompletion . |
void Gtk::Entry::set_extra_menu | ( | const Glib::RefPtr< Gio::MenuModel > & | model | ) |
Sets a menu model to add when constructing the context menu for entry.
model | A Gio::MenuModel . |
Sets whether the entry has a beveled frame around it.
setting | New value. |
void Gtk::Entry::set_icon_activatable | ( | bool | activatable = true , |
IconPosition | icon_pos = IconPosition::PRIMARY |
||
) |
Sets whether the icon is activatable.
icon_pos | Icon position. |
activatable | true if the icon should be activatable. |
void Gtk::Entry::set_icon_drag_source | ( | const Glib::RefPtr< Gdk::ContentProvider > & | provider, |
Gdk::DragAction | actions = Gdk::DragAction::COPY , |
||
IconPosition | icon_pos = IconPosition::PRIMARY |
||
) |
Sets up the icon at the given position as drag source.
This makes it so that GTK will start a drag operation when the user clicks and drags the icon.
icon_pos | Icon position. |
provider | A Gdk::ContentProvider . |
actions | A bitmask of the allowed drag actions. |
void Gtk::Entry::set_icon_from_gicon | ( | const Glib::RefPtr< Gio::Icon > & | icon, |
IconPosition | icon_pos = IconPosition::PRIMARY |
||
) |
Sets the icon shown in the entry at the specified position from the current icon theme.
If the icon isn’t known, a “broken image” icon will be displayed instead.
If icon is nullptr
, no icon will be shown in the specified position.
icon_pos | The position at which to set the icon. |
icon | The icon to set. |
void Gtk::Entry::set_icon_from_icon_name | ( | const Glib::ustring & | icon_name, |
IconPosition | icon_pos = IconPosition::PRIMARY |
||
) |
Sets the icon shown in the entry at the specified position from the current icon theme.
If the icon name isn’t known, a “broken image” icon will be displayed instead.
If icon_name is nullptr
, no icon will be shown in the specified position.
icon_pos | The position at which to set the icon. |
icon_name | An icon name. |
void Gtk::Entry::set_icon_from_paintable | ( | const Glib::RefPtr< Gdk::Paintable > & | paintable, |
IconPosition | icon_pos = IconPosition::PRIMARY |
||
) |
Sets the icon shown in the specified position using a Gdk::Paintable
.
If paintable is nullptr
, no icon will be shown in the specified position.
icon_pos | Icon position. |
paintable | A Gdk::Paintable . |
void Gtk::Entry::set_icon_sensitive | ( | IconPosition | icon_pos = IconPosition::PRIMARY , |
bool | sensitive = true |
||
) |
Sets the sensitivity for the specified icon.
icon_pos | Icon position. |
sensitive | Specifies whether the icon should appear sensitive or insensitive. |
void Gtk::Entry::set_icon_tooltip_markup | ( | const Glib::ustring & | tooltip, |
IconPosition | icon_pos = IconPosition::PRIMARY |
||
) |
Sets tooltip as the contents of the tooltip for the icon at the specified position.
tooltip is assumed to be marked up with Pango Markup.
Use nullptr
for tooltip to remove an existing tooltip.
See also Gtk::Widget::set_tooltip_markup() and set_icon_tooltip_text().
icon_pos | The icon position. |
tooltip | The contents of the tooltip for the icon. |
void Gtk::Entry::set_icon_tooltip_text | ( | const Glib::ustring & | tooltip, |
IconPosition | icon_pos = IconPosition::PRIMARY |
||
) |
Sets tooltip as the contents of the tooltip for the icon at the specified position.
Use nullptr
for tooltip to remove an existing tooltip.
See also Gtk::Widget::set_tooltip_text() and set_icon_tooltip_markup().
If you unset the widget tooltip via Gtk::Widget::set_tooltip_text() or Gtk::Widget::set_tooltip_markup(), this sets Gtk::Widget::property_has_tooltip() to false
, which suppresses icon tooltips too. You can resolve this by then calling Gtk::Widget::set_has_tooltip() to set Gtk::Widget::property_has_tooltip() back to true
, or setting at least one non-empty tooltip on any icon achieves the same result.
icon_pos | The icon position. |
tooltip | The contents of the tooltip for the icon. |
void Gtk::Entry::set_input_hints | ( | InputHints | hints | ) |
Set additional hints which allow input methods to fine-tune their behavior.
hints | The hints. |
void Gtk::Entry::set_input_purpose | ( | InputPurpose | purpose | ) |
Sets the input purpose which can be used by input methods to adjust their behavior.
purpose | The purpose. |
Sets the character to use in place of the actual text in “password mode”.
See set_visibility() for how to enable “password mode”.
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.
ch | A Unicode character. |
void Gtk::Entry::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. The length is in characters.
This is equivalent to getting entry's Gtk::EntryBuffer
and calling Gtk::EntryBuffer::set_max_length() on it.
max | The maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536. |
Sets whether the text is overwritten when typing in the Gtk::Entry
.
overwrite | New value. |
void Gtk::Entry::set_placeholder_text | ( | const Glib::ustring & | text | ) |
Sets text to be displayed in entry when it is empty.
This can be used to give a visual hint of the expected contents of the Gtk::Entry
.
text | A string to be displayed when entry is empty and unfocused. |
Causes the entry’s progress indicator to “fill in” the given fraction of the bar.
The fraction should be between 0.0 and 1.0, inclusive.
fraction | Fraction of the task that’s been completed. |
Sets the fraction of total entry width to move the progress bouncing block for each pulse.
Use progress_pulse() to pulse the progress.
fraction | Fraction between 0.0 and 1.0. |
void Gtk::Entry::set_tabs | ( | const Pango::TabArray & | tabs | ) |
Sets a Pango::TabArray
.
The tabstops in the array are applied to the entry text.
tabs | A Pango::TabArray . |
Sets whether the contents of the entry 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 entry widget is copied elsewhere.
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 property_input_purpose() to Gtk::InputPurpose::PASSWORD or Gtk::InputPurpose::PIN to inform input methods about the purpose of this entry, in addition to setting visibility to false
.
visible | true if the contents of the entry are displayed as plaintext. |
Glib::SignalProxy< void()> Gtk::Entry::signal_activate | ( | ) |
void on_my_activate()
Flags: Run Last, Action
Emitted when the entry is activated.
The keybindings for this signal are all forms of the Enter key.
Glib::SignalProxy< void(IconPosition)> Gtk::Entry::signal_icon_press | ( | ) |
void on_my_icon_press(IconPosition icon_position)
Flags: Run Last
Emitted when an activatable icon is clicked.
icon_position | The position of the clicked icon. |
Glib::SignalProxy< void(IconPosition)> Gtk::Entry::signal_icon_release | ( | ) |
void on_my_icon_release(IconPosition icon_position)
Flags: Run Last
Emitted on the button release from a mouse click over an activatable icon.
icon_position | The position of the clicked icon. |
void Gtk::Entry::unset_icon | ( | IconPosition | icon_pos = IconPosition::PRIMARY | ) |
Do not show any icon in the specified position.
See set_icon_from_paintable(), set_icon_from_icon_name(), and set_icon_from_gicon().
icon_pos | The icon position. |
void Gtk::Entry::unset_invisible_char | ( | ) |
Unsets the invisible char, so that the default invisible char is used again.
See set_invisible_char().
|
related |
A Glib::wrap() method for this object.
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. |