gi-gtk-3.0.11: Gtk bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.SpinButton

Contents

Description

A SpinButton 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 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 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 Entry:width-chars and Entry:max-width-chars poperties to the desired number of characters to display in the entry.

CSS nodes

plain code

spinbutton.horizontal
├── entry
│   ╰── ...
├── button.down
╰── button.up

plain code

spinbutton.vertical
├── 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

C code

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

C code

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

Synopsis

Exported types

Methods

configure

spinButtonConfigure Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a, IsAdjustment b) 
=> a

spinButton: a SpinButton

-> Maybe b

adjustment: a Adjustment

-> Double

climbRate: the new climb rate

-> Word32

digits: the number of decimal places to display in the spin button

-> m () 

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.

getAdjustment

spinButtonGetAdjustment Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m Adjustment

Returns: the Adjustment of spinButton

Get the adjustment associated with a SpinButton

getDigits

spinButtonGetDigits Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m Word32

Returns: the current precision

Fetches the precision of spinButton. See spinButtonSetDigits.

getIncrements

spinButtonGetIncrements Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m (Double, Double) 

Gets the current step and page the increments used by spinButton. See spinButtonSetIncrements.

getNumeric

spinButtonGetNumeric Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m Bool

Returns: True if only numeric text can be entered

Returns whether non-numeric text can be typed into the spin button. See spinButtonSetNumeric.

getRange

spinButtonGetRange Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m (Double, Double) 

Gets the range allowed for spinButton. See spinButtonSetRange.

getSnapToTicks

spinButtonGetSnapToTicks Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m Bool

Returns: True if values are snapped to the nearest step

Returns whether the values are corrected to the nearest step. See spinButtonSetSnapToTicks.

getUpdatePolicy

spinButtonGetUpdatePolicy Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m SpinButtonUpdatePolicy

Returns: the current update policy

Gets the update behavior of a spin button. See spinButtonSetUpdatePolicy.

getValue

spinButtonGetValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m Double

Returns: the value of spinButton

Get the value in the spinButton.

getValueAsInt

spinButtonGetValueAsInt Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m Int32

Returns: the value of spinButton

Get the value spinButton represented as an integer.

getWrap

spinButtonGetWrap Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m Bool

Returns: True if the spin button wraps around

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 spinButtonSetWrap.

new

spinButtonNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a) 
=> Maybe a

adjustment: the Adjustment object that this spin button should use, or Nothing

-> Double

climbRate: specifies how much the spin button changes when an arrow is clicked on

-> Word32

digits: the number of decimal places to display

-> m SpinButton

Returns: The new spin button as a Widget

Creates a new SpinButton.

newWithRange

spinButtonNewWithRange Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Double

min: Minimum allowable value

-> Double

max: Maximum allowable value

-> Double

step: Increment added or subtracted by spinning the widget

-> m SpinButton

Returns: The new spin button as a Widget

This is a convenience constructor that allows creation of a numeric SpinButton 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 spinButtonSetDigits to correct it.

setAdjustment

spinButtonSetAdjustment Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a, IsAdjustment b) 
=> a

spinButton: a SpinButton

-> b

adjustment: a Adjustment to replace the existing adjustment

-> m () 

Replaces the Adjustment associated with spinButton.

setDigits

spinButtonSetDigits Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> Word32

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

-> m () 

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

setIncrements

spinButtonSetIncrements Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> Double

step: increment applied for a button 1 press.

-> Double

page: increment applied for a button 2 press.

-> m () 

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

setNumeric

spinButtonSetNumeric Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> Bool

numeric: flag indicating if only numeric entry is allowed

-> m () 

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

setRange

spinButtonSetRange Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> Double

min: minimum allowable value

-> Double

max: maximum allowable value

-> m () 

Sets the minimum and maximum allowable values for spinButton.

If the current value is outside this range, it will be adjusted to fit within the range, otherwise it will remain unchanged.

setSnapToTicks

spinButtonSetSnapToTicks Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> Bool

snapToTicks: a flag indicating if invalid values should be corrected

-> m () 

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.

setUpdatePolicy

spinButtonSetUpdatePolicy Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> SpinButtonUpdatePolicy

policy: a SpinButtonUpdatePolicy value

-> m () 

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.

setValue

spinButtonSetValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> Double

value: the new value

-> m () 

Sets the value of spinButton.

setWrap

data SpinButtonSetWrapMethodInfo Source #

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsSpinButton a) => MethodInfo * SpinButtonSetWrapMethodInfo a signature Source # 

spinButtonSetWrap Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> Bool

wrap: a flag indicating if wrapping behavior is performed

-> m () 

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.

spin

data SpinButtonSpinMethodInfo Source #

Instances

((~) * signature (SpinType -> Double -> m ()), MonadIO m, IsSpinButton a) => MethodInfo * SpinButtonSpinMethodInfo a signature Source # 

spinButtonSpin Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> SpinType

direction: a SpinType indicating the direction to spin

-> Double

increment: step increment to apply in the specified direction

-> m () 

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

update

data SpinButtonUpdateMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m, IsSpinButton a) => MethodInfo * SpinButtonUpdateMethodInfo a signature Source # 

spinButtonUpdate Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinButton a) 
=> a

spinButton: a SpinButton

-> m () 

Manually force an update of the spin button.

Properties

adjustment

data SpinButtonAdjustmentPropertyInfo Source #

Instances

AttrInfo SpinButtonAdjustmentPropertyInfo Source # 
type AttrOrigin SpinButtonAdjustmentPropertyInfo Source # 
type AttrLabel SpinButtonAdjustmentPropertyInfo Source # 
type AttrGetType SpinButtonAdjustmentPropertyInfo Source # 
type AttrBaseTypeConstraint SpinButtonAdjustmentPropertyInfo Source # 
type AttrSetTypeConstraint SpinButtonAdjustmentPropertyInfo Source # 
type AttrAllowedOps SpinButtonAdjustmentPropertyInfo Source # 

climbRate

data SpinButtonClimbRatePropertyInfo Source #

Instances

AttrInfo SpinButtonClimbRatePropertyInfo Source # 
type AttrOrigin SpinButtonClimbRatePropertyInfo Source # 
type AttrLabel SpinButtonClimbRatePropertyInfo Source # 
type AttrGetType SpinButtonClimbRatePropertyInfo Source # 
type AttrBaseTypeConstraint SpinButtonClimbRatePropertyInfo Source # 
type AttrSetTypeConstraint SpinButtonClimbRatePropertyInfo Source # 
type AttrAllowedOps SpinButtonClimbRatePropertyInfo Source # 

digits

data SpinButtonDigitsPropertyInfo Source #

Instances

AttrInfo SpinButtonDigitsPropertyInfo Source # 
type AttrOrigin SpinButtonDigitsPropertyInfo Source # 
type AttrLabel SpinButtonDigitsPropertyInfo Source # 
type AttrGetType SpinButtonDigitsPropertyInfo Source # 
type AttrBaseTypeConstraint SpinButtonDigitsPropertyInfo Source # 
type AttrSetTypeConstraint SpinButtonDigitsPropertyInfo Source # 
type AttrAllowedOps SpinButtonDigitsPropertyInfo Source # 

numeric

data SpinButtonNumericPropertyInfo Source #

Instances

AttrInfo SpinButtonNumericPropertyInfo Source # 
type AttrOrigin SpinButtonNumericPropertyInfo Source # 
type AttrLabel SpinButtonNumericPropertyInfo Source # 
type AttrGetType SpinButtonNumericPropertyInfo Source # 
type AttrBaseTypeConstraint SpinButtonNumericPropertyInfo Source # 
type AttrSetTypeConstraint SpinButtonNumericPropertyInfo Source # 
type AttrAllowedOps SpinButtonNumericPropertyInfo Source # 

snapToTicks

data SpinButtonSnapToTicksPropertyInfo Source #

Instances

AttrInfo SpinButtonSnapToTicksPropertyInfo Source # 
type AttrOrigin SpinButtonSnapToTicksPropertyInfo Source # 
type AttrLabel SpinButtonSnapToTicksPropertyInfo Source # 
type AttrGetType SpinButtonSnapToTicksPropertyInfo Source # 
type AttrBaseTypeConstraint SpinButtonSnapToTicksPropertyInfo Source # 
type AttrSetTypeConstraint SpinButtonSnapToTicksPropertyInfo Source # 
type AttrAllowedOps SpinButtonSnapToTicksPropertyInfo Source # 

updatePolicy

data SpinButtonUpdatePolicyPropertyInfo Source #

Instances

AttrInfo SpinButtonUpdatePolicyPropertyInfo Source # 
type AttrOrigin SpinButtonUpdatePolicyPropertyInfo Source # 
type AttrLabel SpinButtonUpdatePolicyPropertyInfo Source # 
type AttrGetType SpinButtonUpdatePolicyPropertyInfo Source # 
type AttrBaseTypeConstraint SpinButtonUpdatePolicyPropertyInfo Source # 
type AttrSetTypeConstraint SpinButtonUpdatePolicyPropertyInfo Source # 
type AttrAllowedOps SpinButtonUpdatePolicyPropertyInfo Source # 

value

data SpinButtonValuePropertyInfo Source #

Instances

AttrInfo SpinButtonValuePropertyInfo Source # 
type AttrOrigin SpinButtonValuePropertyInfo Source # 
type AttrLabel SpinButtonValuePropertyInfo Source # 
type AttrGetType SpinButtonValuePropertyInfo Source # 
type AttrBaseTypeConstraint SpinButtonValuePropertyInfo Source # 
type AttrSetTypeConstraint SpinButtonValuePropertyInfo Source # 
type AttrAllowedOps SpinButtonValuePropertyInfo Source # 

wrap

data SpinButtonWrapPropertyInfo Source #

Instances

AttrInfo SpinButtonWrapPropertyInfo Source # 
type AttrOrigin SpinButtonWrapPropertyInfo Source # 
type AttrLabel SpinButtonWrapPropertyInfo Source # 
type AttrGetType SpinButtonWrapPropertyInfo Source # 
type AttrBaseTypeConstraint SpinButtonWrapPropertyInfo Source # 
type AttrSetTypeConstraint SpinButtonWrapPropertyInfo Source # 
type AttrAllowedOps SpinButtonWrapPropertyInfo Source # 

Signals

changeValue

input

output

valueChanged

wrapped