Class

GtkSpinButton

Description [src]

final class Gtk.SpinButton : Gtk.Widget
  implements Gtk.Accessible, Gtk.AccessibleRange, Gtk.Buildable, Gtk.CellEditable, Gtk.ConstraintTarget, Gtk.Editable, Gtk.Orientable {
  /* No available fields */
}

A GtkSpinButton is an ideal way to allow the user to set the value of some attribute.

An example GtkSpinButton

Rather than having to directly type a number into a GtkEntry, GtkSpinButton allows the user to click on one of two arrows to increment or decrement the displayed value. A value can still be typed in, with the bonus that it can be checked to ensure it is in a given range.

The main properties of a GtkSpinButton are through an adjustment. See the GtkAdjustment documentation for more details about an adjustment’s properties.

Note that GtkSpinButton will by default make its entry large enough to accommodate the lower and upper bounds of the adjustment. If this is not desired, the automatic sizing can be turned off by explicitly setting GtkEditable:width-chars to a value != -1.

Using a GtkSpinButton to get an integer

// Provides a function to retrieve an integer value from a GtkSpinButton
// and creates a spin button to model percentage values.

int
grab_int_value (GtkSpinButton *button,
                gpointer       user_data)
{
  return gtk_spin_button_get_value_as_int (button);
}

void
create_integer_spin_button (void)
{

  GtkWidget *window, *button;
  GtkAdjustment *adjustment;

  adjustment = gtk_adjustment_new (50.0, 0.0, 100.0, 1.0, 5.0, 0.0);

  window = gtk_window_new ();

  // creates the spinbutton, with no decimal places
  button = gtk_spin_button_new (adjustment, 1.0, 0);
  gtk_window_set_child (GTK_WINDOW (window), button);

  gtk_window_present (GTK_WINDOW (window));
}

Using a GtkSpinButton to get a floating point value

// Provides a function to retrieve a floating point value from a
// GtkSpinButton, and creates a high precision spin button.

float
grab_float_value (GtkSpinButton *button,
                  gpointer       user_data)
{
  return gtk_spin_button_get_value (button);
}

void
create_floating_spin_button (void)
{
  GtkWidget *window, *button;
  GtkAdjustment *adjustment;

  adjustment = gtk_adjustment_new (2.500, 0.0, 5.0, 0.001, 0.1, 0.0);

  window = gtk_window_new ();

  // creates the spinbutton, with three decimal places
  button = gtk_spin_button_new (adjustment, 0.001, 3);
  gtk_window_set_child (GTK_WINDOW (window), button);

  gtk_window_present (GTK_WINDOW (window));
}

Shortcuts and Gestures

The following signals have default keybindings:

GtkSpinButton::change-value

CSS nodes

spinbutton.horizontal
├── text
│    ├── undershoot.left
│    ╰── undershoot.right
├── button.down
╰── button.up

spinbutton.vertical
├── button.up
├── text
│    ├── undershoot.left
│    ╰── undershoot.right
╰── button.down

GtkSpinButtons main CSS node has the name spinbutton. It creates subnodes for the entry and the two buttons, with these names. The button nodes have the style classes .up and .down. The GtkText subnodes (if present) are put below the text node. The orientation of the spin button is reflected in the .vertical or .horizontal style class on the main node.

Accessibility

GtkSpinButton uses the GTK_ACCESSIBLE_ROLE_SPIN_BUTTON role.

Hierarchy

Ancestors

Implements

Constructors

gtk_spin_button_new

Creates a new GtkSpinButton.

gtk_spin_button_new_with_range

Creates a new GtkSpinButton with the given properties.

Instance methods

gtk_spin_button_configure

Changes the properties of an existing spin button.

gtk_spin_button_get_activates_default

Retrieves the value set by gtk_spin_button_set_activates_default().

since: 4.14

gtk_spin_button_get_adjustment

Get the adjustment associated with a GtkSpinButton.

gtk_spin_button_get_climb_rate

Returns the acceleration rate for repeated changes.

gtk_spin_button_get_digits

Fetches the precision of spin_button.

gtk_spin_button_get_increments

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

gtk_spin_button_get_numeric

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

gtk_spin_button_get_range

Gets the range allowed for spin_button.

gtk_spin_button_get_snap_to_ticks

Returns whether the values are corrected to the nearest step.

gtk_spin_button_get_update_policy

Gets the update behavior of a spin button.

gtk_spin_button_get_value

Get the value in the spin_button.

gtk_spin_button_get_value_as_int

Get the value spin_button represented as an integer.

gtk_spin_button_get_wrap

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

gtk_spin_button_set_activates_default

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

since: 4.14

gtk_spin_button_set_adjustment

Replaces the GtkAdjustment associated with spin_button.

gtk_spin_button_set_climb_rate

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

gtk_spin_button_set_digits

Set the precision to be displayed by spin_button.

gtk_spin_button_set_increments

Sets the step and page increments for spin_button.

gtk_spin_button_set_numeric

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

gtk_spin_button_set_range

Sets the minimum and maximum allowable values for spin_button.

gtk_spin_button_set_snap_to_ticks

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.

gtk_spin_button_set_update_policy

Sets the update behavior of a spin button.

gtk_spin_button_set_value

Sets the value of spin_button.

gtk_spin_button_set_wrap

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.

gtk_spin_button_spin

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

gtk_spin_button_update

Manually force an update of the spin button.

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (19)

gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

since: 4.14

gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)

gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkCellEditable (3)

gtk_cell_editable_editing_done

Emits the GtkCellEditable::editing-done signal.

deprecated: 4.10

gtk_cell_editable_remove_widget

Emits the GtkCellEditable::remove-widget signal.

deprecated: 4.10

gtk_cell_editable_start_editing

Begins editing on a cell_editable.

Methods inherited from GtkEditable (24)

Please see GtkEditable for a full list of methods.

Methods inherited from GtkOrientable (2)

gtk_orientable_get_orientation

Retrieves the orientation of the orientable.

gtk_orientable_set_orientation

Sets the orientation of the orientable.

Properties

Gtk.SpinButton:activates-default

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

since: 4.14

Gtk.SpinButton:adjustment

The adjustment that holds the value of the spin button.

Gtk.SpinButton:climb-rate

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

Gtk.SpinButton:digits

The number of decimal places to display.

Gtk.SpinButton:numeric

Whether non-numeric characters should be ignored.

Gtk.SpinButton:snap-to-ticks

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

Gtk.SpinButton:update-policy

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

Gtk.SpinButton:value

The current value.

Gtk.SpinButton:wrap

Whether a spin button should wrap upon reaching its limits.

Properties inherited from GtkWidget (34)

Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the GtkWidget::query-tooltip signal on widget.

Gtk.Widget:height-request

Overrides for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Overrides for width request of the widget.

Properties inherited from GtkAccessible (1)

GtkAccessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkCellEditable (1)

GtkCellEditable:editing-canceled

Indicates whether editing on the cell has been canceled.

Properties inherited from GtkEditable (8)

GtkEditable:cursor-position

The current position of the insertion cursor in chars.

GtkEditable:editable

Whether the entry contents can be edited.

GtkEditable:enable-undo

If undo/redo should be enabled for the editable.

GtkEditable:max-width-chars

The desired maximum width of the entry, in characters.

GtkEditable:selection-bound

The position of the opposite end of the selection from the cursor in chars.

GtkEditable:text

The contents of the entry.

GtkEditable:width-chars

Number of characters to leave space for in the entry.

GtkEditable:xalign

The horizontal alignment, from 0 (left) to 1 (right).

Properties inherited from GtkOrientable (1)

GtkOrientable:orientation

The orientation of the orientable.

Signals

Gtk.SpinButton::activate

Emitted when the spin button is activated.

since: 4.14

Gtk.SpinButton::change-value

Emitted when the user initiates a value change.

Gtk.SpinButton::input

Emitted to convert the users input into a double value.

Gtk.SpinButton::output

Emitted to tweak the formatting of the value for display.

Gtk.SpinButton::value-changed

Emitted when the value is changed.

Gtk.SpinButton::wrapped

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

Signals inherited from GtkWidget (13)

GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

GtkWidget::hide

Emitted when widget is hidden.

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

GtkWidget::map

Emitted when widget is going to be mapped.

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

GtkWidget::move-focus

Emitted when the focus is moved.

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

GtkWidget::show

Emitted when widget is shown.

GtkWidget::state-flags-changed

Emitted when the widget state changes.

GtkWidget::unmap

Emitted when widget is going to be unmapped.

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Signals inherited from GtkCellEditable (2)

GtkCellEditable::editing-done

This signal is a sign for the cell renderer to update its value from the cell_editable.

GtkCellEditable::remove-widget

This signal is meant to indicate that the cell is finished editing, and the cell_editable widget is being removed and may subsequently be destroyed.