Struct gtk4::SpinButton

source ·

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

Expand description

A SpinButton 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 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_widget_show (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_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

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.

Accessiblity

SpinButton uses the AccessibleRole::SpinButton role.

Implements

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

Struct gtk4::SpinButton

Implementations§

impl SpinButton

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

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

pub fn builder() -> SpinButtonBuilder

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

pub fn adjustment(&self) -> Adjustment

pub fn climb_rate(&self) -> f64

pub fn digits(&self) -> u32

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

pub fn is_numeric(&self) -> bool

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

pub fn snaps_to_ticks(&self) -> bool

pub fn update_policy(&self) -> SpinButtonUpdatePolicy

pub fn value(&self) -> f64

pub fn value_as_int(&self) -> i32

pub fn wraps(&self) -> bool

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

pub fn set_climb_rate(&self, climb_rate: f64)

pub fn set_digits(&self, digits: u32)

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

pub fn set_numeric(&self, numeric: bool)

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

pub fn set_snap_to_ticks(&self, snap_to_ticks: bool)

pub fn set_update_policy(&self, policy: SpinButtonUpdatePolicy)

pub fn set_value(&self, value: f64)

pub fn set_wrap(&self, wrap: bool)

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

pub fn update(&self)

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

pub fn emit_change_value(&self, scroll: ScrollType)

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

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

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

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,

Trait Implementations§

impl Clone for SpinButton

fn clone(&self) -> Self

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

impl Debug for SpinButton

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

impl Default for SpinButton

fn default() -> Self

impl Display for SpinButton

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

impl Hash for SpinButton

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

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

impl Ord for SpinButton

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

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

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

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

impl ParentClassIs for SpinButton

type Parent = Widget

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

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

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

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

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

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

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

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

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

impl StaticType for SpinButton

fn static_type() -> Type

impl Eq for SpinButton

impl IsA<Accessible> for SpinButton

impl IsA<Buildable> for SpinButton

impl IsA<CellEditable> for SpinButton