Class

Gtk.SpinButton

Description [src]

final class Gtk.SpinButton : Gtk.Widget {
  /* 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_widget_show (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_widget_show (window);
}

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.

Accessiblity

GtkSpinButton uses the GTK_ACCESSIBLE_ROLE_SPIN_BUTTON role.

Hierarchy

Ancestors

GtkWidget
GInitiallyUnowned
GObject

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_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_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 (159)

Methods inherited from GtkAccessible (10)

gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

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_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.

gtk_cell_editable_remove_widget

Emits the GtkCellEditable::remove-widget signal.

gtk_cell_editable_start_editing

Begins editing on a cell_editable.

Methods inherited from GtkEditable (23)

gtk_editable_delete_selection

Deletes the currently selected text of the editable.

gtk_editable_delete_text

Deletes a sequence of characters.

gtk_editable_finish_delegate

Undoes the setup done by gtk_editable_init_delegate().

gtk_editable_get_alignment

Gets the alignment of the editable.

gtk_editable_get_chars

Retrieves a sequence of characters.

gtk_editable_get_delegate

Gets the GtkEditable that editable is delegating its implementation to.

gtk_editable_get_editable

Retrieves whether editable is editable.

gtk_editable_get_enable_undo

Gets if undo/redo actions are enabled for editable

gtk_editable_get_max_width_chars

Retrieves the desired maximum width of editable, in characters.

gtk_editable_get_position

Retrieves the current position of the cursor relative to the start of the content of the editable.

gtk_editable_get_selection_bounds

Retrieves the selection bound of the editable.

gtk_editable_get_text

Retrieves the contents of editable.

gtk_editable_get_width_chars

Gets the number of characters of space reserved for the contents of the editable.

gtk_editable_init_delegate

Sets up a delegate for GtkEditable.

gtk_editable_insert_text

Inserts length bytes of text into the contents of the widget, at position position.

gtk_editable_select_region

Selects a region of text.

gtk_editable_set_alignment

Sets the alignment for the contents of the editable.

gtk_editable_set_editable

Determines if the user can edit the text in the editable widget.

gtk_editable_set_enable_undo

If enabled, changes to editable will be saved for undo/redo actions.

gtk_editable_set_max_width_chars

Sets the desired maximum width in characters of editable.

gtk_editable_set_position

Sets the cursor position in the editable to the given value.

gtk_editable_set_text

Sets the text in the editable to the given value.

gtk_editable_set_width_chars

Changes the size request of the editable to be about the right size for n_chars characters.

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: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 GtkAccessible (1)

Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkCellEditable (1)

Gtk.CellEditable:editing-canceled

Indicates whether editing on the cell has been canceled.

Properties inherited from GtkOrientable (1)

Gtk.Orientable:orientation

The orientation of the orientable.

Signals inherited from GtkCellEditable (2)

Gtk.CellEditable::editing-done

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

Gtk.CellEditable::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.