---
name: "Gtk2::SpinButton"
section: "3pm"
platform: "linux"
package: "libgtk2-perl-doc"
version: "2:1.24992-1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/Gtk2::SpinButton"
---

# Gtk2::SpinButton(3pm)

wrapper for GtkSpinButton

## NAME

Gtk2::SpinButton - wrapper for GtkSpinButton

## HIERARCHY

```
  Glib::Object
  +----Glib::InitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gtk2::Entry
                      +----Gtk2::SpinButton
```

## INTERFACES

```
  Glib::Object::_Unregistered::AtkImplementorIface
  Gtk2::Buildable
  Gtk2::Editable
  Gtk2::CellEditable
```

## METHODS

### widget = Gtk2::SpinButton-\>new ($adjustment, $climb\_rate, $digits)

- •

  `$adjustment` (Gtk2::Adjustment)

- •

  `$climb_rate` (double)

- •

  `$digits` (integer)

### widget = Gtk2::SpinButton-\>new\_with\_range ($min, $max, $step)

- •

  `$min` (double)

- •

  `$max` (double)

- •

  `$step` (double)

### adjustment = $spin\_button-\>get\_adjustment

### $spin\_button-\>set\_adjustment ($adjustment)

- •

  `$adjustment` (Gtk2::Adjustment)

### $spin\_button-\>configure ($adjustment, $climb\_rate, $digits)

- •

  `$adjustment` (Gtk2::Adjustment)

- •

  `$climb_rate` (double)

- •

  `$digits` (integer)

### integer = $spin\_button-\>get\_digits

### $spin\_button-\>set\_digits ($digits)

- •

  `$digits` (integer)

### (step, page) = $spin\_button-\>get\_increments

### $spin\_button-\>set\_increments ($step, $page)

- •

  `$step` (double)

- •

  `$page` (double)

### boolean = $spin\_button-\>get\_numeric

### $spin\_button-\>set\_numeric ($numeric)

- •

  `$numeric` (boolean)

### (min, max) = $spin\_button-\>get\_range

### $spin\_button-\>set\_range ($min, $max)

- •

  `$min` (double)

- •

  `$max` (double)

### boolean = $spin\_button-\>get\_snap\_to\_ticks

### $spin\_button-\>set\_snap\_to\_ticks ($snap\_to\_ticks)

- •

  `$snap_to_ticks` (boolean)

### $spin\_button-\>spin ($direction, $increment)

- •

  `$direction` (Gtk2::SpinType)

- •

  `$increment` (double)

### $spin\_button-\>update

### spinbuttonupdatepolicy = $spin\_button-\>get\_update\_policy

### $spin\_button-\>set\_update\_policy ($policy)

- •

  `$policy` (Gtk2::SpinButtonUpdatePolicy)

### integer = $spin\_button-\>get\_value\_as\_int

### double = $spin\_button-\>get\_value

### $spin\_button-\>set\_value ($value)

- •

  `$value` (double)

### boolean = $spin\_button-\>get\_wrap

### $spin\_button-\>set\_wrap ($wrap)

- •

  `$wrap` (boolean)

## PROPERTIES

- 'adjustment' (Gtk2::Adjustment : default undef : readable / writable / private)

  The adjustment that holds the value of the spinbutton

- 'climb-rate' (double : default 0 : readable / writable / private)

  The acceleration rate when you hold down a button

- 'digits' (Glib::UInt : default 0 : readable / writable / private)

  The number of decimal places to display

- 'numeric' (boolean : default false : readable / writable / private)

  Whether non-numeric characters should be ignored

- 'snap-to-ticks' (boolean : default false : readable / writable / private)

  Whether erroneous values are automatically changed to a spin button's nearest step increment

- 'update-policy' (Gtk2::SpinButtonUpdatePolicy : default "always" : readable / writable / private)

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

- 'value' (double : default 0 : readable / writable / private)

  Reads the current value, or sets a new value

- 'wrap' (boolean : default false : readable / writable / private)

  Whether a spin button should wrap upon reaching its limits

## STYLE PROPERTIES

- 'shadow-type' (Gtk2::ShadowType : default "in" : readable / private)

  Style of bevel around the spin button

## SIGNALS

- **change-value** (Gtk2::SpinButton, Gtk2::ScrollType)

  - integer = **input** (Gtk2::SpinButton, gpointer)

  - boolean = **output** (Gtk2::SpinButton)

  - **value-changed** (Gtk2::SpinButton)

  - **wrapped** (Gtk2::SpinButton)

  ## ENUMS AND FLAGS

### enum Gtk2::ScrollType

- •

  'none' / 'GTK\_SCROLL\_NONE'

- •

  'jump' / 'GTK\_SCROLL\_JUMP'

- •

  'step-backward' / 'GTK\_SCROLL\_STEP\_BACKWARD'

- •

  'step-forward' / 'GTK\_SCROLL\_STEP\_FORWARD'

- •

  'page-backward' / 'GTK\_SCROLL\_PAGE\_BACKWARD'

- •

  'page-forward' / 'GTK\_SCROLL\_PAGE\_FORWARD'

- •

  'step-up' / 'GTK\_SCROLL\_STEP\_UP'

- •

  'step-down' / 'GTK\_SCROLL\_STEP\_DOWN'

- •

  'page-up' / 'GTK\_SCROLL\_PAGE\_UP'

- •

  'page-down' / 'GTK\_SCROLL\_PAGE\_DOWN'

- •

  'step-left' / 'GTK\_SCROLL\_STEP\_LEFT'

- •

  'step-right' / 'GTK\_SCROLL\_STEP\_RIGHT'

- •

  'page-left' / 'GTK\_SCROLL\_PAGE\_LEFT'

- •

  'page-right' / 'GTK\_SCROLL\_PAGE\_RIGHT'

- •

  'start' / 'GTK\_SCROLL\_START'

- •

  'end' / 'GTK\_SCROLL\_END'

### enum Gtk2::SpinButtonUpdatePolicy

- •

  'always' / 'GTK\_UPDATE\_ALWAYS'

- •

  'if-valid' / 'GTK\_UPDATE\_IF\_VALID'

### enum Gtk2::SpinType

- •

  'step-forward' / 'GTK\_SPIN\_STEP\_FORWARD'

- •

  'step-backward' / 'GTK\_SPIN\_STEP\_BACKWARD'

- •

  'page-forward' / 'GTK\_SPIN\_PAGE\_FORWARD'

- •

  'page-backward' / 'GTK\_SPIN\_PAGE\_BACKWARD'

- •

  'home' / 'GTK\_SPIN\_HOME'

- •

  'end' / 'GTK\_SPIN\_END'

- •

  'user-defined' / 'GTK\_SPIN\_USER\_DEFINED'

## SEE ALSO

Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Entry

## COPYRIGHT

Copyright (C) 2003-2011 by the gtk2-perl team.

This software is licensed under the LGPL.  See Gtk2 for a full notice.