SpinButton

Object Hierarchy:

Description:

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

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

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

public class Application : Gtk.Window {
	public Application () {
		// Prepare Gtk.Window:
		this.title = "My Gtk.SpinButton";
		this.window_position = Gtk.WindowPosition.CENTER;
		this.destroy.connect (Gtk.main_quit);

		// The button:
		Gtk.SpinButton button = new Gtk.SpinButton.with_range (0, 10, 1);
		this.add (button);

		// Catch changes:
		button.value_changed.connect (() => {
			int val = button.get_value_as_int ();
			print ("%d\n", val);
		});
	}

	public static int main (string[] args) {
		Gtk.init (ref args);

		Application app = new Application ();
		app.show_all ();
		Gtk.main ();
		return 0;
	}
}

valac --pkg gtk+-3.0 Gtk.SpinButton.vala

Content:

Properties:

• public Adjustment adjustment { get; set; }
• public double climb_rate { get; set; }
• public uint digits { get; set; }
• public bool numeric { get; set; }
• public bool snap_to_ticks { get; set; }
• public SpinButtonUpdatePolicy update_policy { get; set; }
• public double value { get; set; }
• public bool wrap { get; set; }

Creation methods:

• public SpinButton (Adjustment? adjustment, double climb_rate, uint digits)
  Creates a new SpinButton.
• public SpinButton.with_range (double min, double max, double step)
  This is a convenience constructor that allows creation of a numeric SpinButton without manually creating an adjustment.

Methods:

• public void configure (Adjustment? adjustment, double climb_rate, uint digits)
  Changes the properties of an existing spin button.
• public unowned Adjustment get_adjustment ()
  Get the adjustment associated with a SpinButton
• public uint get_digits ()
  Fetches the precision of this.
• public void get_increments (out double step, out double page)
  Gets the current step and page the increments used by this.
• public bool get_numeric ()
  Returns whether non-numeric text can be typed into the spin button.
• public void get_range (out double min, out double max)
  Gets the range allowed for this.
• public bool get_snap_to_ticks ()
  Returns whether the values are corrected to the nearest step.
• public SpinButtonUpdatePolicy get_update_policy ()
  Gets the update behavior of a spin button.
• public double get_value ()
  Get the value in the this.
• public int get_value_as_int ()
  Get the value this represented as an integer.
• public bool get_wrap ()
  Returns whether the spin button’s value wraps around to the opposite limit when the upper or lower limit of the range is exceeded.
• public void set_adjustment (Adjustment adjustment)
  Replaces the Adjustment associated with this.
• public void set_digits (uint digits)
  Set the precision to be displayed by this.
• public void set_increments (double step, double page)
  Sets the step and page increments for spin_button.
• public void set_numeric (bool numeric)
  Sets the flag that determines if non-numeric text can be typed into the spin button.
• public void set_range (double min, double max)
  Sets the minimum and maximum allowable values for this.
• public void set_snap_to_ticks (bool 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.
• public void set_update_policy (SpinButtonUpdatePolicy policy)
  Sets the update behavior of a spin button.
• public void set_value (double value)
  Sets the value of this.
• public void set_wrap (bool 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.
• public void spin (SpinType direction, double increment)
  Increment or decrement a spin button’s value in a specified direction by a specified amount.
• public void update ()
  Manually force an update of the spin button.

Signals:

• public virtual signal void change_value (ScrollType scroll)
  The change_value signal is a keybinding signal which gets emitted when the user initiates a value change.
• public virtual signal int input (out double new_value)
  The input signal can be used to influence the conversion of the users input into a double value.
• public virtual signal bool output ()
  The output signal can be used to change to formatting of the value that is displayed in the spin buttons entry.
• public virtual signal void value_changed ()
  The value_changed signal is emitted when the value represented by spinbutton changes.
• public virtual signal void wrapped ()
  The wrapped signal is emitted right after the spinbutton wraps from its maximum to minimum value or vice-versa.

Inherited Members: