GtkSpinButton

typedef struct _GtkSpinButton GtkSpinButton;

entry is the GtkEntry part of the GtkSpinButton widget, and can be used accordingly. All other fields contain private data and should only be modified using the functions below.

enum GtkSpinButtonUpdatePolicy

typedef enum
{
  GTK_UPDATE_ALWAYS,
  GTK_UPDATE_IF_VALID
} GtkSpinButtonUpdatePolicy;

enum GtkSpinType

typedef enum
{
  GTK_SPIN_STEP_FORWARD,
  GTK_SPIN_STEP_BACKWARD,
  GTK_SPIN_PAGE_FORWARD,
  GTK_SPIN_PAGE_BACKWARD,
  GTK_SPIN_HOME,
  GTK_SPIN_END,
  GTK_SPIN_USER_DEFINED
} GtkSpinType;

gtk_spin_button_configure ()

void        gtk_spin_button_configure       (GtkSpinButton *spin_button,
                                             GtkAdjustment *adjustment,
                                             gdouble climb_rate,
                                             guint digits);

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.

gtk_spin_button_new ()

GtkWidget*  gtk_spin_button_new             (GtkAdjustment *adjustment,
                                             gdouble climb_rate,
                                             guint digits);

Creates a new GtkSpinButton.

gtk_spin_button_new_with_range ()

GtkWidget*  gtk_spin_button_new_with_range  (gdouble min,
                                             gdouble max,
                                             gdouble step);

This is a convenience constructor that allows creation of a numeric GtkSpinButton 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.

gtk_spin_button_set_adjustment ()

void        gtk_spin_button_set_adjustment  (GtkSpinButton *spin_button,
                                             GtkAdjustment *adjustment);

Replaces the GtkAdjustment associated with spin_button.

gtk_spin_button_get_adjustment ()

GtkAdjustment* gtk_spin_button_get_adjustment
                                            (GtkSpinButton *spin_button);

Get the adjustment associated with a GtkSpinButton

gtk_spin_button_set_digits ()

void        gtk_spin_button_set_digits      (GtkSpinButton *spin_button,
                                             guint digits);

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

gtk_spin_button_set_increments ()

void        gtk_spin_button_set_increments  (GtkSpinButton *spin_button,
                                             gdouble step,
                                             gdouble page);

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

gtk_spin_button_set_range ()

void        gtk_spin_button_set_range       (GtkSpinButton *spin_button,
                                             gdouble min,
                                             gdouble max);

Sets the minimum and maximum allowable values for spin_button

gtk_spin_button_get_value_as_float

#define gtk_spin_button_get_value_as_float gtk_spin_button_get_value

Gets the value in the spin_button. This function is deprecated, use gtk_spin_button_get_value() instead.

gtk_spin_button_get_value_as_int ()

gint        gtk_spin_button_get_value_as_int
                                            (GtkSpinButton *spin_button);

Get the value spin_button represented as an integer.

gtk_spin_button_set_value ()

void        gtk_spin_button_set_value       (GtkSpinButton *spin_button,
                                             gdouble value);

Set the value of spin_button.

gtk_spin_button_set_update_policy ()

void        gtk_spin_button_set_update_policy
                                            (GtkSpinButton *spin_button,
                                             GtkSpinButtonUpdatePolicy 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.

gtk_spin_button_set_numeric ()

void        gtk_spin_button_set_numeric     (GtkSpinButton *spin_button,
                                             gboolean numeric);

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

gtk_spin_button_spin ()

void        gtk_spin_button_spin            (GtkSpinButton *spin_button,
                                             GtkSpinType direction,
                                             gdouble increment);

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

gtk_spin_button_set_wrap ()

void        gtk_spin_button_set_wrap        (GtkSpinButton *spin_button,
                                             gboolean wrap);

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.

gtk_spin_button_set_snap_to_ticks ()

void        gtk_spin_button_set_snap_to_ticks
                                            (GtkSpinButton *spin_button,
                                             gboolean snap_to_ticks);

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.

gtk_spin_button_update ()

void        gtk_spin_button_update          (GtkSpinButton *spin_button);

Manually force an update of the spin button.

gtk_spin_button_get_digits ()

guint       gtk_spin_button_get_digits      (GtkSpinButton *spin_button);

Fetches the precision of spin_button. See gtk_spin_button_set_digits().

gtk_spin_button_get_increments ()

void        gtk_spin_button_get_increments  (GtkSpinButton *spin_button,
                                             gdouble *step,
                                             gdouble *page);

Gets the current step and page the increments used by spin_button. See gtk_spin_button_set_increments().

gtk_spin_button_get_numeric ()

gboolean    gtk_spin_button_get_numeric     (GtkSpinButton *spin_button);

Returns whether non-numeric text can be typed into the spin button. See gtk_spin_button_set_numeric().

gtk_spin_button_get_range ()

void        gtk_spin_button_get_range       (GtkSpinButton *spin_button,
                                             gdouble *min,
                                             gdouble *max);

Gets the range allowed for spin_button. See gtk_spin_button_set_range().

gtk_spin_button_get_snap_to_ticks ()

gboolean    gtk_spin_button_get_snap_to_ticks
                                            (GtkSpinButton *spin_button);

Returns whether the values are corrected to the nearest step. See gtk_spin_button_set_snap_to_ticks().

gtk_spin_button_get_update_policy ()

GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy
                                            (GtkSpinButton *spin_button);

Gets the update behavior of a spin button. See gtk_spin_button_set_update_policy().

gtk_spin_button_get_value ()

gdouble     gtk_spin_button_get_value       (GtkSpinButton *spin_button);

Get the value in the spin_button.

gtk_spin_button_get_wrap ()

gboolean    gtk_spin_button_get_wrap        (GtkSpinButton *spin_button);

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().

GTK_INPUT_ERROR

#define GTK_INPUT_ERROR -1

The "adjustment" property

  "adjustment"           GtkAdjustment         : Read / Write

The adjustment that holds the value of the spinbutton.

The "climb-rate" property

  "climb-rate"           gdouble               : Read / Write

The acceleration rate when you hold down a button.

Allowed values: >= 0

Default value: 0

The "digits" property

  "digits"               guint                 : Read / Write

The number of decimal places to display.

Allowed values: <= 20

Default value: 0

The "numeric" property

  "numeric"              gboolean              : Read / Write

Whether non-numeric characters should be ignored.

Default value: FALSE

The "snap-to-ticks" property

  "snap-to-ticks"        gboolean              : Read / Write

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

Default value: FALSE

The "update-policy" property

  "update-policy"        GtkSpinButtonUpdatePolicy  : Read / Write

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

Default value: GTK_UPDATE_ALWAYS

The "value" property

  "value"                gdouble               : Read / Write

Reads the current value, or sets a new value.

Default value: 0

The "wrap" property

  "wrap"                 gboolean              : Read / Write

Whether a spin button should wrap upon reaching its limits.

Default value: FALSE

The "shadow-type" style property

  "shadow-type"          GtkShadowType         : Read

the type of border that surrounds the arrows of a spin button.

Default value: GTK_SHADOW_IN

The "change-value" signal

void        user_function                  (GtkSpinButton *spinbutton,
                                            GtkScrollType arg1,
                                            gpointer user_data);

The "input" signal

gint        user_function                  (GtkSpinButton *spinbutton,
                                            gpointer arg1,
                                            gpointer user_data);

The "output" signal

gboolean    user_function                  (GtkSpinButton *spinbutton,
                                            gpointer user_data);

The "value-changed" signal

void        user_function                  (GtkSpinButton *spinbutton,
                                            gpointer user_data);