.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::SpinButton 3"
.TH Gtk2::SpinButton 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Gtk2::SpinButton \- wrapper for GtkSpinButton
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 6
\&  Glib::Object
\&  +\-\-\-\-Glib::InitiallyUnowned
\&       +\-\-\-\-Gtk2::Object
\&            +\-\-\-\-Gtk2::Widget
\&                 +\-\-\-\-Gtk2::Entry
\&                      +\-\-\-\-Gtk2::SpinButton
.Ve
.SH INTERFACES
.IX Header "INTERFACES"
.Vb 4
\&  Glib::Object::_Unregistered::AtkImplementorIface
\&  Gtk2::Buildable
\&  Gtk2::Editable
\&  Gtk2::CellEditable
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .SS "widget = Gtk2::SpinButton\->\fBnew\fP ($adjustment, $climb_rate, $digits)"
.el .SS "widget = Gtk2::SpinButton\->\fBnew\fP ($adjustment, \f(CW$climb_rate\fP, \f(CW$digits\fP)"
.IX Subsection "widget = Gtk2::SpinButton->new ($adjustment, $climb_rate, $digits)"
.IP \(bu 4
\&\f(CW$adjustment\fR (Gtk2::Adjustment)
.IP \(bu 4
\&\f(CW$climb_rate\fR (double)
.IP \(bu 4
\&\f(CW$digits\fR (integer)
.ie n .SS "widget = Gtk2::SpinButton\->\fBnew_with_range\fP ($min, $max, $step)"
.el .SS "widget = Gtk2::SpinButton\->\fBnew_with_range\fP ($min, \f(CW$max\fP, \f(CW$step\fP)"
.IX Subsection "widget = Gtk2::SpinButton->new_with_range ($min, $max, $step)"
.IP \(bu 4
\&\f(CW$min\fR (double)
.IP \(bu 4
\&\f(CW$max\fR (double)
.IP \(bu 4
\&\f(CW$step\fR (double)
.ie n .SS "adjustment = $spin_button\->\fBget_adjustment\fP"
.el .SS "adjustment = \f(CW$spin_button\fP\->\fBget_adjustment\fP"
.IX Subsection "adjustment = $spin_button->get_adjustment"
.ie n .SS "$spin_button\->\fBset_adjustment\fP ($adjustment)"
.el .SS "\f(CW$spin_button\fP\->\fBset_adjustment\fP ($adjustment)"
.IX Subsection "$spin_button->set_adjustment ($adjustment)"
.IP \(bu 4
\&\f(CW$adjustment\fR (Gtk2::Adjustment)
.ie n .SS "$spin_button\->\fBconfigure\fP ($adjustment, $climb_rate, $digits)"
.el .SS "\f(CW$spin_button\fP\->\fBconfigure\fP ($adjustment, \f(CW$climb_rate\fP, \f(CW$digits\fP)"
.IX Subsection "$spin_button->configure ($adjustment, $climb_rate, $digits)"
.IP \(bu 4
\&\f(CW$adjustment\fR (Gtk2::Adjustment)
.IP \(bu 4
\&\f(CW$climb_rate\fR (double)
.IP \(bu 4
\&\f(CW$digits\fR (integer)
.ie n .SS "integer = $spin_button\->\fBget_digits\fP"
.el .SS "integer = \f(CW$spin_button\fP\->\fBget_digits\fP"
.IX Subsection "integer = $spin_button->get_digits"
.ie n .SS "$spin_button\->\fBset_digits\fP ($digits)"
.el .SS "\f(CW$spin_button\fP\->\fBset_digits\fP ($digits)"
.IX Subsection "$spin_button->set_digits ($digits)"
.IP \(bu 4
\&\f(CW$digits\fR (integer)
.ie n .SS "(step, page) = $spin_button\->\fBget_increments\fP"
.el .SS "(step, page) = \f(CW$spin_button\fP\->\fBget_increments\fP"
.IX Subsection "(step, page) = $spin_button->get_increments"
.ie n .SS "$spin_button\->\fBset_increments\fP ($step, $page)"
.el .SS "\f(CW$spin_button\fP\->\fBset_increments\fP ($step, \f(CW$page\fP)"
.IX Subsection "$spin_button->set_increments ($step, $page)"
.IP \(bu 4
\&\f(CW$step\fR (double)
.IP \(bu 4
\&\f(CW$page\fR (double)
.ie n .SS "boolean = $spin_button\->\fBget_numeric\fP"
.el .SS "boolean = \f(CW$spin_button\fP\->\fBget_numeric\fP"
.IX Subsection "boolean = $spin_button->get_numeric"
.ie n .SS "$spin_button\->\fBset_numeric\fP ($numeric)"
.el .SS "\f(CW$spin_button\fP\->\fBset_numeric\fP ($numeric)"
.IX Subsection "$spin_button->set_numeric ($numeric)"
.IP \(bu 4
\&\f(CW$numeric\fR (boolean)
.ie n .SS "(min, max) = $spin_button\->\fBget_range\fP"
.el .SS "(min, max) = \f(CW$spin_button\fP\->\fBget_range\fP"
.IX Subsection "(min, max) = $spin_button->get_range"
.ie n .SS "$spin_button\->\fBset_range\fP ($min, $max)"
.el .SS "\f(CW$spin_button\fP\->\fBset_range\fP ($min, \f(CW$max\fP)"
.IX Subsection "$spin_button->set_range ($min, $max)"
.IP \(bu 4
\&\f(CW$min\fR (double)
.IP \(bu 4
\&\f(CW$max\fR (double)
.ie n .SS "boolean = $spin_button\->\fBget_snap_to_ticks\fP"
.el .SS "boolean = \f(CW$spin_button\fP\->\fBget_snap_to_ticks\fP"
.IX Subsection "boolean = $spin_button->get_snap_to_ticks"
.ie n .SS "$spin_button\->\fBset_snap_to_ticks\fP ($snap_to_ticks)"
.el .SS "\f(CW$spin_button\fP\->\fBset_snap_to_ticks\fP ($snap_to_ticks)"
.IX Subsection "$spin_button->set_snap_to_ticks ($snap_to_ticks)"
.IP \(bu 4
\&\f(CW$snap_to_ticks\fR (boolean)
.ie n .SS "$spin_button\->\fBspin\fP ($direction, $increment)"
.el .SS "\f(CW$spin_button\fP\->\fBspin\fP ($direction, \f(CW$increment\fP)"
.IX Subsection "$spin_button->spin ($direction, $increment)"
.IP \(bu 4
\&\f(CW$direction\fR (Gtk2::SpinType)
.IP \(bu 4
\&\f(CW$increment\fR (double)
.ie n .SS $spin_button\->\fBupdate\fP
.el .SS \f(CW$spin_button\fP\->\fBupdate\fP
.IX Subsection "$spin_button->update"
.ie n .SS "spinbuttonupdatepolicy = $spin_button\->\fBget_update_policy\fP"
.el .SS "spinbuttonupdatepolicy = \f(CW$spin_button\fP\->\fBget_update_policy\fP"
.IX Subsection "spinbuttonupdatepolicy = $spin_button->get_update_policy"
.ie n .SS "$spin_button\->\fBset_update_policy\fP ($policy)"
.el .SS "\f(CW$spin_button\fP\->\fBset_update_policy\fP ($policy)"
.IX Subsection "$spin_button->set_update_policy ($policy)"
.IP \(bu 4
\&\f(CW$policy\fR (Gtk2::SpinButtonUpdatePolicy)
.ie n .SS "integer = $spin_button\->\fBget_value_as_int\fP"
.el .SS "integer = \f(CW$spin_button\fP\->\fBget_value_as_int\fP"
.IX Subsection "integer = $spin_button->get_value_as_int"
.ie n .SS "double = $spin_button\->\fBget_value\fP"
.el .SS "double = \f(CW$spin_button\fP\->\fBget_value\fP"
.IX Subsection "double = $spin_button->get_value"
.ie n .SS "$spin_button\->\fBset_value\fP ($value)"
.el .SS "\f(CW$spin_button\fP\->\fBset_value\fP ($value)"
.IX Subsection "$spin_button->set_value ($value)"
.IP \(bu 4
\&\f(CW$value\fR (double)
.ie n .SS "boolean = $spin_button\->\fBget_wrap\fP"
.el .SS "boolean = \f(CW$spin_button\fP\->\fBget_wrap\fP"
.IX Subsection "boolean = $spin_button->get_wrap"
.ie n .SS "$spin_button\->\fBset_wrap\fP ($wrap)"
.el .SS "\f(CW$spin_button\fP\->\fBset_wrap\fP ($wrap)"
.IX Subsection "$spin_button->set_wrap ($wrap)"
.IP \(bu 4
\&\f(CW$wrap\fR (boolean)
.SH PROPERTIES
.IX Header "PROPERTIES"
.IP "'adjustment' (Gtk2::Adjustment : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'adjustment' (Gtk2::Adjustment : default undef : readable / writable / private / static-nick / static-blurb)"
The adjustment that holds the value of the spinbutton
.IP "'climb\-rate' (double : default 0 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'climb-rate' (double : default 0 : readable / writable / private / static-nick / static-blurb)"
The acceleration rate when you hold down a button
.IP "'digits' (Glib::UInt : default 0 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'digits' (Glib::UInt : default 0 : readable / writable / private / static-nick / static-blurb)"
The number of decimal places to display
.IP "'numeric' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'numeric' (boolean : default false : readable / writable / private / static-nick / static-blurb)"
Whether non-numeric characters should be ignored
.IP "'snap\-to\-ticks' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'snap-to-ticks' (boolean : default false : readable / writable / private / static-nick / static-blurb)"
Whether erroneous values are automatically changed to a spin button's nearest step increment
.IP "'update\-policy' (Gtk2::SpinButtonUpdatePolicy : default ""always"" : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'update-policy' (Gtk2::SpinButtonUpdatePolicy : default ""always"" : readable / writable / private / static-nick / static-blurb)"
Whether the spin button should update always, or only when the value is legal
.IP "'value' (double : default 0 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'value' (double : default 0 : readable / writable / private / static-nick / static-blurb)"
Reads the current value, or sets a new value
.IP "'wrap' (boolean : default false : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'wrap' (boolean : default false : readable / writable / private / static-nick / static-blurb)"
Whether a spin button should wrap upon reaching its limits
.SH "STYLE PROPERTIES"
.IX Header "STYLE PROPERTIES"
.IP "'shadow\-type' (Gtk2::ShadowType : default ""in"" : readable / private / static-nick / static-blurb)" 4
.IX Item "'shadow-type' (Gtk2::ShadowType : default ""in"" : readable / private / static-nick / static-blurb)"
Style of bevel around the spin button
.SH SIGNALS
.IX Header "SIGNALS"
.IP "\fBchange-value\fR (Gtk2::SpinButton, Gtk2::ScrollType)" 4
.IX Item "change-value (Gtk2::SpinButton, Gtk2::ScrollType)"
.PD 0
.IP "integer = \fBinput\fR (Gtk2::SpinButton, gpointer)" 4
.IX Item "integer = input (Gtk2::SpinButton, gpointer)"
.IP "boolean = \fBoutput\fR (Gtk2::SpinButton)" 4
.IX Item "boolean = output (Gtk2::SpinButton)"
.IP "\fBvalue-changed\fR (Gtk2::SpinButton)" 4
.IX Item "value-changed (Gtk2::SpinButton)"
.IP "\fBwrapped\fR (Gtk2::SpinButton)" 4
.IX Item "wrapped (Gtk2::SpinButton)"
.PD
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::ScrollType"
.IX Subsection "enum Gtk2::ScrollType"
.IP \(bu 4
\&'none' / 'GTK_SCROLL_NONE'
.IP \(bu 4
\&'jump' / 'GTK_SCROLL_JUMP'
.IP \(bu 4
\&'step\-backward' / 'GTK_SCROLL_STEP_BACKWARD'
.IP \(bu 4
\&'step\-forward' / 'GTK_SCROLL_STEP_FORWARD'
.IP \(bu 4
\&'page\-backward' / 'GTK_SCROLL_PAGE_BACKWARD'
.IP \(bu 4
\&'page\-forward' / 'GTK_SCROLL_PAGE_FORWARD'
.IP \(bu 4
\&'step\-up' / 'GTK_SCROLL_STEP_UP'
.IP \(bu 4
\&'step\-down' / 'GTK_SCROLL_STEP_DOWN'
.IP \(bu 4
\&'page\-up' / 'GTK_SCROLL_PAGE_UP'
.IP \(bu 4
\&'page\-down' / 'GTK_SCROLL_PAGE_DOWN'
.IP \(bu 4
\&'step\-left' / 'GTK_SCROLL_STEP_LEFT'
.IP \(bu 4
\&'step\-right' / 'GTK_SCROLL_STEP_RIGHT'
.IP \(bu 4
\&'page\-left' / 'GTK_SCROLL_PAGE_LEFT'
.IP \(bu 4
\&'page\-right' / 'GTK_SCROLL_PAGE_RIGHT'
.IP \(bu 4
\&'start' / 'GTK_SCROLL_START'
.IP \(bu 4
\&'end' / 'GTK_SCROLL_END'
.SS "enum Gtk2::SpinButtonUpdatePolicy"
.IX Subsection "enum Gtk2::SpinButtonUpdatePolicy"
.IP \(bu 4
\&'always' / 'GTK_UPDATE_ALWAYS'
.IP \(bu 4
\&'if\-valid' / 'GTK_UPDATE_IF_VALID'
.SS "enum Gtk2::SpinType"
.IX Subsection "enum Gtk2::SpinType"
.IP \(bu 4
\&'step\-forward' / 'GTK_SPIN_STEP_FORWARD'
.IP \(bu 4
\&'step\-backward' / 'GTK_SPIN_STEP_BACKWARD'
.IP \(bu 4
\&'page\-forward' / 'GTK_SPIN_PAGE_FORWARD'
.IP \(bu 4
\&'page\-backward' / 'GTK_SPIN_PAGE_BACKWARD'
.IP \(bu 4
\&'home' / 'GTK_SPIN_HOME'
.IP \(bu 4
\&'end' / 'GTK_SPIN_END'
.IP \(bu 4
\&'user\-defined' / 'GTK_SPIN_USER_DEFINED'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Entry
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the LGPL.  See Gtk2 for a full notice.