gtkmm
4.4.0
|
Create widgets with a discrete toggle button. More...
#include <gtkmm/checkbutton.h>
Public Member Functions | |
CheckButton (CheckButton&& src) noexcept | |
CheckButton& | operator= (CheckButton&& src) noexcept |
CheckButton (const CheckButton&)=delete | |
CheckButton& | operator= (const CheckButton&)=delete |
~CheckButton () noexcept override | |
GtkCheckButton* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkCheckButton* | gobj () const |
Provides access to the underlying C GObject. More... | |
CheckButton () | |
Create an empty check button. More... | |
CheckButton (const Glib::ustring& label, bool mnemonic=false) | |
Create a check button with a label. More... | |
void | set_inconsistent (bool inconsistent=true) |
Sets the GtkCheckButton to inconsistent state. More... | |
bool | get_inconsistent () const |
Returns whether the check button is in an inconsistent state. More... | |
void | set_active (bool setting=true) |
Changes the check buttons active state. More... | |
bool | get_active () const |
Returns whether the check button is active. More... | |
void | set_label (const Glib::ustring& label) |
Sets the text of self. More... | |
Glib::ustring | get_label () const |
Returns the label of the check button. More... | |
void | set_use_underline (bool setting=true) |
Sets whether underlines in the label indicate mnemonics. More... | |
bool | get_use_underline () const |
Returns whether underlines in the label indicate mnemonics. More... | |
void | set_group (CheckButton& group) |
Adds self to the group of group. More... | |
void | unset_group () |
Glib::SignalProxy< void()> | signal_toggled () |
Glib::PropertyProxy< bool > | property_active () |
If the check button is active. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_active () const |
If the check button is active. More... | |
Glib::PropertyProxy_WriteOnly< CheckButton* > | property_group () |
The check button whose group this widget belongs to. More... | |
Glib::PropertyProxy< Glib::ustring > | property_label () |
Text of the label inside the check button, if it contains a label widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_label () const |
Text of the label inside the check button, if it contains a label widget. More... | |
Glib::PropertyProxy< bool > | property_inconsistent () |
If the check button is in an “in between” state. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_inconsistent () const |
If the check button is in an “in between” state. More... | |
Glib::PropertyProxy< bool > | property_use_underline () |
If set, an underline in the text indicates that the following character is to be used as mnemonic. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_use_underline () const |
If set, an underline in the text indicates that the following character is to be used as mnemonic. More... | |
![]() | |
Widget (Widget&& src) noexcept | |
Widget& | operator= (Widget&& src) noexcept |
Widget (const Widget&)=delete | |
Widget& | operator= (const Widget&)=delete |
~Widget () noexcept override | |
Destroys the widget. More... | |
GtkWidget* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkWidget* | gobj () const |
Provides access to the underlying C GObject. More... | |
Glib::RefPtr< ConstraintTarget > | make_refptr_constrainttarget () |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
Glib::RefPtr< const ConstraintTarget > | make_refptr_constrainttarget () const |
Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
void | show () |
Flags a widget to be displayed. More... | |
void | hide () |
Reverses the effects of show(). More... | |
void | queue_draw () |
Schedules this widget to be redrawn in the paint phase of the current or the next frame. More... | |
void | queue_resize () |
Flags a widget to have its size renegotiated. More... | |
void | queue_allocate () |
Flags the widget for a rerun of the [vfunc Gtk.Widget.size_allocate] function. More... | |
void | size_allocate (const Allocation& allocation, int baseline) |
Allocates widget with a transformation that translates the origin to the position in allocation. More... | |
SizeRequestMode | get_request_mode () const |
Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More... | |
void | measure (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
Measures widget in the orientation orientation and for the given for_size. More... | |
void | get_preferred_size (Requisition& minimum_size, Requisition& natural_size) const |
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More... | |
void | set_layout_manager (const Glib::RefPtr< LayoutManager >& layout_manager) |
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More... | |
void | unset_layout_manager () |
Undoes the effect of a previous call to set_layout_manager(). More... | |
Glib::RefPtr< LayoutManager > | get_layout_manager () |
Retrieves the layout manager used by widget. More... | |
Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
Retrieves the layout manager used by widget. More... | |
bool | mnemonic_activate (bool group_cycling) |
Emits the signal_mnemonic_activate() signal. More... | |
bool | activate () |
For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More... | |
void | set_can_focus (bool can_focus=true) |
Specifies whether the input focus can enter the widget or any of its children. More... | |
bool | get_can_focus () const |
Determines whether the input focus can enter widget or any of its children. More... | |
void | set_focusable (bool focusable=true) |
Specifies whether widget can own the input focus. More... | |
bool | get_focusable () const |
Determines whether widget can own the input focus. More... | |
bool | has_focus () const |
Determines if the widget has the global input focus. More... | |
bool | is_focus () const |
Determines if the widget is the focus widget within its toplevel. More... | |
bool | has_visible_focus () const |
Determines if the widget should show a visible indication that it has the global input focus. More... | |
bool | grab_focus () |
Causes widget to have the keyboard focus for the GtkWindow it's inside. More... | |
void | set_focus_on_click (bool focus_on_click=true) |
Sets whether the widget should grab focus when it is clicked with the mouse. More... | |
bool | get_focus_on_click () const |
Returns whether the widget should grab focus when it is clicked with the mouse. More... | |
void | set_can_target (bool can_target=true) |
Sets whether widget can be the target of pointer events. More... | |
bool | get_can_target () const |
Queries whether widget can be the target of pointer events. More... | |
bool | has_default () const |
Determines whether widget is the current default widget within its toplevel. More... | |
void | set_receives_default (bool receives_default=true) |
Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More... | |
bool | get_receives_default () const |
Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More... | |
void | set_name (const Glib::ustring& name) |
Sets a widgets name. More... | |
void | unset_name () |
Glib::ustring | get_name () const |
Retrieves the name of a widget. More... | |
void | set_state_flags (StateFlags flags, bool clear=true) |
Turns on flag values in the current widget state. More... | |
void | unset_state_flags (StateFlags flags) |
Turns off flag values for the current widget state. More... | |
StateFlags | get_state_flags () const |
Returns the widget state as a flag set. More... | |
void | set_sensitive (bool sensitive=true) |
Sets the sensitivity of a widget. More... | |
bool | get_sensitive () const |
Returns the widget’s sensitivity. More... | |
bool | is_sensitive () const |
Returns the widget’s effective sensitivity. More... | |
void | set_visible (bool visible=true) |
Sets the visibility state of widget. More... | |
bool | get_visible () const |
Determines whether the widget is visible. More... | |
bool | is_visible () const |
Determines whether the widget and all its parents are marked as visible. More... | |
bool | is_drawable () const |
Determines whether widget can be drawn to. More... | |
bool | get_realized () const |
Determines whether widget is realized. More... | |
bool | get_mapped () const |
Whether the widget is mapped. More... | |
void | set_child_visible (bool visible=true) |
Sets whether widget should be mapped along with its parent. More... | |
bool | get_child_visible () const |
Gets the value set with set_child_visible(). More... | |
int | get_allocated_width () const |
Returns the width that has currently been allocated to widget. More... | |
int | get_allocated_height () const |
Returns the height that has currently been allocated to widget. More... | |
int | get_allocated_baseline () const |
Returns the baseline that has currently been allocated to widget. More... | |
Allocation | get_allocation () const |
Retrieves the widget’s location. More... | |
int | get_width () const |
Returns the content width of the widget. More... | |
int | get_height () const |
Returns the content height of the widget. More... | |
int | get_size (Orientation orientation) const |
Returns the content width or height of the widget. More... | |
Widget* | get_parent () |
Returns the parent widget of widget. More... | |
const Widget* | get_parent () const |
Returns the parent widget of widget. More... | |
Root* | get_root () |
Returns the GtkRoot widget of widget. More... | |
const Root* | get_root () const |
Returns the GtkRoot widget of widget. More... | |
Native* | get_native () |
Returns the nearest GtkNative ancestor of widget. More... | |
const Native* | get_native () const |
Returns the nearest GtkNative ancestor of widget. More... | |
bool | child_focus (DirectionType direction) |
Called by widgets as the user moves around the window using keyboard shortcuts. More... | |
bool | keynav_failed (DirectionType direction) |
Emits the ::keynav-failed signal on the widget. More... | |
void | error_bell () |
Notifies the user about an input-related error on this widget. More... | |
void | set_size_request (int width=-1, int height=-1) |
Sets the minimum size of a widget. More... | |
void | get_size_request (int& width, int& height) const |
Gets the size request that was explicitly set for the widget using set_size_request(). More... | |
void | set_opacity (double opacity) |
Request the widget to be rendered partially transparent. More... | |
double | get_opacity () const |
#Fetches the requested opacity for this widget. More... | |
void | set_overflow (Overflow overflow) |
Sets how widget treats content that is drawn outside the widget's content area. More... | |
Overflow | get_overflow () const |
Returns the widgets overflow value. More... | |
Widget* | get_ancestor (GType widget_type) |
Gets the first ancestor of widget with type widget_type. More... | |
const Widget* | get_ancestor (GType widget_type) const |
Gets the first ancestor of widget with type widget_type. More... | |
int | get_scale_factor () const |
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More... | |
Glib::RefPtr< Gdk::Display > | get_display () |
Get the GdkDisplay for the toplevel window associated with this widget. More... | |
Glib::RefPtr< const Gdk::Display > | get_display () const |
Get the GdkDisplay for the toplevel window associated with this widget. More... | |
Glib::RefPtr< Settings > | get_settings () |
Gets the settings object holding the settings used for this widget. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_clipboard () |
Gets the clipboard object for widget. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
Gets the clipboard object for widget. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_primary_clipboard () |
Gets the primary clipboard of widget. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_primary_clipboard () const |
Gets the primary clipboard of widget. More... | |
bool | get_hexpand () const |
Gets whether the widget would like any available extra horizontal space. More... | |
void | set_hexpand (bool expand=true) |
Sets whether the widget would like any available extra horizontal space. More... | |
bool | get_hexpand_set () const |
Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More... | |
void | set_hexpand_set (bool set=true) |
Sets whether the hexpand flag will be used. More... | |
bool | get_vexpand () const |
Gets whether the widget would like any available extra vertical space. More... | |
void | set_vexpand (bool expand=true) |
Sets whether the widget would like any available extra vertical space. More... | |
bool | get_vexpand_set () const |
Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More... | |
void | set_vexpand_set (bool set=true) |
Sets whether the vexpand flag will be used. More... | |
bool | compute_expand (Orientation orientation) |
Computes whether a container should give this widget extra space when possible. More... | |
void | set_expand (bool expand=true) |
Sets whether the widget would like any available extra space in both directions. More... | |
Align | get_halign () const |
Gets the horizontal alignment of widget. More... | |
void | set_halign (Align align) |
Sets the horizontal alignment of widget. More... | |
Align | get_valign () const |
Gets the vertical alignment of widget. More... | |
void | set_valign (Align align) |
Sets the vertical alignment of widget. More... | |
int | get_margin_start () const |
Gets the start margin of widget. More... | |
void | set_margin_start (int margin) |
Sets the start margin of widget. More... | |
int | get_margin_end () const |
Gets the end margin of widget. More... | |
void | set_margin_end (int margin) |
Sets the end margin of widget. More... | |
int | get_margin_top () const |
Gets the top margin of widget. More... | |
void | set_margin_top (int margin) |
Sets the top margin of widget. More... | |
int | get_margin_bottom () const |
Gets the bottom margin of widget. More... | |
void | set_margin_bottom (int margin) |
Sets the bottom margin of widget. More... | |
void | set_margin (int margin) |
Set all 4 margins to the same value. More... | |
bool | is_ancestor (Widget& ancestor) const |
Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More... | |
bool | translate_coordinates (Widget& dest_widget, double src_x, double src_y, double& dest_x, double& dest_y) |
Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More... | |
bool | contains (double x, double y) const |
Tests if the point at ( x, y) is contained in widget. More... | |
Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) |
Finds the descendant of widget closest to the point ( x, y). More... | |
const Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const |
Finds the descendant of widget closest to the point ( x, y). More... | |
void | add_controller (const Glib::RefPtr< EventController >& controller) |
Adds controller to widget so that it will receive events. More... | |
void | remove_controller (const Glib::RefPtr< EventController >& controller) |
Removes controller from widget, so that it doesn't process events anymore. More... | |
Glib::RefPtr< Pango::Context > | create_pango_context () |
Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More... | |
Glib::RefPtr< Pango::Context > | get_pango_context () |
Gets a PangoContext with the appropriate font map, font description, and base direction for this widget. More... | |
void | set_font_options (const Cairo::FontOptions& options) |
Sets the cairo_font_options_t used for Pango rendering in this widget. More... | |
void | unset_font_options () |
Undoes the effect of previous calls to set_font_options(). More... | |
Cairo::FontOptions | get_font_options () const |
Returns the cairo_font_options_t of widget. More... | |
Glib::RefPtr< Pango::Layout > | create_pango_layout (const Glib::ustring& text) |
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget. More... | |
void | set_direction (TextDirection dir) |
Sets the reading direction on a particular widget. More... | |
TextDirection | get_direction () const |
Gets the reading direction for a particular widget. More... | |
void | set_cursor (const Glib::RefPtr< Gdk::Cursor >& cursor) |
Sets the cursor to be shown when pointer devices point towards widget. More... | |
void | set_cursor (const Glib::ustring& name={}) |
Sets a named cursor to be shown when pointer devices point towards the widget. More... | |
Glib::RefPtr< Gdk::Cursor > | get_cursor () |
Queries the cursor set on widget. More... | |
Glib::RefPtr< const Gdk::Cursor > | get_cursor () const |
Queries the cursor set on widget. More... | |
std::vector< Widget* > | list_mnemonic_labels () |
Returns the widgets for which this widget is the target of a mnemonic. More... | |
std::vector< const Widget* > | list_mnemonic_labels () const |
Returns the widgets for which this widget is the target of a mnemonic. More... | |
void | add_mnemonic_label (Widget& label) |
Adds a widget to the list of mnemonic labels for this widget. More... | |
void | remove_mnemonic_label (Widget& label) |
Removes a widget from the list of mnemonic labels for this widget. More... | |
bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
Checks to see if a drag movement has passed the GTK drag threshold. More... | |
Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
Obtains the frame clock for a widget. More... | |
Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
Obtains the frame clock for a widget. More... | |
void | set_parent (Widget& parent) |
Sets parent as the parent widget of widget. More... | |
void | unparent () |
Dissociate widget from its parent. More... | |
void | map () |
Causes a widget to be mapped if it isn’t already. More... | |
void | unmap () |
Causes a widget to be unmapped if it’s currently mapped. More... | |
void | trigger_tooltip_query () |
Triggers a tooltip query on the display where the toplevel of widget is located. More... | |
void | set_tooltip_text (const Glib::ustring& text) |
Sets text as the contents of the tooltip. More... | |
Glib::ustring | get_tooltip_text () const |
Gets the contents of the tooltip for widget. More... | |
void | set_tooltip_markup (const Glib::ustring& markup) |
Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More... | |
Glib::ustring | get_tooltip_markup () const |
Gets the contents of the tooltip for widget. More... | |
void | set_has_tooltip (bool has_tooltip=TRUE) |
Sets the has-tooltip property on widget to has_tooltip. More... | |
bool | get_has_tooltip () const |
Returns the current value of the has-tooltip property. More... | |
bool | in_destruction () const |
Returns whether the widget is currently being destroyed. More... | |
Glib::RefPtr< StyleContext > | get_style_context () |
Returns the style context associated to widget. More... | |
Glib::RefPtr< const StyleContext > | get_style_context () const |
Returns the style context associated to widget. More... | |
guint | add_tick_callback (const SlotTick& slot) |
Queues an animation frame update and adds a callback to be called before each frame. More... | |
void | remove_tick_callback (guint id) |
Removes a tick callback previously registered with add_tick_callback(). More... | |
void | insert_action_group (const Glib::ustring& name, const Glib::RefPtr< Gio::ActionGroup >& group) |
Inserts group into widget. More... | |
void | remove_action_group (const Glib::ustring& name) |
Removes a group from the widget. More... | |
bool | activate_action (const Glib::ustring& name, const Glib::VariantBase& args={}) |
Looks up the action in the action groups associated with the widget and its ancestors, and activates it. More... | |
void | activate_default () |
Activates the default.activate action from widget. More... | |
void | set_font_map (const Glib::RefPtr< Pango::FontMap >& font_map) |
Sets the font map to use for Pango rendering. More... | |
Glib::RefPtr< Pango::FontMap > | get_font_map () |
Gets the font map of widget. More... | |
Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
Gets the font map of widget. More... | |
Widget* | get_first_child () |
Returns the widgets first child. More... | |
const Widget* | get_first_child () const |
Returns the widgets first child. More... | |
Widget* | get_last_child () |
Returns the widgets last child. More... | |
const Widget* | get_last_child () const |
Returns the widgets last child. More... | |
Widget* | get_next_sibling () |
Returns the widgets next sibling. More... | |
const Widget* | get_next_sibling () const |
Returns the widgets next sibling. More... | |
Widget* | get_prev_sibling () |
Returns the widgets previous sibling. More... | |
const Widget* | get_prev_sibling () const |
Returns the widgets previous sibling. More... | |
Glib::RefPtr< Gio::ListModel > | observe_children () |
Returns a GListModel to track the children of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_children () const |
Returns a GListModel to track the children of widget. More... | |
Glib::RefPtr< Gio::ListModel > | observe_controllers () |
Returns a GListModel to track the [class Gtk.EventController]s of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_controllers () const |
Returns a GListModel to track the [class Gtk.EventController]s of widget. More... | |
void | insert_after (Widget& parent, const Widget& previous_sibling) |
Inserts the Widget into the child widget list of parent after previous_sibling. More... | |
void | insert_before (Widget& parent, const Widget& next_sibling) |
Inserts the Widget into the child widget list of parent before next_sibling. More... | |
void | insert_at_start (Widget& parent) |
Inserts the Widget at the beginning of the child widget list of parent. More... | |
void | insert_at_end (Widget& parent) |
Inserts the Widget at the end of the child widget list of parent. More... | |
void | snapshot_child (Widget& child, const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
Snapshot the a child of widget. More... | |
bool | should_layout () const |
Returns whether widget should contribute to the measuring and allocation of its parent. More... | |
Glib::ustring | get_css_name () const |
Returns the CSS name that is used for self. More... | |
void | add_css_class (const Glib::ustring& css_class) |
Adds a style class to widget. More... | |
void | remove_css_class (const Glib::ustring& css_class) |
Removes a style from widget. More... | |
bool | has_css_class (const Glib::ustring& css_class) const |
Returns whether css_class is currently applied to widget. More... | |
std::vector< Glib::ustring > | get_css_classes () const |
Returns the list of style classes applied to widget. More... | |
void | set_css_classes (const std::vector< Glib::ustring >& classes) |
Clear all style classes applied to widget and replace them with classes. More... | |
Glib::SignalProxy< void()> | signal_show () |
Glib::SignalProxy< void()> | signal_hide () |
Glib::SignalProxy< void()> | signal_map () |
Emitted on mapping of a widget to the screen. More... | |
Glib::SignalProxy< void()> | signal_unmap () |
Glib::SignalProxy< void()> | signal_realize () |
Emitted on realization of a widget. More... | |
Glib::SignalProxy< void()> | signal_unrealize () |
Glib::SignalProxy< void(Gtk::StateFlags)> | signal_state_flags_changed () |
Glib::SignalProxy< void(TextDirection)> | signal_direction_changed () |
Glib::SignalProxy< bool(bool)> | signal_mnemonic_activate () |
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip >&)> | signal_query_tooltip () |
Glib::PropertyProxy< Glib::ustring > | property_name () |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
The name of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Widget* > | property_parent () const |
The parent widget of this widget. More... | |
Glib::PropertyProxy_ReadOnly< Root* > | property_root () const |
The GtkRoot widget of the widget tree containing this widget. More... | |
Glib::PropertyProxy< int > | property_width_request () |
Override for width request of the widget. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_width_request () const |
Override for width request of the widget. More... | |
Glib::PropertyProxy< int > | property_height_request () |
Override for height request of the widget. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_height_request () const |
Override for height request of the widget. More... | |
Glib::PropertyProxy< bool > | property_visible () |
Whether the widget is visible. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_visible () const |
Whether the widget is visible. More... | |
Glib::PropertyProxy< bool > | property_sensitive () |
Whether the widget responds to input. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_sensitive () const |
Whether the widget responds to input. More... | |
Glib::PropertyProxy< bool > | property_can_focus () |
Whether the widget or any of its descendents can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_focus () const |
Whether the widget or any of its descendents can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_focus () const |
Whether the widget has the input focus. More... | |
Glib::PropertyProxy< bool > | property_can_target () |
Whether the widget can receive pointer events. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_target () const |
Whether the widget can receive pointer events. More... | |
Glib::PropertyProxy< bool > | property_focus_on_click () |
Whether the widget should grab focus when it is clicked with the mouse. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_focus_on_click () const |
Whether the widget should grab focus when it is clicked with the mouse. More... | |
Glib::PropertyProxy< bool > | property_focusable () |
Whether this widget itself will accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_focusable () const |
Whether this widget itself will accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_default () const |
Whether the widget is the default widget. More... | |
Glib::PropertyProxy< bool > | property_receives_default () |
Whether the widget will receive the default action when it is focused. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_receives_default () const |
Whether the widget will receive the default action when it is focused. More... | |
Glib::PropertyProxy< Glib::RefPtr< Gdk::Cursor > > | property_cursor () |
The cursor used by widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > | property_cursor () const |
The cursor used by widget. More... | |
Glib::PropertyProxy< bool > | property_has_tooltip () |
Enables or disables the emission of the signal_query_tooltip() signal on widget. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_tooltip () const |
Enables or disables the emission of the signal_query_tooltip() signal on widget. More... | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_markup () |
Sets the text of tooltip to be the given string, which is marked up with Pango markup. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_markup () const |
Sets the text of tooltip to be the given string, which is marked up with Pango markup. More... | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_text () |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy< Align > | property_halign () |
How to distribute horizontal space if widget gets extra space. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
How to distribute horizontal space if widget gets extra space. More... | |
Glib::PropertyProxy< Align > | property_valign () |
How to distribute vertical space if widget gets extra space. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_valign () const |
How to distribute vertical space if widget gets extra space. More... | |
Glib::PropertyProxy< int > | property_margin_start () |
Margin on start of widget, horizontally. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_start () const |
Margin on start of widget, horizontally. More... | |
Glib::PropertyProxy< int > | property_margin_end () |
Margin on end of widget, horizontally. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_end () const |
Margin on end of widget, horizontally. More... | |
Glib::PropertyProxy< int > | property_margin_top () |
Margin on top side of widget. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_top () const |
Margin on top side of widget. More... | |
Glib::PropertyProxy< int > | property_margin_bottom () |
Margin on bottom side of widget. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_bottom () const |
Margin on bottom side of widget. More... | |
Glib::PropertyProxy< bool > | property_hexpand () |
Whether to expand horizontally. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand () const |
Whether to expand horizontally. More... | |
Glib::PropertyProxy< bool > | property_hexpand_set () |
Whether to use the hexpand property. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand_set () const |
Whether to use the hexpand property. More... | |
Glib::PropertyProxy< bool > | property_vexpand () |
Whether to expand vertically. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand () const |
Whether to expand vertically. More... | |
Glib::PropertyProxy< bool > | property_vexpand_set () |
Whether to use the vexpand property. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand_set () const |
Whether to use the vexpand property. More... | |
Glib::PropertyProxy< double > | property_opacity () |
The requested opacity of the widget. More... | |
Glib::PropertyProxy_ReadOnly< double > | property_opacity () const |
The requested opacity of the widget. More... | |
Glib::PropertyProxy< Overflow > | property_overflow () |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< Overflow > | property_overflow () const |
How content outside the widget's content area is treated. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_scale_factor () const |
The scale factor of the widget. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_css_name () const |
The name of this widget in the CSS tree. More... | |
Glib::PropertyProxy< std::vector< Glib::ustring > > | property_css_classes () |
A list of css classes applied to this widget. More... | |
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > | property_css_classes () const |
A list of css classes applied to this widget. More... | |
Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > | property_layout_manager () |
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > | property_layout_manager () const |
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
![]() | |
Object (Object&& src) noexcept | |
Object& | operator= (Object&& src) noexcept |
~Object () noexcept override | |
![]() | |
Accessible (Accessible&& src) noexcept | |
Accessible& | operator= (Accessible&& src) noexcept |
~Accessible () noexcept override | |
GtkAccessible* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkAccessible* | gobj () const |
Provides access to the underlying C GObject. More... | |
Role | get_accessible_role () const |
Retrieves the GtkAccessibleRole for the given GtkAccessible . More... | |
void | update_state (State state, const Glib::ValueBase& value) |
Updates an accessible state. More... | |
void | update_property (Property property, const Glib::ValueBase& value) |
Updates an accessible property. More... | |
void | update_relation (Relation relation, const Glib::ValueBase& value) |
Updates an accessible relation. More... | |
void | reset_state (State state) |
Resets the accessible state to its default value. More... | |
void | reset_property (Property property) |
Resets the accessible property to its default value. More... | |
void | reset_relation (Relation relation) |
Resets the accessible relation to its default value. More... | |
Glib::PropertyProxy< Role > | property_accessible_role () |
The accessible role of the given GtkAccessible implementation. More... | |
Glib::PropertyProxy_ReadOnly< Role > | property_accessible_role () const |
The accessible role of the given GtkAccessible implementation. More... | |
![]() | |
Buildable (Buildable&& src) noexcept | |
Buildable& | operator= (Buildable&& src) noexcept |
~Buildable () noexcept override | |
GtkBuildable* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkBuildable* | gobj () const |
Provides access to the underlying C GObject. More... | |
Glib::ustring | get_buildable_id () const |
Gets the ID of the buildable object. More... | |
![]() | |
ConstraintTarget (ConstraintTarget&& src) noexcept | |
ConstraintTarget& | operator= (ConstraintTarget&& src) noexcept |
~ConstraintTarget () noexcept override | |
GtkConstraintTarget* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkConstraintTarget* | gobj () const |
Provides access to the underlying C GObject. More... | |
![]() | |
Actionable (Actionable&& src) noexcept | |
Actionable& | operator= (Actionable&& src) noexcept |
~Actionable () noexcept override | |
GtkActionable* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkActionable* | gobj () const |
Provides access to the underlying C GObject. More... | |
Glib::ustring | get_action_name () const |
Gets the action name for actionable. More... | |
void | set_action_name (const Glib::ustring& action_name) |
Specifies the name of the action with which this widget should be associated. More... | |
Glib::VariantBase | get_action_target_value () |
Gets the current target value of actionable. More... | |
const Glib::VariantBase | get_action_target_value () const |
Gets the current target value of actionable. More... | |
void | set_action_target_value (const Glib::VariantBase& target_value) |
Sets the target value of an actionable widget. More... | |
void | set_detailed_action_name (const Glib::ustring& detailed_action_name) |
Sets the action-name and associated string target value of an actionable widget. More... | |
Glib::PropertyProxy< Glib::ustring > | property_action_name () |
The name of the associated action, like “app.quit”. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_action_name () const |
The name of the associated action, like “app.quit”. More... | |
Glib::PropertyProxy< Glib::VariantBase > | property_action_target () |
The parameter for action invocations. More... | |
Glib::PropertyProxy_ReadOnly< Glib::VariantBase > | property_action_target () const |
The parameter for action invocations. More... | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static void | set_default_direction (TextDirection dir) |
Sets the default reading direction for widgets. More... | |
static TextDirection | get_default_direction () |
Obtains the current default reading direction. More... | |
![]() | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
virtual void | on_toggled () |
This is a default handler for the signal signal_toggled(). More... | |
![]() | |
virtual void | root_vfunc () |
virtual void | unroot_vfunc () |
virtual void | size_allocate_vfunc (int width, int height, int baseline) |
virtual SizeRequestMode | get_request_mode_vfunc () const |
virtual void | measure_vfunc (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
virtual bool | grab_focus_vfunc () |
virtual void | set_focus_child_vfunc (Widget* child) |
Sets the focused child of widget. More... | |
virtual void | compute_expand_vfunc (bool& hexpand_p, bool& vexpand_p) |
virtual bool | contains_vfunc (double x, double y) const |
virtual void | snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
Widget () | |
void | realize () |
Creates the GDK resources associated with a widget. More... | |
void | unrealize () |
Causes a widget to be unrealized (frees all GDK resources associated with the widget). More... | |
void | realize_if_needed () |
void | set_focus_child (Widget& child) |
Set child as the current focus child of widget. More... | |
void | unset_focus_child () |
Unsets the focus child of the widget. More... | |
Widget* | get_focus_child () |
Returns the current focus child of widget. More... | |
const Widget* | get_focus_child () const |
Returns the current focus child of widget. More... | |
virtual void | on_show () |
This is a default handler for the signal signal_show(). More... | |
virtual void | on_hide () |
This is a default handler for the signal signal_hide(). More... | |
virtual void | on_map () |
This is a default handler for the signal signal_map(). More... | |
virtual void | on_unmap () |
This is a default handler for the signal signal_unmap(). More... | |
virtual void | on_realize () |
This is a default handler for the signal signal_realize(). More... | |
virtual void | on_unrealize () |
This is a default handler for the signal signal_unrealize(). More... | |
virtual void | on_state_flags_changed (Gtk::StateFlags previous_state_flags) |
This is a default handler for the signal signal_state_flags_changed(). More... | |
virtual void | on_direction_changed (TextDirection direction) |
This is a default handler for the signal signal_direction_changed(). More... | |
virtual bool | on_mnemonic_activate (bool group_cycling) |
This is a default handler for the signal signal_mnemonic_activate(). More... | |
virtual bool | on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip >& tooltip) |
This is a default handler for the signal signal_query_tooltip(). More... | |
![]() | |
Accessible () | |
You should derive from this class to use it. More... | |
![]() | |
Buildable () | |
You should derive from this class to use it. More... | |
![]() | |
ConstraintTarget () | |
You should derive from this class to use it. More... | |
![]() | |
Actionable () | |
You should derive from this class to use it. More... | |
virtual Glib::ustring | get_action_name_vfunc () const |
virtual void | set_action_name_vfunc (const Glib::ustring& action_name) |
virtual Glib::VariantBase | get_action_target_value_vfunc () const |
virtual void | set_action_target_value_vfunc (const Glib::VariantBase& action_target_value) |
Related Functions | |
(Note that these are not member functions.) | |
Gtk::CheckButton* | wrap (GtkCheckButton* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::Accessible > | wrap (GtkAccessible* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::ConstraintTarget > | wrap (GtkConstraintTarget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::Actionable > | wrap (GtkActionable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Create widgets with a discrete toggle button.
A Gtk::CheckButton places a label next to an indicator.
The CheckButton widget looks like this:
|
noexcept |
|
delete |
|
overridenoexcept |
Gtk::CheckButton::CheckButton | ( | ) |
Create an empty check button.
If you wish to add a Gtk::Label, you may want to use the Gtk::CheckButton(const Glib::ustring& label, bool mnemonic) constructor directly instead.
|
explicit |
Create a check button with a label.
bool Gtk::CheckButton::get_active | ( | ) | const |
Returns whether the check button is active.
bool Gtk::CheckButton::get_inconsistent | ( | ) | const |
Returns whether the check button is in an inconsistent state.
true
if check_button is currently in an inconsistent state. Glib::ustring Gtk::CheckButton::get_label | ( | ) | const |
Returns the label of the check button.
nullptr
will be returned.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
bool Gtk::CheckButton::get_use_underline | ( | ) | const |
Returns whether underlines in the label indicate mnemonics.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
|
protectedvirtual |
This is a default handler for the signal signal_toggled().
|
noexcept |
|
delete |
Glib::PropertyProxy< bool > Gtk::CheckButton::property_active | ( | ) |
If the check button is active.
Setting active
to true
will add the :checked:
state to both the check button and the indicator CSS node.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::CheckButton::property_active | ( | ) | const |
If the check button is active.
Setting active
to true
will add the :checked:
state to both the check button and the indicator CSS node.
Default value: false
Glib::PropertyProxy_WriteOnly< CheckButton* > Gtk::CheckButton::property_group | ( | ) |
The check button whose group this widget belongs to.
Glib::PropertyProxy< bool > Gtk::CheckButton::property_inconsistent | ( | ) |
If the check button is in an “in between” state.
The inconsistent state only affects visual appearance, not the semantics of the button.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::CheckButton::property_inconsistent | ( | ) | const |
If the check button is in an “in between” state.
The inconsistent state only affects visual appearance, not the semantics of the button.
Default value: false
Glib::PropertyProxy< Glib::ustring > Gtk::CheckButton::property_label | ( | ) |
Text of the label inside the check button, if it contains a label widget.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::CheckButton::property_label | ( | ) | const |
Text of the label inside the check button, if it contains a label widget.
Default value: ""
Glib::PropertyProxy< bool > Gtk::CheckButton::property_use_underline | ( | ) |
If set, an underline in the text indicates that the following character is to be used as mnemonic.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::CheckButton::property_use_underline | ( | ) | const |
If set, an underline in the text indicates that the following character is to be used as mnemonic.
Default value: false
void Gtk::CheckButton::set_active | ( | bool | setting = true | ) |
Changes the check buttons active state.
setting | The new value to set. |
void Gtk::CheckButton::set_group | ( | CheckButton& | group | ) |
Adds self to the group of group.
In a group of multiple check buttons, only one button can be active at a time. The behavior of a checkbutton in a group is also commonly known as a radio button.
Setting the group of a check button also changes the css name of the indicator widget's CSS node to 'radio'.
Setting up groups in a cycle leads to undefined behavior.
Note that the same effect can be achieved via the [iface Gtk.Actionable] API, by using the same action with parameter type and state type 's' for all buttons in the group, and giving each button its own target value.
group | Another GtkCheckButton to form a group with. |
void Gtk::CheckButton::set_inconsistent | ( | bool | inconsistent = true | ) |
Sets the GtkCheckButton
to inconsistent state.
You shoud turn off the inconsistent state again if the user checks the check button. This has to be done manually.
inconsistent | true if state is inconsistent. |
void Gtk::CheckButton::set_label | ( | const Glib::ustring & | label | ) |
Sets the text of self.
If [property Gtk.CheckButton:use-underline] is true
, an underscore in label is interpreted as mnemonic indicator, see [method Gtk.CheckButton.set_use_underline] for details on this behavior.
label | The text shown next to the indicator, or nullptr to show no text. |
void Gtk::CheckButton::set_use_underline | ( | bool | setting = true | ) |
Sets whether underlines in the label indicate mnemonics.
If setting is true
, an underscore character in self's label indicates a mnemonic accelerator key. This behavior is similar to [property Gtk.Label:use-underline].
setting | The new value to set. |
Glib::SignalProxy<void()> Gtk::CheckButton::signal_toggled | ( | ) |
void on_my_toggled()
Flags: Run First
Emitted when the buttons's [property Gtk.CheckButton:active] property changes.
void Gtk::CheckButton::unset_group | ( | ) |
|
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. |