Gtk.SpinButton¶

Example¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1), Gtk.CellEditable (3), Gtk.Editable (27), Gtk.Orientable (2)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` (adjustment, climb_rate, digits)
class	`new_with_range` (min, max, step)
	`configure` (adjustment, climb_rate, digits)
	`get_adjustment` ()
	`get_climb_rate` ()
	`get_digits` ()
	`get_increments` ()
	`get_numeric` ()
	`get_range` ()
	`get_snap_to_ticks` ()
	`get_update_policy` ()
	`get_value` ()
	`get_value_as_int` ()
	`get_wrap` ()
	`set_adjustment` (adjustment)
	`set_climb_rate` (climb_rate)
	`set_digits` (digits)
	`set_increments` (step, page)
	`set_numeric` (numeric)
	`set_range` (min, max)
	`set_snap_to_ticks` (snap_to_ticks)
	`set_update_policy` (policy)
	`set_value` (value)
	`set_wrap` (wrap)
	`spin` (direction, increment)
	`update` ()

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9), Gtk.AccessibleRange (1), Gtk.CellEditable (3), Gtk.Editable (9)

Properties¶

Inherited:: Gtk.Widget (34), Gtk.Accessible (1), Gtk.CellEditable (1), Gtk.Editable (8), Gtk.Orientable (1)

Name	Type	Flags
`adjustment`	`Gtk.Adjustment`	r/w/en
`climb-rate`	`float`	r/w/en
`digits`	`int`	r/w/en
`numeric`	`bool`	r/w/en
`snap-to-ticks`	`bool`	r/w/en
`update-policy`	`Gtk.SpinButtonUpdatePolicy`	r/w/en
`value`	`float`	r/w/en
`wrap`	`bool`	r/w/en

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1), Gtk.CellEditable (2), Gtk.Editable (3)

Name	Short Description
`change-value`	Emitted when the user initiates a value change.
`input`	Emitted to convert the users input into a double value.
`output`	Emitted to tweak the formatting of the value for display.
`value-changed`	Emitted when the value is changed.
`wrapped`	Emitted right after the spinbutton wraps from its maximum to its minimum value or vice-versa.

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1), Gtk.CellEditable (2), Gtk.Editable (3)

Class Details¶

class Gtk.SpinButton(**kwargs)¶

Bases:: Gtk.Widget, Gtk.AccessibleRange, Gtk.CellEditable, Gtk.Editable, Gtk.Orientable
Abstract:: No

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

An example Gtk.SpinButton

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 [class`Gtk`.Adjustment] 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 [property`Gtk`.Editable:width-chars] to a value != -1.

Using a Gtk.SpinButton to get an integer

```c // Provides a function to retrieve an integer value from a Gtk.SpinButton // and creates a spin button to model percentage values.

int grab_int_value (Gtk.SpinButton *button, object user_data) { return Gtk.SpinButton.get_value_as_int (button); }

void create_integer_spin_button (void) {

Gtk.Widget *window, *button; Gtk.Adjustment *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.SpinButton.new (adjustment, 1.0, 0); Gtk.Window.set_child (GTK_WINDOW (window), button);

Gtk.Window.present (GTK_WINDOW (window)); } ```

Using a Gtk.SpinButton to get a floating point value

```c // Provides a function to retrieve a floating point value from a // Gtk.SpinButton, and creates a high precision spin button.

float grab_float_value (Gtk.SpinButton *button, object user_data) { return Gtk.SpinButton.get_value (button); }

void create_floating_spin_button (void) { Gtk.Widget *window, *button; Gtk.Adjustment *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.SpinButton.new (adjustment, 0.001, 3); Gtk.Window.set_child (GTK_WINDOW (window), button);

Gtk.Window.present (GTK_WINDOW (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 ``

GtkSpinButton``s 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.AccessibleRole.SPIN_BUTTON role.

classmethod new(adjustment, climb_rate, digits)[source]¶

Parameters:

adjustment (Gtk.Adjustment or None) – the GtkAdjustment that this spin button should use
climb_rate (float) – specifies by how much the rate of change in the value will accelerate if you continue to hold down an up/down button or arrow key
digits (int) – the number of decimal places to display

Returns:

The new GtkSpinButton

Return type:

Gtk.Widget

Creates a new GtkSpinButton.

classmethod new_with_range(min, max, step)[source]¶

Parameters:

min (float) – Minimum allowable value
max (float) – Maximum allowable value
step (float) – Increment added or subtracted by spinning the widget

Returns:

The new GtkSpinButton

Return type:

Gtk.Widget

Creates a new GtkSpinButton with the given properties.

This is a convenience constructor that allows creation of a numeric GtkSpinButton without manually creating an adjustment. The value is initially set to the minimum value and a page increment of 10 * step is the default. The precision of the spin button is equivalent to the precision of step.

Note that the way in which the precision is derived works best if step is a power of ten. If the resulting precision is not suitable for your needs, use [method`Gtk`.SpinButton.set_digits] to correct it.

configure(adjustment, climb_rate, digits)[source]¶

Parameters:

adjustment (Gtk.Adjustment or None) – a GtkAdjustment to replace the spin button’s existing adjustment, or None to leave its current adjustment unchanged
climb_rate (float) – the new climb rate
digits (int) – the number of decimal places to display in the spin button

Changes the properties of an existing spin button.

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

get_adjustment()[source]¶

Returns:: the GtkAdjustment of self
Return type:: Gtk.Adjustment

Get the adjustment associated with a GtkSpinButton.

get_climb_rate()[source]¶

Returns:: the acceleration rate
Return type:: float

Returns the acceleration rate for repeated changes.

get_digits()[source]¶

Returns:: the current precision
Return type:: int

Fetches the precision of self.

get_increments()[source]¶

Returns:

step:: location to store step increment
page:: location to store page increment

Return type:

(step: float, page: float)

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

See [method`Gtk`.SpinButton.set_increments].

get_numeric()[source]¶

Returns:: True if only numeric text can be entered
Return type:: bool

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

get_range()[source]¶

Returns:

min:: location to store minimum allowed value
max:: location to store maximum allowed value

Return type:

(min: float, max: float)

Gets the range allowed for self.

See [method`Gtk`.SpinButton.set_range].

get_snap_to_ticks()[source]¶

Returns:: True if values are snapped to the nearest step
Return type:: bool

Returns whether the values are corrected to the nearest step.

get_update_policy()[source]¶

Returns:: the current update policy
Return type:: Gtk.SpinButtonUpdatePolicy

Gets the update behavior of a spin button.

See [method`Gtk`.SpinButton.set_update_policy].

get_value()[source]¶

Returns:: the value of self
Return type:: float

Get the value in the self.

get_value_as_int()[source]¶

Returns:: the value of self
Return type:: int

Get the value self represented as an integer.

get_wrap()[source]¶

Returns:: True if the spin button wraps around
Return type:: bool

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

set_adjustment(adjustment)[source]¶

Parameters:: adjustment (Gtk.Adjustment) – a GtkAdjustment to replace the existing adjustment

Replaces the GtkAdjustment associated with self.

set_climb_rate(climb_rate)[source]¶

Parameters:: climb_rate (float) – the rate of acceleration, must be >= 0

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

set_digits(digits)[source]¶

Parameters:: digits (int) – the number of digits after the decimal point to be displayed for the spin button’s value

Set the precision to be displayed by self.

Up to 20 digit precision is allowed.

set_increments(step, page)[source]¶

Parameters:

step (float) – increment applied for a button 1 press.
page (float) – increment applied for a button 2 press.

Sets the step and page increments for spin_button.

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

set_numeric(numeric)[source]¶

Parameters:: numeric (bool) – flag indicating if only numeric entry is allowed

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

set_range(min, max)[source]¶

Parameters:

min (float) – minimum allowable value
max (float) – maximum allowable value

Sets the minimum and maximum allowable values for self.

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

set_snap_to_ticks(snap_to_ticks)[source]¶

Parameters:: snap_to_ticks (bool) – a flag indicating if invalid values should be corrected

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.

set_update_policy(policy)[source]¶

Parameters:: policy (Gtk.SpinButtonUpdatePolicy) – a GtkSpinButtonUpdatePolicy value

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.

set_value(value)[source]¶

Parameters:: value (float) – the new value

Sets the value of self.

set_wrap(wrap)[source]¶

Parameters:: wrap (bool) – a flag indicating if wrapping behavior is performed

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.

spin(direction, increment)[source]¶

Parameters:

direction (Gtk.SpinType) – a GtkSpinType indicating the direction to spin
increment (float) – step increment to apply in the specified direction

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

update()[source]¶: Manually force an update of the spin button.

Signal Details¶

Gtk.SpinButton.signals.change_value(spin_button, scroll)¶

Signal Name:

change-value

Flags:

RUN_LAST, ACTION

Parameters:

spin_button (Gtk.SpinButton) – The object which received the signal
scroll (Gtk.ScrollType) – a GtkScrollType to specify the speed and amount of change

Emitted when the user initiates a value change.

This is a keybinding signal.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal are Up/Down and PageUp/PageDown.

Gtk.SpinButton.signals.input(spin_button)¶

Signal Name:

input

Flags:

RUN_LAST

Parameters:

spin_button (Gtk.SpinButton) – The object which received the signal

Returns:

True for a successful conversion, False if the input was not handled, and Gtk.INPUT_ERROR if the conversion failed.

new_value:: return location for the new value

Return type:

(int, new_value: float)

Emitted to convert the users input into a double value.

The signal handler is expected to use [method`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().

Gtk.SpinButton.signals.output(spin_button)¶

Signal Name:: output
Flags:: RUN_LAST
Parameters:: spin_button (Gtk.SpinButton) – The object which received the signal
Returns:: True if the value has been displayed
Return type:: bool

Emitted to tweak the formatting of the value for display.

```c // show leading zeros static bool on_output (Gtk.SpinButton *spin, object data) { Gtk.Adjustment *adjustment; str *text; int value;

adjustment = Gtk.SpinButton.get_adjustment (spin); value = (int):obj:Gtk.Adjustment.get_value (adjustment); text = g_strdup_printf (“%02d”, value); Gtk.Editable.set_text (GTK_EDITABLE (spin), text): GLib.free (text);

return True; } ```

Gtk.SpinButton.signals.value_changed(spin_button)¶

Signal Name:: value-changed
Flags:: RUN_LAST
Parameters:: spin_button (Gtk.SpinButton) – The object which received the signal

Emitted when the value is changed.

Also see the [signal`Gtk`.SpinButton::output] signal.

Gtk.SpinButton.signals.wrapped(spin_button)¶

Signal Name:: wrapped
Flags:: RUN_LAST
Parameters:: spin_button (Gtk.SpinButton) – The object which received the signal

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

Property Details¶

Gtk.SpinButton.props.adjustment¶

Name:: adjustment
Type:: Gtk.Adjustment
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The adjustment that holds the value of the spin button.

Gtk.SpinButton.props.climb_rate¶

Name:: climb-rate
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.SpinButton.props.digits¶

Name:: digits
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The number of decimal places to display.

Gtk.SpinButton.props.numeric¶

Name:: numeric
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether non-numeric characters should be ignored.

Gtk.SpinButton.props.snap_to_ticks¶

Name:: snap-to-ticks
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.SpinButton.props.update_policy¶

Name:: update-policy
Type:: Gtk.SpinButtonUpdatePolicy
Default Value:: Gtk.SpinButtonUpdatePolicy.ALWAYS
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.SpinButton.props.value¶

Name:: value
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The current value.

Gtk.SpinButton.props.wrap¶

Name:: wrap
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether a spin button should wrap upon reaching its limits.