Struct gtk4::SpinButton

#[repr(transparent)]
pub struct SpinButton { /* private fields */ }

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

Rather than having to directly type a number into a Entry, SpinButton 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 SpinButton are through an adjustment. See the Adjustment documentation for more details about an adjustment’s properties.

Note that SpinButton 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::Editable::width-chars to a value != -1.

Using a GtkSpinButton to get an integer

⚠️ The following code is in c ⚠️

// 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

⚠️ The following code is in c ⚠️

// 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));
}

CSS nodes

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

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

SpinButtons 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 Text 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

SpinButton uses the AccessibleRole::SpinButton role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, AccessibleRangeExt, CellEditableExt, EditableExt, OrientableExt, WidgetExtManual, AccessibleExtManual, EditableExtManual

Implementations

impl SpinButton

pub fn new(
    adjustment: Option<&impl IsA<Adjustment>>,
    climb_rate: f64,
    digits: u32
) -> SpinButton

Creates a new SpinButton.

adjustment

the Adjustment that this spin button should use

climb_rate

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

the number of decimal places to display

Returns

The new SpinButton

pub fn with_range(min: f64, max: f64, step: f64) -> SpinButton

Creates a new SpinButton with the given properties.

This is a convenience constructor that allows creation of a numeric SpinButton 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 set_digits() to correct it.

min

Minimum allowable value

max

Maximum allowable value

step

Increment added or subtracted by spinning the widget

Returns

The new SpinButton

pub fn builder() -> SpinButtonBuilder

Creates a new builder-pattern struct instance to construct SpinButton objects.

This method returns an instance of SpinButtonBuilder which can be used to create SpinButton objects.

pub fn configure(
    &self,
    adjustment: Option<&impl IsA<Adjustment>>,
    climb_rate: f64,
    digits: u32
)

Changes the properties of an existing spin button.

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

adjustment

a Adjustment to replace the spin button’s existing adjustment, or None to leave its current adjustment unchanged

climb_rate

the new climb rate

digits

the number of decimal places to display in the spin button

pub fn adjustment(&self) -> Adjustment

Get the adjustment associated with a SpinButton.

Returns

the Adjustment of @self

pub fn climb_rate(&self) -> f64

Returns the acceleration rate for repeated changes.

Returns

the acceleration rate

pub fn digits(&self) -> u32

Fetches the precision of @self.

Returns

the current precision

pub fn increments(&self) -> (f64, f64)

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

See set_increments().

Returns

step

location to store step increment

page

location to store page increment

pub fn is_numeric(&self) -> bool

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

Returns

true if only numeric text can be entered

pub fn range(&self) -> (f64, f64)

Gets the range allowed for @self.

See set_range().

Returns

min

location to store minimum allowed value

max

location to store maximum allowed value

pub fn snaps_to_ticks(&self) -> bool

Returns whether the values are corrected to the nearest step.

Returns

true if values are snapped to the nearest step

pub fn update_policy(&self) -> SpinButtonUpdatePolicy

Gets the update behavior of a spin button.

See set_update_policy().

Returns

the current update policy

pub fn value(&self) -> f64

Get the value in the @self.

Returns

the value of @self

pub fn value_as_int(&self) -> i32

Get the value @self represented as an integer.

Returns

the value of @self

pub fn wraps(&self) -> 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.

Returns

true if the spin button wraps around

pub fn set_adjustment(&self, adjustment: &impl IsA<Adjustment>)

Replaces the Adjustment associated with @self.

adjustment

a Adjustment to replace the existing adjustment

pub fn set_climb_rate(&self, climb_rate: f64)

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

climb_rate

the rate of acceleration, must be >= 0

pub fn set_digits(&self, digits: u32)

Set the precision to be displayed by @self.

Up to 20 digit precision is allowed.

digits

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

pub fn set_increments(&self, step: f64, page: f64)

Sets the step and page increments for spin_button.

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

step

increment applied for a button 1 press.

page

increment applied for a button 2 press.

pub fn set_numeric(&self, numeric: bool)

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

numeric

flag indicating if only numeric entry is allowed

pub fn set_range(&self, min: f64, max: f64)

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.

min

minimum allowable value

max

maximum allowable value

pub fn set_snap_to_ticks(&self, snap_to_ticks: bool)

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.

snap_to_ticks

a flag indicating if invalid values should be corrected

pub fn set_update_policy(&self, policy: SpinButtonUpdatePolicy)

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.

policy

a SpinButtonUpdatePolicy value

pub fn set_value(&self, value: f64)

Sets the value of @self.

value

the new value

pub fn set_wrap(&self, wrap: bool)

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.

wrap

a flag indicating if wrapping behavior is performed

pub fn spin(&self, direction: SpinType, increment: f64)

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

direction

a SpinType indicating the direction to spin

increment

step increment to apply in the specified direction

pub fn update(&self)

Manually force an update of the spin button.

pub fn connect_change_value<F: Fn(&Self, ScrollType) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

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.

scroll

a ScrollType to specify the speed and amount of change

pub fn emit_change_value(&self, scroll: ScrollType)

pub fn connect_output<F: Fn(&Self) -> Inhibit + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted to tweak the formatting of the value for display.

⚠️ The following code is in c ⚠️

// show leading zeros
static gboolean
on_output (GtkSpinButton *spin,
           gpointer       data)
{
   GtkAdjustment *adjustment;
   char *text;
   int value;

   adjustment = gtk_spin_button_get_adjustment (spin);
   value = (int)gtk_adjustment_get_value (adjustment);
   text = g_strdup_printf ("%02d", value);
   gtk_editable_set_text (GTK_EDITABLE (spin), text):
   g_free (text);

   return TRUE;
}

Returns

true if the value has been displayed

pub fn connect_value_changed<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

Emitted when the value is changed.

Also see the signal::SpinButton::output signal.

pub fn connect_wrapped<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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

pub fn connect_adjustment_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_climb_rate_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_digits_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_numeric_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_snap_to_ticks_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_update_policy_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_value_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_wrap_notify<F: Fn(&Self) + 'static>(
    &self,
    f: F
) -> SignalHandlerId

impl SpinButton

pub fn connect_input<F>(&self, f: F) -> SignalHandlerIdwhere
    F: Fn(&Self) -> Option<Result<f64, ()>> + 'static,

Emitted to convert the users input into a double value.

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

The default conversion uses g_strtod().

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

Trait Implementations

impl Clone for SpinButton

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpinButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpinButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for SpinButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for SpinButton

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SpinButton

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for SpinButton

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for SpinButton

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SpinButton

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SpinButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SpinButton

impl IsA<Accessible> for SpinButton

impl IsA<AccessibleRange> for SpinButton

impl IsA<Buildable> for SpinButton

impl IsA<CellEditable> for SpinButton

impl IsA<ConstraintTarget> for SpinButton

impl IsA<Editable> for SpinButton

impl IsA<Orientable> for SpinButton

impl IsA<Widget> for SpinButton