GI.Gtk.Objects.SpinButton

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, 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 Adjustment section for more details about an adjustment's properties. Note that GtkSpinButton will by default make its entry large enough to accomodate the lower and upper bounds of the adjustment, which can lead to surprising results. Best practice is to set both the Entry:width-chars and Entry:max-width-chars poperties to the desired number of characters to display in the entry.

CSS nodes

plain code

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

plain code

spinbutton.vertical
├── undershoot.left
├── undershoot.right
├── button.up
├── entry
│   ╰── ...
╰── 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 GtkEntry subnodes (if present) are put below the entry node. The orientation of the spin button is reflected in the .vertical or .horizontal style class on the main node.

Using a GtkSpinButton to get an integer

C code

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

gint
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 (GTK_WINDOW_TOPLEVEL);
  gtk_container_set_border_width (GTK_CONTAINER (window), 5);

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

  gtk_widget_show_all (window);
}

Using a GtkSpinButton to get a floating point value

C code

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

gfloat
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 (GTK_WINDOW_TOPLEVEL);
  gtk_container_set_border_width (GTK_CONTAINER (window), 5);

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

  gtk_widget_show_all (window);
}

Exported types

newtype SpinButton

Constructors

SpinButton (ManagedPtr SpinButton)

Instances

GObject SpinButton

Methods

gobjectType :: SpinButton -> IO GType

IsImplementorIface SpinButton

IsObject SpinButton

IsWidget SpinButton

IsSpinButton SpinButton

IsEntry SpinButton

IsOrientable SpinButton

IsEditable SpinButton

IsCellEditable SpinButton

IsBuildable SpinButton

class GObject o => IsSpinButton o

Instances

(GObject a, UnknownAncestorError Constraint SpinButton a) => IsSpinButton a

IsSpinButton SpinButton

toSpinButton :: (MonadIO m, IsSpinButton o) => o -> m SpinButton

noSpinButton :: Maybe SpinButton

Methods

configure

spinButtonConfigure

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a, IsAdjustment b)

=> a

spinButton: a SpinButton

-> Maybe b

adjustment: a Adjustment

-> Double

climbRate: the new climb rate

-> Word32

digits: the number of decimal places to display in the spin button

-> m ()

Changes the properties of an existing spin button. The adjustment, climb rate, and number of decimal places are all changed accordingly, after this function call.

getAdjustment

spinButtonGetAdjustment

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m Adjustment

Returns: the Adjustment of spinButton

Get the adjustment associated with a SpinButton

getDigits

spinButtonGetDigits

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m Word32

Returns: the current precision

Fetches the precision of spinButton. See spinButtonSetDigits.

getIncrements

spinButtonGetIncrements

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m (Double, Double)

Gets the current step and page the increments used by spinButton. See spinButtonSetIncrements.

getNumeric

spinButtonGetNumeric

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m Bool

Returns: True if only numeric text can be entered

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

getRange

spinButtonGetRange

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m (Double, Double)

Gets the range allowed for spinButton. See spinButtonSetRange.

getSnapToTicks

spinButtonGetSnapToTicks

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m Bool

Returns: True if values are snapped to the nearest step

Returns whether the values are corrected to the nearest step. See spinButtonSetSnapToTicks.

getUpdatePolicy

spinButtonGetUpdatePolicy

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m SpinButtonUpdatePolicy

Returns: the current update policy

Gets the update behavior of a spin button. See spinButtonSetUpdatePolicy.

getValue

spinButtonGetValue

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m Double

Returns: the value of spinButton

Get the value in the spinButton.

getValueAsInt

spinButtonGetValueAsInt

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m Int32

Returns: the value of spinButton

Get the value spinButton represented as an integer.

getWrap

spinButtonGetWrap

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m Bool

Returns: True if the spin button wraps around

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

new

spinButtonNew

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> Maybe a

adjustment: the Adjustment object that this spin button should use, or Nothing

-> Double

climbRate: specifies how much the spin button changes when an arrow is clicked on

-> Word32

digits: the number of decimal places to display

-> m SpinButton

Returns: The new spin button as a Widget

Creates a new SpinButton.

newWithRange

spinButtonNewWithRange

Arguments

:: (HasCallStack, MonadIO m)

=> Double

min: Minimum allowable value

-> Double

max: Maximum allowable value

-> Double

step: Increment added or subtracted by spinning the widget

-> m SpinButton

Returns: The new spin button as a Widget

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 spinButtonSetDigits to correct it.

setAdjustment

spinButtonSetAdjustment

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a, IsAdjustment b)

=> a

spinButton: a SpinButton

-> b

adjustment: a Adjustment to replace the existing adjustment

-> m ()

Replaces the Adjustment associated with spinButton.

setDigits

spinButtonSetDigits

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> Word32

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

-> m ()

Set the precision to be displayed by spinButton. Up to 20 digit precision is allowed.

setIncrements

spinButtonSetIncrements

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> Double

step: increment applied for a button 1 press.

-> Double

page: increment applied for a button 2 press.

-> m ()

Sets the step and page increments for spin_button. This affects how quickly the value changes when the spin button’s arrows are activated.

setNumeric

spinButtonSetNumeric

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> Bool

numeric: flag indicating if only numeric entry is allowed

-> m ()

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

setRange

spinButtonSetRange

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> Double

min: minimum allowable value

-> Double

max: maximum allowable value

-> m ()

Sets the minimum and maximum allowable values for spinButton.

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

setSnapToTicks

spinButtonSetSnapToTicks

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> Bool

snapToTicks: a flag indicating if invalid values should be corrected

-> m ()

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.

setUpdatePolicy

spinButtonSetUpdatePolicy

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> SpinButtonUpdatePolicy

policy: a SpinButtonUpdatePolicy value

-> m ()

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.

setValue

spinButtonSetValue

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> Double

value: the new value

-> m ()

Sets the value of spinButton.

setWrap

spinButtonSetWrap

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> Bool

wrap: a flag indicating if wrapping behavior is performed

-> m ()

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

spinButtonSpin

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> SpinType

direction: a SpinType indicating the direction to spin

-> Double

increment: step increment to apply in the specified direction

-> m ()

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

update

spinButtonUpdate

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a)

=> a

spinButton: a SpinButton

-> m ()

Manually force an update of the spin button.

Properties

adjustment

constructSpinButtonAdjustment :: (IsSpinButton o, IsAdjustment a) => a -> IO (GValueConstruct o)

getSpinButtonAdjustment :: (MonadIO m, IsSpinButton o) => o -> m Adjustment

setSpinButtonAdjustment :: (MonadIO m, IsSpinButton o, IsAdjustment a) => o -> a -> m ()

climbRate

constructSpinButtonClimbRate :: IsSpinButton o => Double -> IO (GValueConstruct o)

getSpinButtonClimbRate :: (MonadIO m, IsSpinButton o) => o -> m Double

setSpinButtonClimbRate :: (MonadIO m, IsSpinButton o) => o -> Double -> m ()

digits

constructSpinButtonDigits :: IsSpinButton o => Word32 -> IO (GValueConstruct o)

getSpinButtonDigits :: (MonadIO m, IsSpinButton o) => o -> m Word32

setSpinButtonDigits :: (MonadIO m, IsSpinButton o) => o -> Word32 -> m ()

numeric

constructSpinButtonNumeric :: IsSpinButton o => Bool -> IO (GValueConstruct o)

getSpinButtonNumeric :: (MonadIO m, IsSpinButton o) => o -> m Bool

setSpinButtonNumeric :: (MonadIO m, IsSpinButton o) => o -> Bool -> m ()

snapToTicks

constructSpinButtonSnapToTicks :: IsSpinButton o => Bool -> IO (GValueConstruct o)

getSpinButtonSnapToTicks :: (MonadIO m, IsSpinButton o) => o -> m Bool

setSpinButtonSnapToTicks :: (MonadIO m, IsSpinButton o) => o -> Bool -> m ()

updatePolicy

constructSpinButtonUpdatePolicy :: IsSpinButton o => SpinButtonUpdatePolicy -> IO (GValueConstruct o)

getSpinButtonUpdatePolicy :: (MonadIO m, IsSpinButton o) => o -> m SpinButtonUpdatePolicy

setSpinButtonUpdatePolicy :: (MonadIO m, IsSpinButton o) => o -> SpinButtonUpdatePolicy -> m ()

value

constructSpinButtonValue :: IsSpinButton o => Double -> IO (GValueConstruct o)

getSpinButtonValue :: (MonadIO m, IsSpinButton o) => o -> m Double

setSpinButtonValue :: (MonadIO m, IsSpinButton o) => o -> Double -> m ()

wrap

constructSpinButtonWrap :: IsSpinButton o => Bool -> IO (GValueConstruct o)

getSpinButtonWrap :: (MonadIO m, IsSpinButton o) => o -> m Bool

setSpinButtonWrap :: (MonadIO m, IsSpinButton o) => o -> Bool -> m ()

Signals

changeValue

type C_SpinButtonChangeValueCallback = Ptr () -> CUInt -> Ptr () -> IO ()

type SpinButtonChangeValueCallback = ScrollType -> IO ()

afterSpinButtonChangeValue :: (IsSpinButton a, MonadIO m) => a -> SpinButtonChangeValueCallback -> m SignalHandlerId

genClosure_SpinButtonChangeValue :: SpinButtonChangeValueCallback -> IO Closure

mk_SpinButtonChangeValueCallback :: C_SpinButtonChangeValueCallback -> IO (FunPtr C_SpinButtonChangeValueCallback)

noSpinButtonChangeValueCallback :: Maybe SpinButtonChangeValueCallback

onSpinButtonChangeValue :: (IsSpinButton a, MonadIO m) => a -> SpinButtonChangeValueCallback -> m SignalHandlerId

wrap_SpinButtonChangeValueCallback :: SpinButtonChangeValueCallback -> Ptr () -> CUInt -> Ptr () -> IO ()

input

type C_SpinButtonInputCallback = Ptr () -> Ptr CDouble -> Ptr () -> IO Int32

type SpinButtonInputCallback = IO (Int32, Double)

afterSpinButtonInput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonInputCallback -> m SignalHandlerId

genClosure_SpinButtonInput :: SpinButtonInputCallback -> IO Closure

mk_SpinButtonInputCallback :: C_SpinButtonInputCallback -> IO (FunPtr C_SpinButtonInputCallback)

noSpinButtonInputCallback :: Maybe SpinButtonInputCallback

onSpinButtonInput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonInputCallback -> m SignalHandlerId

wrap_SpinButtonInputCallback :: SpinButtonInputCallback -> Ptr () -> Ptr CDouble -> Ptr () -> IO Int32

output

type C_SpinButtonOutputCallback = Ptr () -> Ptr () -> IO CInt

type SpinButtonOutputCallback = IO Bool

afterSpinButtonOutput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonOutputCallback -> m SignalHandlerId

genClosure_SpinButtonOutput :: SpinButtonOutputCallback -> IO Closure

mk_SpinButtonOutputCallback :: C_SpinButtonOutputCallback -> IO (FunPtr C_SpinButtonOutputCallback)

noSpinButtonOutputCallback :: Maybe SpinButtonOutputCallback

onSpinButtonOutput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonOutputCallback -> m SignalHandlerId

wrap_SpinButtonOutputCallback :: SpinButtonOutputCallback -> Ptr () -> Ptr () -> IO CInt

valueChanged

type C_SpinButtonValueChangedCallback = Ptr () -> Ptr () -> IO ()

type SpinButtonValueChangedCallback = IO ()

afterSpinButtonValueChanged :: (IsSpinButton a, MonadIO m) => a -> SpinButtonValueChangedCallback -> m SignalHandlerId

genClosure_SpinButtonValueChanged :: SpinButtonValueChangedCallback -> IO Closure

mk_SpinButtonValueChangedCallback :: C_SpinButtonValueChangedCallback -> IO (FunPtr C_SpinButtonValueChangedCallback)

noSpinButtonValueChangedCallback :: Maybe SpinButtonValueChangedCallback

onSpinButtonValueChanged :: (IsSpinButton a, MonadIO m) => a -> SpinButtonValueChangedCallback -> m SignalHandlerId

wrap_SpinButtonValueChangedCallback :: SpinButtonValueChangedCallback -> Ptr () -> Ptr () -> IO ()

wrapped

type C_SpinButtonWrappedCallback = Ptr () -> Ptr () -> IO ()

type SpinButtonWrappedCallback = IO ()

afterSpinButtonWrapped :: (IsSpinButton a, MonadIO m) => a -> SpinButtonWrappedCallback -> m SignalHandlerId

genClosure_SpinButtonWrapped :: SpinButtonWrappedCallback -> IO Closure

mk_SpinButtonWrappedCallback :: C_SpinButtonWrappedCallback -> IO (FunPtr C_SpinButtonWrappedCallback)

noSpinButtonWrappedCallback :: Maybe SpinButtonWrappedCallback

onSpinButtonWrapped :: (IsSpinButton a, MonadIO m) => a -> SpinButtonWrappedCallback -> m SignalHandlerId

wrap_SpinButtonWrappedCallback :: SpinButtonWrappedCallback -> Ptr () -> Ptr () -> IO ()