Gtk::SpinButton Class Reference

Numeric Entry with up/down buttons. More...

#include <gtkmm/spinbutton.h>

Inheritance diagram for Gtk::SpinButton:

Public Types
enum class	UpdatePolicy {   ALWAYS ,   IF_VALID }
enum	{ INPUT_ERROR = -1 }
	Constant to return from a signal handler for the input signal in case of conversion failure. More...
Public Types inherited from Gtk::Widget
using	PreferredSize = MinimumNatural< Requisition >
	Structure returned by the non-output-parameter overload of get_preferred_size().
using	SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock > &)>
	Callback type for adding a function to update animations.
Public Types inherited from Gtk::Accessible
enum class	Role {   ALERT ,   ALERT_DIALOG ,   BANNER ,   BUTTON ,   CAPTION ,   CELL ,   CHECKBOX ,   COLUMN_HEADER ,   COMBO_BOX ,   COMMAND ,   COMPOSITE ,   DIALOG ,   DOCUMENT ,   FEED ,   FORM ,   GENERIC ,   GRID ,   GRID_CELL ,   GROUP ,   HEADING ,   IMG ,   INPUT ,   LABEL ,   LANDMARK ,   LEGEND ,   LINK ,   LIST ,   LIST_BOX ,   LIST_ITEM ,   LOG ,   MAIN ,   MARQUEE ,   MATH ,   METER ,   MENU ,   MENU_BAR ,   MENU_ITEM ,   MENU_ITEM_CHECKBOX ,   MENU_ITEM_RADIO ,   NAVIGATION ,   NONE ,   NOTE ,   OPTION ,   PRESENTATION ,   PROGRESS_BAR ,   RADIO ,   RADIO_GROUP ,   RANGE ,   REGION ,   ROW ,   ROW_GROUP ,   ROW_HEADER ,   SCROLLBAR ,   SEARCH ,   SEARCH_BOX ,   SECTION ,   SECTION_HEAD ,   SELECT ,   SEPARATOR ,   SLIDER ,   SPIN_BUTTON ,   STATUS ,   STRUCTURE ,   SWITCH ,   TAB ,   TABLE ,   TAB_LIST ,   TAB_PANEL ,   TEXT_BOX ,   TIME ,   TIMER ,   TOOLBAR ,   TOOLTIP ,   TREE ,   TREE_GRID ,   TREE_ITEM ,   WIDGET ,   WINDOW ,   TOGGLE_BUTTON ,   APPLICATION ,   PARAGRAPH ,   BLOCK_QUOTE ,   ARTICLE ,   COMMENT ,   TERMINAL }
enum class	State {   BUSY ,   CHECKED ,   DISABLED ,   EXPANDED ,   HIDDEN ,   INVALID ,   PRESSED ,   SELECTED ,   VISITED }
enum class	Property {   AUTOCOMPLETE ,   DESCRIPTION ,   HAS_POPUP ,   KEY_SHORTCUTS ,   LABEL ,   LEVEL ,   MODAL ,   MULTI_LINE ,   MULTI_SELECTABLE ,   ORIENTATION ,   PLACEHOLDER ,   READ_ONLY ,   REQUIRED ,   ROLE_DESCRIPTION ,   SORT ,   VALUE_MAX ,   VALUE_MIN ,   VALUE_NOW ,   VALUE_TEXT ,   HELP_TEXT }
enum class	Relation {   ACTIVE_DESCENDANT ,   COL_COUNT ,   COL_INDEX ,   COL_INDEX_TEXT ,   COL_SPAN ,   CONTROLS ,   DESCRIBED_BY ,   DETAILS ,   ERROR_MESSAGE ,   FLOW_TO ,   LABELLED_BY ,   OWNS ,   POS_IN_SET ,   ROW_COUNT ,   ROW_INDEX ,   ROW_INDEX_TEXT ,   ROW_SPAN ,   SET_SIZE }
enum class	PlatformState {   FOCUSABLE ,   FOCUSED ,   ACTIVE }
enum class	AnnouncementPriority {   LOW ,   MEDIUM ,   HIGH }

Public Member Functions
	SpinButton (SpinButton &&src) noexcept
SpinButton &	operator= (SpinButton &&src) noexcept
	SpinButton (const SpinButton &)=delete
SpinButton &	operator= (const SpinButton &)=delete
	~SpinButton () noexcept override
GtkSpinButton *	gobj ()
	Provides access to the underlying C GObject.
const GtkSpinButton *	gobj () const
	Provides access to the underlying C GObject.
	SpinButton (double climb_rate=0.0, guint digits=0)
	Creates a SpinButton.
	SpinButton (const Glib::RefPtr< Adjustment > &adjustment, double climb_rate=0.0, guint digits=0)
	Creates a SpinButton.
void	configure (const Glib::RefPtr< Adjustment > &adjustment, double climb_rate, guint digits)
	Changes the properties of an existing spin button.
void	set_activates_default (bool activates_default=true)
	Sets whether activating the spin button will activate the default widget for the window containing the spin button.
bool	get_activates_default () const
	Retrieves the value set by set_activates_default().
void	set_adjustment (const Glib::RefPtr< Adjustment > &adjustment)
	Replaces the Gtk::Adjustment associated with spin_button.
void	unset_adjustment ()
Glib::RefPtr< Adjustment >	get_adjustment ()
	Get the adjustment associated with a Gtk::SpinButton.
Glib::RefPtr< const Adjustment >	get_adjustment () const
	Get the adjustment associated with a Gtk::SpinButton.
void	set_digits (guint digits)
	Set the precision to be displayed by spin_button.
guint	get_digits () const
	Fetches the precision of spin_button.
void	set_increments (double step, double page)
	Sets the step and page increments for spin_button.
void	get_increments (double &step, double &page) const
	Gets the current step and page the increments used by spin_button.
void	set_range (double min, double max)
	Sets the minimum and maximum allowable values for spin_button.
void	get_range (double &min, double &max) const
	Gets the range allowed for spin_button.
double	get_value () const
	Get the value in the spin_button.
int	get_value_as_int () const
	Get the value spin_button represented as an integer.
void	set_value (double value)
	Sets the value of spin_button.
void	set_update_policy (UpdatePolicy policy)
	Sets the update behavior of a spin button.
UpdatePolicy	get_update_policy () const
	Gets the update behavior of a spin button.
void	set_numeric (bool numeric=true)
	Sets the flag that determines if non-numeric text can be typed into the spin button.
bool	get_numeric () const
	Returns whether non-numeric text can be typed into the spin button.
void	spin (SpinType direction, double increment)
	Increment or decrement a spin button’s value in a specified direction by a specified amount.
void	set_wrap (bool wrap=true)
	Sets the flag that determines if a spin button value wraps around to the opposite limit when the upper or lower limit of the range is exceeded.
bool	get_wrap () const
	Returns whether the spin button’s value wraps around to the opposite limit when the upper or lower limit of the range is exceeded.
void	set_snap_to_ticks (bool snap_to_ticks=true)
	Sets the policy as to whether values are corrected to the nearest step increment when a spin button is activated after providing an invalid value.
bool	get_snap_to_ticks () const
	Returns whether the values are corrected to the nearest step.
void	set_climb_rate (double climb_rate)
	Sets the acceleration rate for repeated changes when you hold down a button or key.
double	get_climb_rate () const
	Returns the acceleration rate for repeated changes.
void	update ()
	Manually force an update of the spin button.
Glib::SignalProxy< int(double &)>	signal_input ()
Glib::SignalProxy< bool()>	signal_output ()
Glib::SignalProxy< void()>	signal_wrapped ()
Glib::SignalProxy< void()>	signal_value_changed ()
Glib::SignalProxy< void()>	signal_activate ()
Glib::PropertyProxy< bool >	property_activates_default ()
	Whether to activate the default widget when the spin button is activated.
Glib::PropertyProxy_ReadOnly< bool >	property_activates_default () const
	Whether to activate the default widget when the spin button is activated.
Glib::PropertyProxy< Glib::RefPtr< Adjustment > >	property_adjustment ()
	The adjustment that holds the value of the spin button.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > >	property_adjustment () const
	The adjustment that holds the value of the spin button.
Glib::PropertyProxy< double >	property_climb_rate ()
	The acceleration rate when you hold down a button or key.
Glib::PropertyProxy_ReadOnly< double >	property_climb_rate () const
	The acceleration rate when you hold down a button or key.
Glib::PropertyProxy< guint >	property_digits ()
	The number of decimal places to display.
Glib::PropertyProxy_ReadOnly< guint >	property_digits () const
	The number of decimal places to display.
Glib::PropertyProxy< bool >	property_snap_to_ticks ()
	Whether erroneous values are automatically changed to the spin buttons nearest step increment.
Glib::PropertyProxy_ReadOnly< bool >	property_snap_to_ticks () const
	Whether erroneous values are automatically changed to the spin buttons nearest step increment.
Glib::PropertyProxy< bool >	property_numeric ()
	Whether non-numeric characters should be ignored.
Glib::PropertyProxy_ReadOnly< bool >	property_numeric () const
	Whether non-numeric characters should be ignored.
Glib::PropertyProxy< bool >	property_wrap ()
	Whether a spin button should wrap upon reaching its limits.
Glib::PropertyProxy_ReadOnly< bool >	property_wrap () const
	Whether a spin button should wrap upon reaching its limits.
Glib::PropertyProxy< UpdatePolicy >	property_update_policy ()
	Whether the spin button should update always, or only when the value is acceptable.
Glib::PropertyProxy_ReadOnly< UpdatePolicy >	property_update_policy () const
	Whether the spin button should update always, or only when the value is acceptable.
Glib::PropertyProxy< double >	property_value ()
	The current value.
Glib::PropertyProxy_ReadOnly< double >	property_value () const
	The current value.
Public Member Functions inherited from Gtk::Widget
	Widget (Widget &&src) noexcept
Widget &	operator= (Widget &&src) noexcept
	Widget (const Widget &)=delete
Widget &	operator= (const Widget &)=delete
	~Widget () noexcept override
	Destroys the widget.
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 show().
void	queue_draw ()
	Schedules this widget to be redrawn in the paint phase of the current or the next frame.
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 delegate instance that provides an implementation for measuring and allocating the children of 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 used by widget.
Glib::RefPtr< const LayoutManager >	get_layout_manager () const
	Retrieves the layout manager used by 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)
	Specifies 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 widget or any of its children.
void	set_focusable (bool focusable=true)
	Specifies whether widget can own the input focus.
bool	get_focusable () const
	Determines whether 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 Gtk::Window it's inside.
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 widget can be the target of pointer events.
bool	get_can_target () const
	Queries whether widget can be the target of pointer events.
bool	has_default () const
	Determines whether widget is the current default widget within its toplevel.
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.
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.
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 a 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 widget can be drawn to.
bool	get_realized () const
	Determines whether widget is realized.
bool	get_mapped () const
	Whether the widget is mapped.
void	set_child_visible (bool visible=true)
	Sets whether 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 widget.
int	get_allocated_height () const
	Returns the height that has currently been allocated to widget.
int	get_allocated_baseline () const
	Returns the baseline that has currently been allocated to 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 widget.
int	get_size (Orientation orientation) const
	Returns the content width or height of the widget.
Widget *	get_parent ()
	Returns the parent widget of widget.
const Widget *	get_parent () const
	Returns the parent widget of widget.
Root *	get_root ()
	Returns the Gtk::Root widget of widget.
const Root *	get_root () const
	Returns the Gtk::Root widget of widget.
Native *	get_native ()
	Returns the nearest Gtk::Native ancestor of widget.
const Native *	get_native () const
	Returns the nearest Gtk::Native ancestor of 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 keynav-failed signal on the widget.
void	error_bell ()
	Notifies the user about an input-related error on this widget.
void	set_size_request (int width=-1, int height=-1)
	Sets the minimum size of a widget.
void	get_size_request (int & width, int &height) const
	Gets the size request that was explicitly set for the widget using set_size_request().
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)
	Request the widget to be rendered partially transparent.
double	get_opacity () const
	Fetches the requested opacity for this widget.
void	set_overflow (Overflow overflow)
	Sets how widget treats content that is drawn outside the widget's content area.
Overflow	get_overflow () const
	Returns the widget’s overflow value.
Widget *	get_ancestor (GType widget_type)
	Gets the first ancestor of widget with type widget_type.
const Widget *	get_ancestor (GType widget_type) const
	Gets the first ancestor of 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 Gdk::Display for the toplevel window associated with this widget.
Glib::RefPtr< const Gdk::Display >	get_display () const
	Get the Gdk::Display for the toplevel window associated with this widget.
Glib::RefPtr< Settings >	get_settings ()
	Gets the settings object holding the settings used for this widget.
Glib::RefPtr< Gdk::Clipboard >	get_clipboard ()
	Gets the clipboard object for widget.
Glib::RefPtr< const Gdk::Clipboard >	get_clipboard () const
	Gets the clipboard object for widget.
Glib::RefPtr< Gdk::Clipboard >	get_primary_clipboard ()
	Gets the primary clipboard of widget.
Glib::RefPtr< const Gdk::Clipboard >	get_primary_clipboard () const
	Gets the primary clipboard of 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 set_hexpand() has been used to explicitly set the expand flag on this widget.
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 set_vexpand() has been used to explicitly set the expand flag on this widget.
void	set_vexpand_set (bool set=true)
	Sets whether the vexpand flag will be used.
bool	compute_expand (Orientation orientation)
	Computes whether a container 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 widget.
void	set_halign (Align align)
	Sets the horizontal alignment of widget.
Align	get_valign () const
	Gets the vertical alignment of widget.
void	set_valign (Align align)
	Sets the vertical alignment of widget.
int	get_margin_start () const
	Gets the start margin of widget.
void	set_margin_start (int margin)
	Sets the start margin of widget.
int	get_margin_end () const
	Gets the end margin of widget.
void	set_margin_end (int margin)
	Sets the end margin of widget.
int	get_margin_top () const
	Gets the top margin of widget.
void	set_margin_top (int margin)
	Sets the top margin of widget.
int	get_margin_bottom () const
	Gets the bottom margin of widget.
void	set_margin_bottom (int margin)
	Sets the bottom margin of widget.
void	set_margin (int margin)
	Set all 4 margins to the same value.
bool	is_ancestor (Widget &ancestor) const
	Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.
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.
bool	contains (double x, double y) const
	Tests if the point at ( x, y) is contained in widget.
Widget *	pick (double x, double y, PickFlags flags=PickFlags::DEFAULT)
	Finds the descendant of widget closest to the point ( x, y).
const Widget *	pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const
	Finds the descendant of widget closest to the point ( x, y).
void	add_controller (const Glib::RefPtr< EventController > &controller)
	Adds controller to widget so that it will receive events.
void	remove_controller (const Glib::RefPtr< EventController > &controller)
	Removes controller from widget, so that it doesn't process events anymore.
Glib::RefPtr< Pango::Context >	create_pango_context ()
	Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
Glib::RefPtr< Pango::Context >	get_pango_context ()
	Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget.
void	set_font_options (const Cairo::FontOptions &options)
	Sets the cairo_font_options_t used for Pango rendering in this 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 widget.
Glib::RefPtr< Pango::Layout >	create_pango_layout (const Glib::ustring &text)
	Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget.
void	set_direction (TextDirection dir)
	Sets the reading direction on a particular widget.
TextDirection	get_direction () const
	Gets the reading direction for a particular widget.
void	set_cursor (const Glib::RefPtr< Gdk::Cursor > &cursor)
	Sets the cursor to be shown when pointer devices point towards 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 ()
	Queries the cursor set on widget.
Glib::RefPtr< const Gdk::Cursor >	get_cursor () const
	Queries the cursor set on 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 parent as the parent widget of widget.
void	unparent ()
	Dissociate 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 where the toplevel of widget is located.
void	set_tooltip_text (const Glib::ustring &text)
	Sets text as the contents of the tooltip.
Glib::ustring	get_tooltip_text () const
	Gets the contents of the tooltip for widget.
void	set_tooltip_markup (const Glib::ustring &markup)
	Sets markup as the contents of the tooltip, which is marked up with Pango markup.
Glib::ustring	get_tooltip_markup () const
	Gets the contents of the tooltip for widget.
void	set_has_tooltip (bool has_tooltip=TRUE)
	Sets the has-tooltip property on widget to has_tooltip.
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 widget.
Glib::RefPtr< const StyleContext >	get_style_context () const
	Returns the style context associated to 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 group into widget.
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 from widget.
void	set_font_map (const Glib::RefPtr< Pango::FontMap > &font_map)
	Sets the font map to use for Pango rendering.
Glib::RefPtr< Pango::FontMap >	get_font_map ()
	Gets the font map of widget.
Glib::RefPtr< const Pango::FontMap >	get_font_map () const
	Gets the font map of 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 Gio::ListModel to track the children of widget.
Glib::RefPtr< const Gio::ListModel >	observe_children () const
	Returns a Gio::ListModel to track the children of widget.
Glib::RefPtr< Gio::ListModel >	observe_controllers ()
	Returns a Gio::ListModel to track the Gtk::EventControllers of widget.
Glib::RefPtr< const Gio::ListModel >	observe_controllers () const
	Returns a Gio::ListModel to track the Gtk::EventControllers of 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)
	Snapshot the a child of widget.
bool	should_layout () const
	Returns whether widget should contribute to the measuring and allocation of its parent.
Glib::ustring	get_css_name () const
	Returns the CSS name that is used for self.
void	add_css_class (const Glib::ustring &css_class)
	Adds a style class to widget.
void	remove_css_class (const Glib::ustring &css_class)
	Removes a style from widget.
bool	has_css_class (const Glib::ustring &css_class) const
	Returns whether css_class is currently applied to widget.
std::vector< Glib::ustring >	get_css_classes () const
	Returns the list of style classes applied to widget.
void	set_css_classes (const std::vector< Glib::ustring > &classes)
	Clear all style classes applied to widget and replace them with classes.
Gdk::RGBA	get_color () const
	Gets the current foreground color for the widget's CSS style.
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 ()
	Override for width request of the widget.
Glib::PropertyProxy_ReadOnly< int >	property_width_request () const
	Override for width request of the widget.
Glib::PropertyProxy< int >	property_height_request ()
	Override for height request of the widget.
Glib::PropertyProxy_ReadOnly< int >	property_height_request () const
	Override 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.
Public Member Functions inherited from Gtk::Object
	Object (Object &&src) noexcept
Object &	operator= (Object &&src) noexcept
	~Object () noexcept override
Public Member Functions inherited from Gtk::Accessible
	Accessible (Accessible &&src) noexcept
Accessible &	operator= (Accessible &&src) noexcept
	~Accessible () noexcept override
GtkAccessible *	gobj ()
	Provides access to the underlying C GObject.
const GtkAccessible *	gobj () const
	Provides access to the underlying C GObject.
Glib::RefPtr< ATContext >	get_at_context ()
	Retrieves the accessible implementation for the given Gtk::Accessible.
Glib::RefPtr< const ATContext >	get_at_context () const
	Retrieves the accessible implementation for the given Gtk::Accessible.
bool	get_platform_state (PlatformState state) const
	Query a platform state, such as focus.
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 of self.
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.
Public Member Functions inherited from Gtk::Buildable
	Buildable (Buildable &&src) noexcept
Buildable &	operator= (Buildable &&src) noexcept
	~Buildable () noexcept override
GtkBuildable *	gobj ()
	Provides access to the underlying C GObject.
const GtkBuildable *	gobj () const
	Provides access to the underlying C GObject.
Glib::ustring	get_buildable_id () const
	Gets the ID of the buildable object.
Public Member Functions inherited from Gtk::ConstraintTarget
	ConstraintTarget (ConstraintTarget &&src) noexcept
ConstraintTarget &	operator= (ConstraintTarget &&src) noexcept
	~ConstraintTarget () noexcept override
GtkConstraintTarget *	gobj ()
	Provides access to the underlying C GObject.
const GtkConstraintTarget *	gobj () const
	Provides access to the underlying C GObject.
Public Member Functions inherited from Gtk::Orientable
	Orientable (Orientable &&src) noexcept
Orientable &	operator= (Orientable &&src) noexcept
	~Orientable () noexcept override
GtkOrientable *	gobj ()
	Provides access to the underlying C GObject.
const GtkOrientable *	gobj () const
	Provides access to the underlying C GObject.
void	set_orientation (Orientation orientation)
	Sets the orientation of the orientable.
Orientation	get_orientation () const
	Retrieves the orientation of the orientable.
Glib::PropertyProxy< Orientation >	property_orientation ()
	The orientation of the orientable.
Glib::PropertyProxy_ReadOnly< Orientation >	property_orientation () const
	The orientation of the orientable.
Public Member Functions inherited from Gtk::Editable
	Editable (Editable &&src) noexcept
Editable &	operator= (Editable &&src) noexcept
	~Editable () noexcept override
GtkEditable *	gobj ()
	Provides access to the underlying C GObject.
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).
Public Member Functions inherited from Gtk::CellEditable
	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 Public Member Functions inherited from Gtk::Widget
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
static void	set_default_direction (TextDirection dir)
	Sets the default reading direction for widgets.
static TextDirection	get_default_direction ()
	Obtains the current default reading direction.
Static Public Member Functions inherited from Gtk::Accessible
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
Static Public Member Functions inherited from Gtk::Buildable
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
Static Public Member Functions inherited from Gtk::ConstraintTarget
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
Static Public Member Functions inherited from Gtk::Orientable
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 Public Member Functions inherited from Gtk::Editable
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
Static Public Member Functions inherited from Gtk::CellEditable
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.

Related Symbols
(Note that these are not member symbols.)
Gtk::SpinButton *	wrap (GtkSpinButton *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::Widget
Gtk::Widget *	wrap (GtkWidget *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::Accessible
Glib::RefPtr< Gtk::Accessible >	wrap (GtkAccessible *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::Buildable
Glib::RefPtr< Gtk::Buildable >	wrap (GtkBuildable *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::ConstraintTarget
Glib::RefPtr< Gtk::ConstraintTarget >	wrap (GtkConstraintTarget *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::Orientable
Glib::RefPtr< Gtk::Orientable >	wrap (GtkOrientable *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::Editable
Glib::RefPtr< Gtk::Editable >	wrap (GtkEditable *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::CellEditable
Glib::RefPtr< Gtk::CellEditable >	wrap (GtkCellEditable *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Additional Inherited Members
Protected Member Functions inherited from Gtk::Widget
virtual void	root_vfunc ()
virtual void	unroot_vfunc ()
virtual void	size_allocate_vfunc (int width, int height, int baseline)
virtual SizeRequestMode	get_request_mode_vfunc () const
virtual void	measure_vfunc (Orientation orientation, int for_size, int & minimum, int & natural, int &minimum_baseline, int &natural_baseline) const
virtual bool	grab_focus_vfunc ()
virtual void	set_focus_child_vfunc (Widget *child)
	Sets the focused child of widget.
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.
void	unrealize ()
	Causes a widget to be unrealized (frees all GDK resources associated with the widget).
void	realize_if_needed ()
void	set_focus_child (Widget &child)
	Set child as the current focus child of widget.
void	unset_focus_child ()
	Unsets the focus child of the widget.
Widget *	get_focus_child ()
	Returns the current focus child of widget.
const Widget *	get_focus_child () const
	Returns the current focus child of widget.
virtual void	on_show ()
	This is a default handler for the signal signal_show().
virtual void	on_hide ()
	This is a default handler for the signal signal_hide().
virtual void	on_map ()
	This is a default handler for the signal signal_map().
virtual void	on_unmap ()
	This is a default handler for the signal signal_unmap().
virtual void	on_realize ()
	This is a default handler for the signal signal_realize().
virtual void	on_unrealize ()
	This is a default handler for the signal signal_unrealize().
virtual void	on_state_flags_changed (Gtk::StateFlags previous_state_flags)
	This is a default handler for the signal signal_state_flags_changed().
virtual void	on_direction_changed (TextDirection direction)
	This is a default handler for the signal signal_direction_changed().
virtual bool	on_mnemonic_activate (bool group_cycling)
	This is a default handler for the signal signal_mnemonic_activate().
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().
Protected Member Functions inherited from Gtk::Accessible
	Accessible ()
	You should derive from this class to use it.
Protected Member Functions inherited from Gtk::Buildable
	Buildable ()
	You should derive from this class to use it.
Protected Member Functions inherited from Gtk::ConstraintTarget
	ConstraintTarget ()
	You should derive from this class to use it.
Protected Member Functions inherited from Gtk::Orientable
	Orientable ()
	You should derive from this class to use it.
Protected Member Functions inherited from Gtk::Editable
	Editable ()
	You should derive from this class to use it.
virtual void	delete_text_vfunc (int start_pos, int end_pos)
virtual Glib::ustring	get_text_vfunc () const
virtual void	select_region_vfunc (int start_pos, int end_pos)
virtual bool	get_selection_bounds_vfunc (int &start_pos, int &end_pos) const
virtual void	insert_text_vfunc (const Glib::ustring &text, int & position)
virtual void	on_insert_text (const Glib::ustring &text, int * position)
	This is a default handler for the signal signal_insert_text().
virtual void	on_delete_text (int start_pos, int end_pos)
	This is a default handler for the signal signal_delete_text().
virtual void	on_changed ()
	This is a default handler for the signal signal_changed().
Protected Member Functions inherited from Gtk::CellEditable
	CellEditable ()
	You should derive from this class to use it.
virtual void	start_editing_vfunc (const Glib::RefPtr< const Gdk::Event > & event)
virtual void	on_editing_done ()
	This is a default handler for the signal signal_editing_done().
virtual void	on_remove_widget ()
	This is a default handler for the signal signal_remove_widget().

Detailed Description

Numeric Entry with up/down buttons.

Slightly misnamed, this should be called a SpinEntry.

The SpinButton widget looks like this:

Member Enumeration Documentation

UpdatePolicy

enum class Gtk::SpinButton::UpdatePolicy

strong

Enumerator
ALWAYS	When refreshing your Gtk::SpinButton, the value is always displayed.
IF_VALID	When refreshing your Gtk::SpinButton, the value is only displayed if it is valid within the bounds of the spin button's adjustment.

Constructor & Destructor Documentation

SpinButton() [1/4]

Gtk::SpinButton::SpinButton ( SpinButton &&  src )

noexcept

SpinButton() [2/4]

Gtk::SpinButton::SpinButton ( const SpinButton &  )

delete

~SpinButton()

Gtk::SpinButton::~SpinButton ( )

overridenoexcept

SpinButton() [3/4]

Gtk::SpinButton::SpinButton ( double  climb_rate = 0.0, guint  digits = 0  )

explicit

Creates a SpinButton.

Parameters

climb_rate	The acceleration rate when you hold down a button.
digits	The number of decimal places to display.

SpinButton() [4/4]

Gtk::SpinButton::SpinButton ( const Glib::RefPtr< Adjustment > &  adjustment, double  climb_rate = 0.0, guint  digits = 0  )

explicit

Creates a SpinButton.

Parameters

adjustment	The Adjustment object that this spin button should use.
climb_rate	The acceleration rate when you hold down a button.
digits	The number of decimal places to display.

Member Function Documentation

configure()

void Gtk::SpinButton::configure	(	const Glib::RefPtr< Adjustment > &	adjustment,
		double	climb_rate,
		guint	digits
	)

Changes the properties of an existing spin button.

The adjustment, climb rate, and number of decimal places are updated accordingly.

Parameters

adjustment	A Gtk::Adjustment to replace the spin button’s existing adjustment, or nullptr to leave its current adjustment unchanged.
climb_rate	The new climb rate.
digits	The number of decimal places to display in the spin button.

get_activates_default()

bool Gtk::SpinButton::get_activates_default

(

)

const

Retrieves the value set by set_activates_default().

Since gtkmm 4.14:

Returns

true if the spin button will activate the default widget.

get_adjustment() [1/2]

Glib::RefPtr< Adjustment > Gtk::SpinButton::get_adjustment

(

)

Get the adjustment associated with a Gtk::SpinButton.

Returns

The Gtk::Adjustment of spin_button.

get_adjustment() [2/2]

Glib::RefPtr< const Adjustment > Gtk::SpinButton::get_adjustment

(

)

const

Get the adjustment associated with a Gtk::SpinButton.

Returns

The Gtk::Adjustment of spin_button.

get_climb_rate()

double Gtk::SpinButton::get_climb_rate

(

)

const

Returns the acceleration rate for repeated changes.

Returns

The acceleration rate.

get_digits()

guint Gtk::SpinButton::get_digits

(

)

const

Fetches the precision of spin_button.

Returns

The current precision.

get_increments()

void Gtk::SpinButton::get_increments	(	double &	step,
		double &	page
	)		const

Gets the current step and page the increments used by spin_button.

See set_increments().

Parameters

step	Location to store step increment.
page	Location to store page increment.

get_numeric()

bool Gtk::SpinButton::get_numeric

(

)

const

Returns whether non-numeric text can be typed into the spin button.

Returns

true if only numeric text can be entered.

get_range()

void Gtk::SpinButton::get_range	(	double &	min,
		double &	max
	)		const

Gets the range allowed for spin_button.

See set_range().

Parameters

min	Location to store minimum allowed value.
max	Location to store maximum allowed value.

get_snap_to_ticks()

bool Gtk::SpinButton::get_snap_to_ticks

(

)

const

Returns whether the values are corrected to the nearest step.

Returns

true if values are snapped to the nearest step.

get_type()

static GType Gtk::SpinButton::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

get_update_policy()

UpdatePolicy Gtk::SpinButton::get_update_policy

(

)

const

Gets the update behavior of a spin button.

See set_update_policy().

Returns

The current update policy.

get_value()

double Gtk::SpinButton::get_value

(

)

const

Get the value in the spin_button.

Returns

The value of spin_button.

get_value_as_int()

int Gtk::SpinButton::get_value_as_int

(

)

const

Get the value spin_button represented as an integer.

Returns

The value of spin_button.

get_wrap()

bool Gtk::SpinButton::get_wrap

(

)

const

Returns whether the spin button’s value wraps around to the opposite limit when the upper or lower limit of the range is exceeded.

Returns

true if the spin button wraps around.

gobj() [1/2]

GtkSpinButton * Gtk::SpinButton::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GtkSpinButton * Gtk::SpinButton::gobj ( ) const

inline

Provides access to the underlying C GObject.

operator=() [1/2]

SpinButton & Gtk::SpinButton::operator= ( const SpinButton &  )

delete

operator=() [2/2]

SpinButton & Gtk::SpinButton::operator= ( SpinButton &&  src )

noexcept

property_activates_default() [1/2]

Glib::PropertyProxy< bool > Gtk::SpinButton::property_activates_default

(

)

Whether to activate the default widget when the spin button is activated.

See signal_activate() for what counts as activation.

Since gtkmm 4.14:

Default value: false

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_activates_default() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::SpinButton::property_activates_default

(

)

const

Whether to activate the default widget when the spin button is activated.

See signal_activate() for what counts as activation.

Since gtkmm 4.14:

Default value: false

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_adjustment() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Adjustment > > Gtk::SpinButton::property_adjustment

(

)

The adjustment that holds the value of the spin button.

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_adjustment() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Adjustment > > Gtk::SpinButton::property_adjustment

(

)

const

The adjustment that holds the value of the spin button.

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_climb_rate() [1/2]

Glib::PropertyProxy< double > Gtk::SpinButton::property_climb_rate

(

)

The acceleration rate when you hold down a button or key.

Default value: 0

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_climb_rate() [2/2]

Glib::PropertyProxy_ReadOnly< double > Gtk::SpinButton::property_climb_rate

(

)

const

The acceleration rate when you hold down a button or key.

Default value: 0

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_digits() [1/2]

Glib::PropertyProxy< guint > Gtk::SpinButton::property_digits

(

)

The number of decimal places to display.

Default value: 0

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_digits() [2/2]

Glib::PropertyProxy_ReadOnly< guint > Gtk::SpinButton::property_digits

(

)

const

The number of decimal places to display.

Default value: 0

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_numeric() [1/2]

Glib::PropertyProxy< bool > Gtk::SpinButton::property_numeric

(

)

Whether non-numeric characters should be ignored.

Default value: false

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_numeric() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::SpinButton::property_numeric

(

)

const

Whether non-numeric characters should be ignored.

Default value: false

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_snap_to_ticks() [1/2]

Glib::PropertyProxy< bool > Gtk::SpinButton::property_snap_to_ticks

(

)

Whether erroneous values are automatically changed to the spin buttons nearest step increment.

Default value: false

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_snap_to_ticks() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::SpinButton::property_snap_to_ticks

(

)

const

Whether erroneous values are automatically changed to the spin buttons nearest step increment.

Default value: false

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_update_policy() [1/2]

Glib::PropertyProxy< UpdatePolicy > Gtk::SpinButton::property_update_policy

(

)

Whether the spin button should update always, or only when the value is acceptable.

Default value: Gtk::SpinButton::UpdatePolicy::ALWAYS

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_update_policy() [2/2]

Glib::PropertyProxy_ReadOnly< UpdatePolicy > Gtk::SpinButton::property_update_policy

(

)

const

Whether the spin button should update always, or only when the value is acceptable.

Default value: Gtk::SpinButton::UpdatePolicy::ALWAYS

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_value() [1/2]

Glib::PropertyProxy< double > Gtk::SpinButton::property_value

(

)

The current value.

Default value: 0

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_value() [2/2]

Glib::PropertyProxy_ReadOnly< double > Gtk::SpinButton::property_value

(

)

const

The current value.

Default value: 0

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_wrap() [1/2]

Glib::PropertyProxy< bool > Gtk::SpinButton::property_wrap

(

)

Whether a spin button should wrap upon reaching its limits.

Default value: false

Returns

A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

property_wrap() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::SpinButton::property_wrap

(

)

const

Whether a spin button should wrap upon reaching its limits.

Default value: false

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

set_activates_default()

void Gtk::SpinButton::set_activates_default

(

bool

activates_default = true

)

Sets whether activating the spin button will activate the default widget for the window containing the spin button.

See signal_activate() for what counts as activation.

Since gtkmm 4.14:

Parameters

activates_default

true to activate window’s default widget on activation.

set_adjustment()

void Gtk::SpinButton::set_adjustment

(

const Glib::RefPtr< Adjustment > &

adjustment

)

Replaces the Gtk::Adjustment associated with spin_button.

Parameters

adjustment

A Gtk::Adjustment to replace the existing adjustment.

set_climb_rate()

void Gtk::SpinButton::set_climb_rate

(

double

climb_rate

)

Sets the acceleration rate for repeated changes when you hold down a button or key.

Parameters

climb_rate

The rate of acceleration, must be >= 0.

set_digits()

void Gtk::SpinButton::set_digits

(

guint

digits

)

Set the precision to be displayed by spin_button.

Up to 20 digit precision is allowed.

Parameters

digits

The number of digits after the decimal point to be displayed for the spin button’s value.

set_increments()

void Gtk::SpinButton::set_increments	(	double	step,
		double	page
	)

Sets the step and page increments for spin_button.

This affects how quickly the value changes when the spin button’s arrows are activated.

Parameters

step	Increment applied for a button 1 press.
page	Increment applied for a button 2 press.

set_numeric()

void Gtk::SpinButton::set_numeric

(

bool

numeric = true

)

Sets the flag that determines if non-numeric text can be typed into the spin button.

Parameters

numeric

Flag indicating if only numeric entry is allowed.

set_range()

void Gtk::SpinButton::set_range	(	double	min,
		double	max
	)

Sets the minimum and maximum allowable values for spin_button.

If the current value is outside this range, it will be adjusted to fit within the range, otherwise it will remain unchanged.

Parameters

min	Minimum allowable value.
max	Maximum allowable value.

set_snap_to_ticks()

void Gtk::SpinButton::set_snap_to_ticks

(

bool

snap_to_ticks = true

)

Sets the policy as to whether values are corrected to the nearest step increment when a spin button is activated after providing an invalid value.

Parameters

snap_to_ticks

A flag indicating if invalid values should be corrected.

set_update_policy()

void Gtk::SpinButton::set_update_policy

(

UpdatePolicy

policy

)

Sets the update behavior of a spin button.

This determines whether the spin button is always updated or only when a valid value is set.

Parameters

policy

A Gtk::SpinButton::UpdatePolicy value.

set_value()

void Gtk::SpinButton::set_value

(

double

value

)

Sets the value of spin_button.

Parameters

value

The new value.

set_wrap()

void Gtk::SpinButton::set_wrap

(

bool

wrap = true

)

Sets the flag that determines if a spin button value wraps around to the opposite limit when the upper or lower limit of the range is exceeded.

Parameters

wrap	A flag indicating if wrapping behavior is performed.

signal_activate()

Glib::SignalProxy< void()> Gtk::SpinButton::signal_activate

(

)

Slot Prototype:

void on_my_activate()

Flags: Run Last, Action

Emitted when the spin button is activated.

The keybindings for this signal are all forms of the Enter key.

If the Enter key results in the value being committed to the spin button, then activation does not occur until Enter is pressed again.

Since gtkmm 4.14:

signal_input()

Glib::SignalProxy< int(double &)> Gtk::SpinButton::signal_input

(

)

Slot Prototype:

int on_my_input(double& new_value)

Flags: Run Last

Emitted to convert the users input into a double value.

The signal handler is expected to use Gtk::Editable::get_text() to retrieve the text of the spinbutton and set new_value to the new value.

The default conversion uses Glib::strtod().

Parameters

new_value

Return location for the new value.

Returns

true for a successful conversion, false if the input was not handled, and GTK_INPUT_ERROR if the conversion failed.

signal_output()

Glib::SignalProxy< bool()> Gtk::SpinButton::signal_output

(

)

Slot Prototype:

bool on_my_output()

Flags: Run Last

Emitted to tweak the formatting of the value for display.

[C example ellipted]

Returns

true if the value has been displayed.

signal_value_changed()

Glib::SignalProxy< void()> Gtk::SpinButton::signal_value_changed

(

)

Slot Prototype:

void on_my_value_changed()

Flags: Run Last

Emitted when the value is changed.

Also see the signal_output() signal.

signal_wrapped()

Glib::SignalProxy< void()> Gtk::SpinButton::signal_wrapped

(

)

Slot Prototype:

void on_my_wrapped()

Flags: Run Last

Emitted right after the spinbutton wraps from its maximum to its minimum value or vice-versa.

spin()

void Gtk::SpinButton::spin	(	SpinType	direction,
		double	increment
	)

Increment or decrement a spin button’s value in a specified direction by a specified amount.

Parameters

direction	A Gtk::SpinType indicating the direction to spin.
increment	Step increment to apply in the specified direction.

unset_adjustment()

void Gtk::SpinButton::unset_adjustment

(

)

update()

void Gtk::SpinButton::update

(

)

Manually force an update of the spin button.

Friends And Related Symbol Documentation

wrap()

Gtk::SpinButton * wrap ( GtkSpinButton *  object, bool  take_copy = false  )

related

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns

A C++ instance that wraps this C instance.