Gtk2::SpinButton(3)

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 / static-nick / static-blurb)
    The adjustment that holds the value of the spinbutton

'climb-rate' (double : default 0 : readable / writable / private / static-nick / static-blurb)
    The acceleration rate when you hold down a button

'digits' (Glib::UInt : default 0 : readable / writable / private / static-nick / static-blurb)
    The number of decimal places to display

'numeric' (boolean : default false : readable / writable / private / static-nick / static-blurb)
    Whether non-numeric characters should be ignored

'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

'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

'value' (double : default 0 : readable / writable / private / static-nick / static-blurb)
    Reads the current value, or sets a new value

'wrap' (boolean : default false : readable / writable / private / static-nick / static-blurb)
    Whether a spin button should wrap upon reaching its limits

STYLE PROPERTIES

'shadow-type' (Gtk2::ShadowType : default "in" : readable / private / static-nick / static-blurb)
    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.