Gtk.Spin_Button

Entities

Simple Types

Tagged Types

Access Types

Constants

Subprograms

Generic Instantiations

Description

A Gtk.Spin_Button.Gtk_Spin_Button 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 Gtk.GEntry.Gtk_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 Gtk.Adjustment.Gtk_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 Gtk.GEntry.Gtk_Entry:width-chars and Gtk.GEntry.Gtk_Entry:max-width-chars poperties to the desired number of characters to display in the entry.

# CSS nodes

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


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

// 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

// 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);
}

"+"

function "+"
  (Widget : access Gtk_Spin_Button_Record'Class)
return Gtk.Buildable.Gtk_Buildable
Parameters
Widget
Return Value

"+"

function "+"
  (Widget : access Gtk_Spin_Button_Record'Class)
return Gtk.Cell_Editable.Gtk_Cell_Editable
Parameters
Widget
Return Value

"+"

function "+"
  (Widget : access Gtk_Spin_Button_Record'Class)
return Gtk.Editable.Gtk_Editable
Parameters
Widget
Return Value

"+"

function "+"
  (Widget : access Gtk_Spin_Button_Record'Class)
return Gtk.Orientable.Gtk_Orientable
Parameters
Widget
Return Value

"-"

function "-"
  (Interf : Gtk.Buildable.Gtk_Buildable)
return Gtk_Spin_Button
Parameters
Interf
Return Value

"-"

function "-"
  (Interf : Gtk.Cell_Editable.Gtk_Cell_Editable)
return Gtk_Spin_Button
Parameters
Interf
Return Value

"-"

function "-"
  (Interf : Gtk.Editable.Gtk_Editable)
return Gtk_Spin_Button
Parameters
Interf
Return Value

"-"

function "-"
  (Interf : Gtk.Orientable.Gtk_Orientable)
return Gtk_Spin_Button
Parameters
Interf
Return Value

Adjustment_Property

Adjustment_Property : constant Glib.Properties.Property_Object;

Type: Gtk.Adjustment.Gtk_Adjustment

Cb_GObject_Boolean

type Cb_GObject_Boolean is not null access function
  (Self : access Glib.Object.GObject_Record'Class)
return Boolean;
Parameters
Self
Return Value

Cb_GObject_Gdouble_Gint

type Cb_GObject_Gdouble_Gint is not null access function
  (Self      : access Glib.Object.GObject_Record'Class;
   New_Value : access Gdouble) return Glib.Gint;
Parameters
Self
New_Value
Return Value

Cb_GObject_Gtk_Scroll_Type_Void

type Cb_GObject_Gtk_Scroll_Type_Void is not null access procedure
  (Self   : access Glib.Object.GObject_Record'Class;
   Scroll : Gtk.Enums.Gtk_Scroll_Type);
Parameters
Self
Scroll

Cb_GObject_Void

type Cb_GObject_Void is not null access procedure
  (Self : access Glib.Object.GObject_Record'Class);
Parameters
Self

Cb_Gtk_Spin_Button_Boolean

type Cb_Gtk_Spin_Button_Boolean is not null access function
  (Self : access Gtk_Spin_Button_Record'Class) return Boolean;
Parameters
Self
Return Value

Cb_Gtk_Spin_Button_Gdouble_Gint

type Cb_Gtk_Spin_Button_Gdouble_Gint is not null access function
  (Self      : access Gtk_Spin_Button_Record'Class;
   New_Value : access Gdouble) return Glib.Gint;
Parameters
Self
New_Value
Return Value

Cb_Gtk_Spin_Button_Gtk_Scroll_Type_Void

type Cb_Gtk_Spin_Button_Gtk_Scroll_Type_Void is not null access procedure
  (Self   : access Gtk_Spin_Button_Record'Class;
   Scroll : Gtk.Enums.Gtk_Scroll_Type);
Parameters
Self
Scroll

Cb_Gtk_Spin_Button_Void

type Cb_Gtk_Spin_Button_Void is not null access procedure
  (Self : access Gtk_Spin_Button_Record'Class);
Parameters
Self

Climb_Rate_Property

Climb_Rate_Property : constant Glib.Properties.Property_Double;

Type: Gdouble

Configure

procedure Configure
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Adjustment  : access Gtk.Adjustment.Gtk_Adjustment_Record'Class;
    Climb_Rate  : Gdouble;
    The_Digits  : Guint)

Changes the properties of an existing spin button. The adjustment, climb rate, and number of decimal places are updated accordingly.

Parameters
Spin_Button
Adjustment

a Gtk.Adjustment.Gtk_Adjustment to replace the spin button's existing adjustment, or null to leave its current adjustment unchanged

Climb_Rate

the new climb rate

The_Digits

the number of decimal places to display in the spin button

Copy_Clipboard

procedure Copy_Clipboard
   (Editable : not null access Gtk_Spin_Button_Record)
Parameters
Editable

Cut_Clipboard

procedure Cut_Clipboard
   (Editable : not null access Gtk_Spin_Button_Record)
Parameters
Editable

Delete_Selection

procedure Delete_Selection
   (Editable : not null access Gtk_Spin_Button_Record)
Parameters
Editable

Delete_Text

procedure Delete_Text
   (Editable  : not null access Gtk_Spin_Button_Record;
    Start_Pos : Glib.Gint;
    End_Pos   : Glib.Gint := -1)
Parameters
Editable
Start_Pos
End_Pos

Editing_Done

procedure Editing_Done
   (Cell_Editable : not null access Gtk_Spin_Button_Record)
Parameters
Cell_Editable

Get_Adjustment

function Get_Adjustment
   (Spin_Button : not null access Gtk_Spin_Button_Record)
    return Gtk.Adjustment.Gtk_Adjustment

Get the adjustment associated with a Gtk.Spin_Button.Gtk_Spin_Button

Parameters
Spin_Button
Return Value

the Gtk.Adjustment.Gtk_Adjustment of Spin_Button

Get_Chars

function Get_Chars
   (Editable  : not null access Gtk_Spin_Button_Record;
    Start_Pos : Glib.Gint;
    End_Pos   : Glib.Gint := -1) return UTF8_String
Parameters
Editable
Start_Pos
End_Pos
Return Value

Get_Digits

function Get_Digits
   (Spin_Button : not null access Gtk_Spin_Button_Record) return Guint

Fetches the precision of Spin_Button. See Gtk.Spin_Button.Set_Digits.

Parameters
Spin_Button
Return Value

the current precision

Get_Editable

function Get_Editable
   (Editable : not null access Gtk_Spin_Button_Record) return Boolean
Parameters
Editable
Return Value

Get_Increments

procedure Get_Increments
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Step        : out Gdouble;
    Page        : out Gdouble)

Gets the current step and page the increments used by Spin_Button. See Gtk.Spin_Button.Set_Increments.

Parameters
Spin_Button
Step

location to store step increment, or null

Page

location to store page increment, or null

Get_Numeric

function Get_Numeric
   (Spin_Button : not null access Gtk_Spin_Button_Record) return Boolean

Returns whether non-numeric text can be typed into the spin button. See Gtk.Spin_Button.Set_Numeric.

Parameters
Spin_Button
Return Value

True if only numeric text can be entered

Get_Orientation

function Get_Orientation
   (Self : not null access Gtk_Spin_Button_Record)
    return Gtk.Enums.Gtk_Orientation
Parameters
Self
Return Value

Get_Position

function Get_Position
   (Editable : not null access Gtk_Spin_Button_Record) return Glib.Gint
Parameters
Editable
Return Value

Get_Range

procedure Get_Range
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Min         : out Gdouble;
    Max         : out Gdouble)

Gets the range allowed for Spin_Button. See Gtk.Spin_Button.Set_Range.

Parameters
Spin_Button
Min

location to store minimum allowed value, or null

Max

location to store maximum allowed value, or null

Get_Selection_Bounds

procedure Get_Selection_Bounds
   (Editable      : not null access Gtk_Spin_Button_Record;
    Start_Pos     : out Glib.Gint;
    End_Pos       : out Glib.Gint;
    Has_Selection : out Boolean)
Parameters
Editable
Start_Pos
End_Pos
Has_Selection

Get_Snap_To_Ticks

function Get_Snap_To_Ticks
   (Spin_Button : not null access Gtk_Spin_Button_Record) return Boolean

Returns whether the values are corrected to the nearest step. See Gtk.Spin_Button.Set_Snap_To_Ticks.

Parameters
Spin_Button
Return Value

True if values are snapped to the nearest step

Get_Type

function Get_Type return Glib.GType
Return Value

Get_Update_Policy

function Get_Update_Policy
   (Spin_Button : not null access Gtk_Spin_Button_Record)
    return Gtk_Spin_Button_Update_Policy

Gets the update behavior of a spin button. See Gtk.Spin_Button.Set_Update_Policy.

Parameters
Spin_Button
Return Value

the current update policy

Get_Value

function Get_Value
   (Spin_Button : not null access Gtk_Spin_Button_Record) return Gdouble

Get the value in the Spin_Button.

Parameters
Spin_Button
Return Value

the value of Spin_Button

Get_Value_As_Int

function Get_Value_As_Int
   (Spin_Button : not null access Gtk_Spin_Button_Record)
    return Glib.Gint

Get the value Spin_Button represented as an integer.

Parameters
Spin_Button
Return Value

the value of Spin_Button

Get_Wrap

function Get_Wrap
   (Spin_Button : not null access Gtk_Spin_Button_Record) return Boolean

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 Gtk.Spin_Button.Set_Wrap.

Parameters
Spin_Button
Return Value

True if the spin button wraps around

Gtk_New

procedure Gtk_New
   (Spin_Button : out Gtk_Spin_Button;
    Adjustment  : access Gtk.Adjustment.Gtk_Adjustment_Record'Class;
    Climb_Rate  : Gdouble;
    The_Digits  : Guint := 0)

Creates a new Gtk.Spin_Button.Gtk_Spin_Button. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Spin_Button
Adjustment

the Gtk.Adjustment.Gtk_Adjustment object that this spin button should use, or null

Climb_Rate

specifies by how much the rate of change in the value will accelerate if you continue to hold down an up/down button or arrow key

The_Digits

the number of decimal places to display

Gtk_New

procedure Gtk_New
   (Spin_Button : out Gtk_Spin_Button;
    Min         : Gdouble;
    Max         : Gdouble;
    Step        : Gdouble)

This is a convenience constructor that allows creation of a numeric Gtk.Spin_Button.Gtk_Spin_Button 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 Gtk.Spin_Button.Set_Digits to correct it. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Spin_Button
Min

Minimum allowable value

Max

Maximum allowable value

Step

Increment added or subtracted by spinning the widget

Gtk_Spin_Button

type Gtk_Spin_Button is access all Gtk_Spin_Button_Record'Class;

Gtk_Spin_Button_New

function Gtk_Spin_Button_New
   (Adjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class;
    Climb_Rate : Gdouble;
    The_Digits : Guint := 0) return Gtk_Spin_Button

Creates a new Gtk.Spin_Button.Gtk_Spin_Button.

Parameters
Adjustment

the Gtk.Adjustment.Gtk_Adjustment object that this spin button should use, or null

Climb_Rate

specifies by how much the rate of change in the value will accelerate if you continue to hold down an up/down button or arrow key

The_Digits

the number of decimal places to display

Return Value

Gtk_Spin_Button_New_With_Range

function Gtk_Spin_Button_New_With_Range
   (Min  : Gdouble;
    Max  : Gdouble;
    Step : Gdouble) return Gtk_Spin_Button

This is a convenience constructor that allows creation of a numeric Gtk.Spin_Button.Gtk_Spin_Button 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 Gtk.Spin_Button.Set_Digits to correct it.

Parameters
Min

Minimum allowable value

Max

Maximum allowable value

Step

Increment added or subtracted by spinning the widget

Return Value

Gtk_Spin_Button_Record

type Gtk_Spin_Button_Record is new Gtk_Entry_Record with null record;

Gtk_Spin_Button_Update_Policy

type Gtk_Spin_Button_Update_Policy is (
   Update_Always,
   Update_If_Valid);

The spin button update policy determines whether the spin button displays values even if they are outside the bounds of its adjustment. See Gtk.Spin_Button.Set_Update_Policy.

Enumeration Literal
Update_Always
Update_If_Valid

Gtk_Spin_Button_Update_Policy_Properties

package Gtk_Spin_Button_Update_Policy_Properties is
   new Generic_Internal_Discrete_Property (Gtk_Spin_Button_Update_Policy);

Gtk_Spin_Type

type Gtk_Spin_Type is (
   Spin_Step_Forward,
   Spin_Step_Backward,
   Spin_Page_Forward,
   Spin_Page_Backward,
   Spin_Home,
   Spin_End,
   Spin_User_Defined);

The values of the GtkSpinType enumeration are used to specify the change to make in Gtk.Spin_Button.Spin.

Enumeration Literal
Spin_Step_Forward
Spin_Step_Backward
Spin_Page_Forward
Spin_Page_Backward
Spin_Home
Spin_End
Spin_User_Defined

Gtk_Spin_Type_Properties

package Gtk_Spin_Type_Properties is
   new Generic_Internal_Discrete_Property (Gtk_Spin_Type);

Implements_Gtk_Buildable

package Implements_Gtk_Buildable is new Glib.Types.Implements
  (Gtk.Buildable.Gtk_Buildable, Gtk_Spin_Button_Record, Gtk_Spin_Button);

Implements_Gtk_Cell_Editable

package Implements_Gtk_Cell_Editable is new Glib.Types.Implements
  (Gtk.Cell_Editable.Gtk_Cell_Editable, Gtk_Spin_Button_Record, Gtk_Spin_Button);

Implements_Gtk_Editable

package Implements_Gtk_Editable is new Glib.Types.Implements
  (Gtk.Editable.Gtk_Editable, Gtk_Spin_Button_Record, Gtk_Spin_Button);

Implements_Gtk_Orientable

package Implements_Gtk_Orientable is new Glib.Types.Implements
  (Gtk.Orientable.Gtk_Orientable, Gtk_Spin_Button_Record, Gtk_Spin_Button);

Initialize

procedure Initialize
   (Spin_Button : not null access Gtk_Spin_Button_Record'Class;
    Adjustment  : access Gtk.Adjustment.Gtk_Adjustment_Record'Class;
    Climb_Rate  : Gdouble;
    The_Digits  : Guint := 0)

Creates a new Gtk.Spin_Button.Gtk_Spin_Button. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Spin_Button
Adjustment

the Gtk.Adjustment.Gtk_Adjustment object that this spin button should use, or null

Climb_Rate

specifies by how much the rate of change in the value will accelerate if you continue to hold down an up/down button or arrow key

The_Digits

the number of decimal places to display

Initialize

procedure Initialize
   (Spin_Button : not null access Gtk_Spin_Button_Record'Class;
    Min         : Gdouble;
    Max         : Gdouble;
    Step        : Gdouble)

This is a convenience constructor that allows creation of a numeric Gtk.Spin_Button.Gtk_Spin_Button 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 Gtk.Spin_Button.Set_Digits to correct it. Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Spin_Button
Min

Minimum allowable value

Max

Maximum allowable value

Step

Increment added or subtracted by spinning the widget

Insert_Text

procedure Insert_Text
   (Editable        : not null access Gtk_Spin_Button_Record;
    New_Text        : UTF8_String;
    New_Text_Length : Glib.Gint;
    Position        : in out Glib.Gint)
Parameters
Editable
New_Text
New_Text_Length
Position

Numeric_Property

Numeric_Property : constant Glib.Properties.Property_Boolean;

On_Change_Value

procedure On_Change_Value
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_GObject_Gtk_Scroll_Type_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

The ::change-value signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a value change.

Applications should not connect to it, but may emit it with g_signal_emit_by_name if they need to control the cursor programmatically.

The default bindings for this signal are Up/Down and PageUp and/PageDown.

Parameters
Self
Call
Slot
After

On_Change_Value

procedure On_Change_Value
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_Gtk_Spin_Button_Gtk_Scroll_Type_Void;
    After : Boolean := False)

The ::change-value signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a value change.

Applications should not connect to it, but may emit it with g_signal_emit_by_name if they need to control the cursor programmatically.

The default bindings for this signal are Up/Down and PageUp and/PageDown.

Parameters
Self
Call
After

On_Input

procedure On_Input
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_GObject_Gdouble_Gint;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

The ::input signal can be used to influence the conversion of the users input into a double value. The signal handler is expected to use Gtk.GEntry.Get_Text to retrieve the text of the entry and set New_Value to the new value.

The default conversion uses g_strtod.

Callback parameters: -- @param New_Value return location for the new value

Parameters
Self
Call
Slot
After

On_Input

procedure On_Input
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_Gtk_Spin_Button_Gdouble_Gint;
    After : Boolean := False)

The ::input signal can be used to influence the conversion of the users input into a double value. The signal handler is expected to use Gtk.GEntry.Get_Text to retrieve the text of the entry and set New_Value to the new value.

The default conversion uses g_strtod.

Callback parameters: -- @param New_Value return location for the new value

Parameters
Self
Call
After

On_Output

procedure On_Output
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_GObject_Boolean;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

The ::output signal can be used to change to formatting of the value that is displayed in the spin buttons entry.

// show leading zeros
static gboolean
on_output (GtkSpinButton *spin,
           gpointer       data)
{
   GtkAdjustment *adjustment;
   gchar *text;
   int value;

   adjustment = gtk_spin_button_get_adjustment (spin);
   value = (int)gtk_adjustment_get_value (adjustment);
   text = g_strdup_printf ("%02d", value);
   gtk_entry_set_text (GTK_ENTRY (spin), text);
   g_free (text);

   return TRUE;
}

Callback parameters:

Parameters
Self
Call
Slot
After

On_Output

procedure On_Output
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_Gtk_Spin_Button_Boolean;
    After : Boolean := False)

The ::output signal can be used to change to formatting of the value that is displayed in the spin buttons entry.

// show leading zeros
static gboolean
on_output (GtkSpinButton *spin,
           gpointer       data)
{
   GtkAdjustment *adjustment;
   gchar *text;
   int value;

   adjustment = gtk_spin_button_get_adjustment (spin);
   value = (int)gtk_adjustment_get_value (adjustment);
   text = g_strdup_printf ("%02d", value);
   gtk_entry_set_text (GTK_ENTRY (spin), text);
   g_free (text);

   return TRUE;
}

Callback parameters:

Parameters
Self
Call
After

On_Value_Changed

procedure On_Value_Changed
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_GObject_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

The ::value-changed signal is emitted when the value represented by Spinbutton changes. Also see the Gtk.Spin_Button.Gtk_Spin_Button::output signal.

Parameters
Self
Call
Slot
After

On_Value_Changed

procedure On_Value_Changed
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_Gtk_Spin_Button_Void;
    After : Boolean := False)

The ::value-changed signal is emitted when the value represented by Spinbutton changes. Also see the Gtk.Spin_Button.Gtk_Spin_Button::output signal.

Parameters
Self
Call
After

On_Wrapped

procedure On_Wrapped
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_GObject_Void;
    Slot  : not null access Glib.Object.GObject_Record'Class;
    After : Boolean := False)

The ::wrapped signal is emitted right after the spinbutton wraps from its maximum to minimum value or vice-versa.

Parameters
Self
Call
Slot
After

On_Wrapped

procedure On_Wrapped
   (Self  : not null access Gtk_Spin_Button_Record;
    Call  : Cb_Gtk_Spin_Button_Void;
    After : Boolean := False)

The ::wrapped signal is emitted right after the spinbutton wraps from its maximum to minimum value or vice-versa.

Parameters
Self
Call
After

Paste_Clipboard

procedure Paste_Clipboard
   (Editable : not null access Gtk_Spin_Button_Record)
Parameters
Editable

Property_Gtk_Spin_Button_Update_Policy

type Property_Gtk_Spin_Button_Update_Policy is new Gtk_Spin_Button_Update_Policy_Properties.Property;

Property_Gtk_Spin_Type

type Property_Gtk_Spin_Type is new Gtk_Spin_Type_Properties.Property;

Remove_Widget

procedure Remove_Widget
   (Cell_Editable : not null access Gtk_Spin_Button_Record)
Parameters
Cell_Editable

Select_Region

procedure Select_Region
   (Editable  : not null access Gtk_Spin_Button_Record;
    Start_Pos : Glib.Gint;
    End_Pos   : Glib.Gint := -1)
Parameters
Editable
Start_Pos
End_Pos

Set_Adjustment

procedure Set_Adjustment
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Adjustment  : not null access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Replaces the Gtk.Adjustment.Gtk_Adjustment associated with Spin_Button.

Parameters
Spin_Button
Adjustment

a Gtk.Adjustment.Gtk_Adjustment to replace the existing adjustment

Set_Digits

procedure Set_Digits
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    The_Digits  : Guint)

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

Parameters
Spin_Button
The_Digits

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

Set_Editable

procedure Set_Editable
   (Editable    : not null access Gtk_Spin_Button_Record;
    Is_Editable : Boolean)
Parameters
Editable
Is_Editable

Set_Increments

procedure Set_Increments
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Step        : Gdouble;
    Page        : Gdouble)

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

Parameters
Spin_Button
Step

increment applied for a button 1 press.

Page

increment applied for a button 2 press.

Set_Numeric

procedure Set_Numeric
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Numeric     : Boolean)

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

Parameters
Spin_Button
Numeric

flag indicating if only numeric entry is allowed

Set_Orientation

procedure Set_Orientation
   (Self        : not null access Gtk_Spin_Button_Record;
    Orientation : Gtk.Enums.Gtk_Orientation)
Parameters
Self
Orientation

Set_Position

procedure Set_Position
   (Editable : not null access Gtk_Spin_Button_Record;
    Position : Glib.Gint)
Parameters
Editable
Position

Set_Range

procedure Set_Range
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Min         : Gdouble;
    Max         : Gdouble)

Sets the minimum and maximum allowable values for Spin_Button. If the current value is outside this range, it will be adjusted to fit within the range, otherwise it will remain unchanged.

Parameters
Spin_Button
Min

minimum allowable value

Max

maximum allowable value

Set_Snap_To_Ticks

procedure Set_Snap_To_Ticks
   (Spin_Button   : not null access Gtk_Spin_Button_Record;
    Snap_To_Ticks : Boolean)

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.

Parameters
Spin_Button
Snap_To_Ticks

a flag indicating if invalid values should be corrected

Set_Update_Policy

procedure Set_Update_Policy
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Policy      : Gtk_Spin_Button_Update_Policy)

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.

Parameters
Spin_Button
Policy

a Gtk.Spin_Button.Gtk_Spin_Button_Update_Policy value

Set_Value

procedure Set_Value
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Value       : Gdouble)

Sets the value of Spin_Button.

Parameters
Spin_Button
Value

the new value

Set_Wrap

procedure Set_Wrap
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Wrap        : Boolean)

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.

Parameters
Spin_Button
Wrap

a flag indicating if wrapping behavior is performed

Signal_Change_Value

Signal_Change_Value : constant Glib.Signal_Name := "change-value";

The ::change-value signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a value change.

Applications should not connect to it, but may emit it with g_signal_emit_by_name if they need to control the cursor programmatically.

The default bindings for this signal are Up/Down and PageUp and/PageDown.

Signal_Input

Signal_Input : constant Glib.Signal_Name := "input";

The ::input signal can be used to influence the conversion of the users input into a double value. The signal handler is expected to use Gtk.GEntry.Get_Text to retrieve the text of the entry and set New_Value to the new value.

The default conversion uses g_strtod.

Callback parameters: -- @param New_Value return location for the new value

Signal_Output

Signal_Output : constant Glib.Signal_Name := "output";

The ::output signal can be used to change to formatting of the value that is displayed in the spin buttons entry.

// show leading zeros
static gboolean
on_output (GtkSpinButton *spin,
           gpointer       data)
{
   GtkAdjustment *adjustment;
   gchar *text;
   int value;

   adjustment = gtk_spin_button_get_adjustment (spin);
   value = (int)gtk_adjustment_get_value (adjustment);
   text = g_strdup_printf ("%02d", value);
   gtk_entry_set_text (GTK_ENTRY (spin), text);
   g_free (text);

   return TRUE;
}

Callback parameters:

Signal_Value_Changed

Signal_Value_Changed : constant Glib.Signal_Name := "value-changed";

The ::value-changed signal is emitted when the value represented by Spinbutton changes. Also see the Gtk.Spin_Button.Gtk_Spin_Button::output signal.

Signal_Wrapped

Signal_Wrapped : constant Glib.Signal_Name := "wrapped";

The ::wrapped signal is emitted right after the spinbutton wraps from its maximum to minimum value or vice-versa.

Snap_To_Ticks_Property

Snap_To_Ticks_Property : constant Glib.Properties.Property_Boolean;

Spin

procedure Spin
   (Spin_Button : not null access Gtk_Spin_Button_Record;
    Direction   : Gtk_Spin_Type;
    Increment   : Gdouble)

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

Parameters
Spin_Button
Direction

a Gtk.Spin_Button.Gtk_Spin_Type indicating the direction to spin

Increment

step increment to apply in the specified direction

Start_Editing

procedure Start_Editing
   (Cell_Editable : not null access Gtk_Spin_Button_Record;
    Event         : Gdk.Event.Gdk_Event)
Parameters
Cell_Editable
Event

The_Digits_Property

The_Digits_Property : constant Glib.Properties.Property_Uint;

Update

procedure Update (Spin_Button : not null access Gtk_Spin_Button_Record)

Manually force an update of the spin button.

Parameters
Spin_Button

Update_Policy_Property

Update_Policy_Property : constant Gtk.Spin_Button.Property_Gtk_Spin_Button_Update_Policy;

Type: Gtk_Spin_Button_Update_Policy

Value_Property

Value_Property : constant Glib.Properties.Property_Double;

Type: Gdouble

Wrap_Property

Wrap_Property : constant Glib.Properties.Property_Boolean;