Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
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 ├── undershoot.left ├── undershoot.right ├── entry │ ╰── ... ├── button.down ╰── button.up
plain code
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
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
- newtype SpinButton = SpinButton (ManagedPtr SpinButton)
- class GObject o => IsSpinButton o
- toSpinButton :: (MonadIO m, IsSpinButton o) => o -> m SpinButton
- noSpinButton :: Maybe SpinButton
- spinButtonConfigure :: (HasCallStack, MonadIO m, IsSpinButton a, IsAdjustment b) => a -> Maybe b -> Double -> Word32 -> m ()
- spinButtonGetAdjustment :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m Adjustment
- spinButtonGetDigits :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m Word32
- spinButtonGetIncrements :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m (Double, Double)
- spinButtonGetNumeric :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m Bool
- spinButtonGetRange :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m (Double, Double)
- spinButtonGetSnapToTicks :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m Bool
- spinButtonGetUpdatePolicy :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m SpinButtonUpdatePolicy
- spinButtonGetValue :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m Double
- spinButtonGetValueAsInt :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m Int32
- spinButtonGetWrap :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m Bool
- spinButtonNew :: (HasCallStack, MonadIO m, IsAdjustment a) => Maybe a -> Double -> Word32 -> m SpinButton
- spinButtonNewWithRange :: (HasCallStack, MonadIO m) => Double -> Double -> Double -> m SpinButton
- spinButtonSetAdjustment :: (HasCallStack, MonadIO m, IsSpinButton a, IsAdjustment b) => a -> b -> m ()
- spinButtonSetDigits :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> Word32 -> m ()
- spinButtonSetIncrements :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> Double -> Double -> m ()
- spinButtonSetNumeric :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> Bool -> m ()
- spinButtonSetRange :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> Double -> Double -> m ()
- spinButtonSetSnapToTicks :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> Bool -> m ()
- spinButtonSetUpdatePolicy :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> SpinButtonUpdatePolicy -> m ()
- spinButtonSetValue :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> Double -> m ()
- spinButtonSetWrap :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> Bool -> m ()
- spinButtonSpin :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> SpinType -> Double -> m ()
- spinButtonUpdate :: (HasCallStack, MonadIO m, IsSpinButton a) => a -> m ()
- constructSpinButtonAdjustment :: (IsSpinButton o, IsAdjustment a) => a -> IO (GValueConstruct o)
- getSpinButtonAdjustment :: (MonadIO m, IsSpinButton o) => o -> m Adjustment
- setSpinButtonAdjustment :: (MonadIO m, IsSpinButton o, IsAdjustment a) => o -> a -> m ()
- constructSpinButtonClimbRate :: IsSpinButton o => Double -> IO (GValueConstruct o)
- getSpinButtonClimbRate :: (MonadIO m, IsSpinButton o) => o -> m Double
- setSpinButtonClimbRate :: (MonadIO m, IsSpinButton o) => o -> Double -> m ()
- constructSpinButtonDigits :: IsSpinButton o => Word32 -> IO (GValueConstruct o)
- getSpinButtonDigits :: (MonadIO m, IsSpinButton o) => o -> m Word32
- setSpinButtonDigits :: (MonadIO m, IsSpinButton o) => o -> Word32 -> m ()
- constructSpinButtonNumeric :: IsSpinButton o => Bool -> IO (GValueConstruct o)
- getSpinButtonNumeric :: (MonadIO m, IsSpinButton o) => o -> m Bool
- setSpinButtonNumeric :: (MonadIO m, IsSpinButton o) => o -> Bool -> m ()
- constructSpinButtonSnapToTicks :: IsSpinButton o => Bool -> IO (GValueConstruct o)
- getSpinButtonSnapToTicks :: (MonadIO m, IsSpinButton o) => o -> m Bool
- setSpinButtonSnapToTicks :: (MonadIO m, IsSpinButton o) => o -> Bool -> m ()
- constructSpinButtonUpdatePolicy :: IsSpinButton o => SpinButtonUpdatePolicy -> IO (GValueConstruct o)
- getSpinButtonUpdatePolicy :: (MonadIO m, IsSpinButton o) => o -> m SpinButtonUpdatePolicy
- setSpinButtonUpdatePolicy :: (MonadIO m, IsSpinButton o) => o -> SpinButtonUpdatePolicy -> m ()
- constructSpinButtonValue :: IsSpinButton o => Double -> IO (GValueConstruct o)
- getSpinButtonValue :: (MonadIO m, IsSpinButton o) => o -> m Double
- setSpinButtonValue :: (MonadIO m, IsSpinButton o) => o -> Double -> m ()
- constructSpinButtonWrap :: IsSpinButton o => Bool -> IO (GValueConstruct o)
- getSpinButtonWrap :: (MonadIO m, IsSpinButton o) => o -> m Bool
- setSpinButtonWrap :: (MonadIO m, IsSpinButton o) => o -> Bool -> m ()
- type C_SpinButtonChangeValueCallback = Ptr () -> CUInt -> Ptr () -> IO ()
- type SpinButtonChangeValueCallback = ScrollType -> IO ()
- afterSpinButtonChangeValue :: (IsSpinButton a, MonadIO m) => a -> SpinButtonChangeValueCallback -> m SignalHandlerId
- genClosure_SpinButtonChangeValue :: SpinButtonChangeValueCallback -> IO Closure
- mk_SpinButtonChangeValueCallback :: C_SpinButtonChangeValueCallback -> IO (FunPtr C_SpinButtonChangeValueCallback)
- noSpinButtonChangeValueCallback :: Maybe SpinButtonChangeValueCallback
- onSpinButtonChangeValue :: (IsSpinButton a, MonadIO m) => a -> SpinButtonChangeValueCallback -> m SignalHandlerId
- wrap_SpinButtonChangeValueCallback :: SpinButtonChangeValueCallback -> C_SpinButtonChangeValueCallback
- type C_SpinButtonInputCallback = Ptr () -> Ptr CDouble -> Ptr () -> IO Int32
- type SpinButtonInputCallback = IO (Int32, Double)
- afterSpinButtonInput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonInputCallback -> m SignalHandlerId
- genClosure_SpinButtonInput :: SpinButtonInputCallback -> IO Closure
- mk_SpinButtonInputCallback :: C_SpinButtonInputCallback -> IO (FunPtr C_SpinButtonInputCallback)
- noSpinButtonInputCallback :: Maybe SpinButtonInputCallback
- onSpinButtonInput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonInputCallback -> m SignalHandlerId
- wrap_SpinButtonInputCallback :: SpinButtonInputCallback -> C_SpinButtonInputCallback
- type C_SpinButtonOutputCallback = Ptr () -> Ptr () -> IO CInt
- type SpinButtonOutputCallback = IO Bool
- afterSpinButtonOutput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonOutputCallback -> m SignalHandlerId
- genClosure_SpinButtonOutput :: SpinButtonOutputCallback -> IO Closure
- mk_SpinButtonOutputCallback :: C_SpinButtonOutputCallback -> IO (FunPtr C_SpinButtonOutputCallback)
- noSpinButtonOutputCallback :: Maybe SpinButtonOutputCallback
- onSpinButtonOutput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonOutputCallback -> m SignalHandlerId
- wrap_SpinButtonOutputCallback :: SpinButtonOutputCallback -> C_SpinButtonOutputCallback
- type C_SpinButtonValueChangedCallback = Ptr () -> Ptr () -> IO ()
- type SpinButtonValueChangedCallback = IO ()
- afterSpinButtonValueChanged :: (IsSpinButton a, MonadIO m) => a -> SpinButtonValueChangedCallback -> m SignalHandlerId
- genClosure_SpinButtonValueChanged :: SpinButtonValueChangedCallback -> IO Closure
- mk_SpinButtonValueChangedCallback :: C_SpinButtonValueChangedCallback -> IO (FunPtr C_SpinButtonValueChangedCallback)
- noSpinButtonValueChangedCallback :: Maybe SpinButtonValueChangedCallback
- onSpinButtonValueChanged :: (IsSpinButton a, MonadIO m) => a -> SpinButtonValueChangedCallback -> m SignalHandlerId
- wrap_SpinButtonValueChangedCallback :: SpinButtonValueChangedCallback -> C_SpinButtonValueChangedCallback
- type C_SpinButtonWrappedCallback = Ptr () -> Ptr () -> IO ()
- type SpinButtonWrappedCallback = IO ()
- afterSpinButtonWrapped :: (IsSpinButton a, MonadIO m) => a -> SpinButtonWrappedCallback -> m SignalHandlerId
- genClosure_SpinButtonWrapped :: SpinButtonWrappedCallback -> IO Closure
- mk_SpinButtonWrappedCallback :: C_SpinButtonWrappedCallback -> IO (FunPtr C_SpinButtonWrappedCallback)
- noSpinButtonWrappedCallback :: Maybe SpinButtonWrappedCallback
- onSpinButtonWrapped :: (IsSpinButton a, MonadIO m) => a -> SpinButtonWrappedCallback -> m SignalHandlerId
- wrap_SpinButtonWrappedCallback :: SpinButtonWrappedCallback -> C_SpinButtonWrappedCallback
Exported types
newtype SpinButton Source #
Memory-managed wrapper type.
Instances
GObject SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton gobjectType :: SpinButton -> IO GType # | |
IsImplementorIface SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsObject SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsBuildable SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsCellEditable SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsEditable SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsOrientable SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsEntry SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsSpinButton SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsWidget SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton |
class GObject o => IsSpinButton o Source #
Type class for types which can be safely cast to SpinButton
, for instance with toSpinButton
.
Instances
(GObject a, (UnknownAncestorError SpinButton a :: Constraint)) => IsSpinButton a Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
IsSpinButton SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton |
toSpinButton :: (MonadIO m, IsSpinButton o) => o -> m SpinButton Source #
Cast to SpinButton
, for types for which this is known to be safe. For general casts, use castTo
.
noSpinButton :: Maybe SpinButton Source #
A convenience alias for Nothing
:: Maybe
SpinButton
.
Methods
configure
:: (HasCallStack, MonadIO m, IsSpinButton a, IsAdjustment b) | |
=> a |
|
-> Maybe b |
|
-> Double |
|
-> Word32 |
|
-> m () |
Changes the properties of an existing spin button. The adjustment, climb rate, and number of decimal places are updated accordingly.
getAdjustment
spinButtonGetAdjustment Source #
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m Adjustment | Returns: the |
Get the adjustment associated with a SpinButton
getDigits
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m Word32 | Returns: the current precision |
Fetches the precision of spinButton
. See spinButtonSetDigits
.
getIncrements
spinButtonGetIncrements Source #
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m (Double, Double) |
Gets the current step and page the increments used by spinButton
. See
spinButtonSetIncrements
.
getNumeric
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether non-numeric text can be typed into the spin button.
See spinButtonSetNumeric
.
getRange
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m (Double, Double) |
Gets the range allowed for spinButton
.
See spinButtonSetRange
.
getSnapToTicks
spinButtonGetSnapToTicks Source #
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the values are corrected to the nearest step.
See spinButtonSetSnapToTicks
.
getUpdatePolicy
spinButtonGetUpdatePolicy Source #
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m SpinButtonUpdatePolicy | Returns: the current update policy |
Gets the update behavior of a spin button.
See spinButtonSetUpdatePolicy
.
getValue
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m Double | Returns: the value of |
Get the value in the spinButton
.
getValueAsInt
spinButtonGetValueAsInt Source #
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m Int32 | Returns: the value of |
Get the value spinButton
represented as an integer.
getWrap
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m Bool | Returns: |
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
:: (HasCallStack, MonadIO m, IsAdjustment a) | |
=> Maybe a |
|
-> Double |
|
-> Word32 |
|
-> m SpinButton | Returns: The new spin button as a |
Creates a new SpinButton
.
newWithRange
spinButtonNewWithRange Source #
:: (HasCallStack, MonadIO m) | |
=> Double |
|
-> Double |
|
-> Double |
|
-> m SpinButton | Returns: The new spin button as a |
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 #
:: (HasCallStack, MonadIO m, IsSpinButton a, IsAdjustment b) | |
=> a |
|
-> b |
|
-> m () |
Replaces the Adjustment
associated with spinButton
.
setDigits
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> Word32 |
|
-> m () |
Set the precision to be displayed by spinButton
. Up to 20 digit precision
is allowed.
setIncrements
spinButtonSetIncrements Source #
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> Double |
|
-> Double |
|
-> 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
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets the flag that determines if non-numeric text can be typed into the spin button.
setRange
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> Double |
|
-> Double |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> Bool |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> SpinButtonUpdatePolicy |
|
-> 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
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> Double |
|
-> m () |
Sets the value of spinButton
.
setWrap
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> Bool |
|
-> 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
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> SpinType |
|
-> Double |
|
-> m () |
Increment or decrement a spin button’s value in a specified direction by a specified amount.
update
:: (HasCallStack, MonadIO m, IsSpinButton a) | |
=> a |
|
-> m () |
Manually force an update of the spin button.
Properties
adjustment
No description available in the introspection data.
constructSpinButtonAdjustment :: (IsSpinButton o, IsAdjustment a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “adjustment
” property. This is rarely needed directly, but it is used by new
.
getSpinButtonAdjustment :: (MonadIO m, IsSpinButton o) => o -> m Adjustment Source #
Get the value of the “adjustment
” property.
When overloading is enabled, this is equivalent to
get
spinButton #adjustment
setSpinButtonAdjustment :: (MonadIO m, IsSpinButton o, IsAdjustment a) => o -> a -> m () Source #
Set the value of the “adjustment
” property.
When overloading is enabled, this is equivalent to
set
spinButton [ #adjustment:=
value ]
climbRate
No description available in the introspection data.
constructSpinButtonClimbRate :: IsSpinButton o => Double -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “climb-rate
” property. This is rarely needed directly, but it is used by new
.
getSpinButtonClimbRate :: (MonadIO m, IsSpinButton o) => o -> m Double Source #
Get the value of the “climb-rate
” property.
When overloading is enabled, this is equivalent to
get
spinButton #climbRate
setSpinButtonClimbRate :: (MonadIO m, IsSpinButton o) => o -> Double -> m () Source #
Set the value of the “climb-rate
” property.
When overloading is enabled, this is equivalent to
set
spinButton [ #climbRate:=
value ]
digits
No description available in the introspection data.
constructSpinButtonDigits :: IsSpinButton o => Word32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “digits
” property. This is rarely needed directly, but it is used by new
.
getSpinButtonDigits :: (MonadIO m, IsSpinButton o) => o -> m Word32 Source #
Get the value of the “digits
” property.
When overloading is enabled, this is equivalent to
get
spinButton #digits
setSpinButtonDigits :: (MonadIO m, IsSpinButton o) => o -> Word32 -> m () Source #
Set the value of the “digits
” property.
When overloading is enabled, this is equivalent to
set
spinButton [ #digits:=
value ]
numeric
No description available in the introspection data.
constructSpinButtonNumeric :: IsSpinButton o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “numeric
” property. This is rarely needed directly, but it is used by new
.
getSpinButtonNumeric :: (MonadIO m, IsSpinButton o) => o -> m Bool Source #
Get the value of the “numeric
” property.
When overloading is enabled, this is equivalent to
get
spinButton #numeric
setSpinButtonNumeric :: (MonadIO m, IsSpinButton o) => o -> Bool -> m () Source #
Set the value of the “numeric
” property.
When overloading is enabled, this is equivalent to
set
spinButton [ #numeric:=
value ]
snapToTicks
No description available in the introspection data.
constructSpinButtonSnapToTicks :: IsSpinButton o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “snap-to-ticks
” property. This is rarely needed directly, but it is used by new
.
getSpinButtonSnapToTicks :: (MonadIO m, IsSpinButton o) => o -> m Bool Source #
Get the value of the “snap-to-ticks
” property.
When overloading is enabled, this is equivalent to
get
spinButton #snapToTicks
setSpinButtonSnapToTicks :: (MonadIO m, IsSpinButton o) => o -> Bool -> m () Source #
Set the value of the “snap-to-ticks
” property.
When overloading is enabled, this is equivalent to
set
spinButton [ #snapToTicks:=
value ]
updatePolicy
No description available in the introspection data.
constructSpinButtonUpdatePolicy :: IsSpinButton o => SpinButtonUpdatePolicy -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “update-policy
” property. This is rarely needed directly, but it is used by new
.
getSpinButtonUpdatePolicy :: (MonadIO m, IsSpinButton o) => o -> m SpinButtonUpdatePolicy Source #
Get the value of the “update-policy
” property.
When overloading is enabled, this is equivalent to
get
spinButton #updatePolicy
setSpinButtonUpdatePolicy :: (MonadIO m, IsSpinButton o) => o -> SpinButtonUpdatePolicy -> m () Source #
Set the value of the “update-policy
” property.
When overloading is enabled, this is equivalent to
set
spinButton [ #updatePolicy:=
value ]
value
No description available in the introspection data.
constructSpinButtonValue :: IsSpinButton o => Double -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “value
” property. This is rarely needed directly, but it is used by new
.
getSpinButtonValue :: (MonadIO m, IsSpinButton o) => o -> m Double Source #
Get the value of the “value
” property.
When overloading is enabled, this is equivalent to
get
spinButton #value
setSpinButtonValue :: (MonadIO m, IsSpinButton o) => o -> Double -> m () Source #
Set the value of the “value
” property.
When overloading is enabled, this is equivalent to
set
spinButton [ #value:=
value ]
wrap
No description available in the introspection data.
constructSpinButtonWrap :: IsSpinButton o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “wrap
” property. This is rarely needed directly, but it is used by new
.
getSpinButtonWrap :: (MonadIO m, IsSpinButton o) => o -> m Bool Source #
Get the value of the “wrap
” property.
When overloading is enabled, this is equivalent to
get
spinButton #wrap
setSpinButtonWrap :: (MonadIO m, IsSpinButton o) => o -> Bool -> m () Source #
Set the value of the “wrap
” property.
When overloading is enabled, this is equivalent to
set
spinButton [ #wrap:=
value ]
Signals
changeValue
type C_SpinButtonChangeValueCallback = Ptr () -> CUInt -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type SpinButtonChangeValueCallback Source #
= ScrollType |
|
-> IO () |
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.
afterSpinButtonChangeValue :: (IsSpinButton a, MonadIO m) => a -> SpinButtonChangeValueCallback -> m SignalHandlerId Source #
Connect a signal handler for the “change-value
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
spinButton #changeValue callback
genClosure_SpinButtonChangeValue :: SpinButtonChangeValueCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_SpinButtonChangeValueCallback :: C_SpinButtonChangeValueCallback -> IO (FunPtr C_SpinButtonChangeValueCallback) Source #
Generate a function pointer callable from C code, from a C_SpinButtonChangeValueCallback
.
noSpinButtonChangeValueCallback :: Maybe SpinButtonChangeValueCallback Source #
A convenience synonym for
.Nothing
:: Maybe
SpinButtonChangeValueCallback
onSpinButtonChangeValue :: (IsSpinButton a, MonadIO m) => a -> SpinButtonChangeValueCallback -> m SignalHandlerId Source #
Connect a signal handler for the “change-value
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
spinButton #changeValue callback
wrap_SpinButtonChangeValueCallback :: SpinButtonChangeValueCallback -> C_SpinButtonChangeValueCallback Source #
Wrap a SpinButtonChangeValueCallback
into a C_SpinButtonChangeValueCallback
.
input
type C_SpinButtonInputCallback = Ptr () -> Ptr CDouble -> Ptr () -> IO Int32 Source #
Type for the callback on the (unwrapped) C side.
type SpinButtonInputCallback Source #
= IO (Int32, Double) | Returns: |
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 entryGetText
to retrieve the text of
the entry and set newValue
to the new value.
The default conversion uses strtod
.
afterSpinButtonInput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonInputCallback -> m SignalHandlerId Source #
Connect a signal handler for the “input
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
spinButton #input callback
genClosure_SpinButtonInput :: SpinButtonInputCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_SpinButtonInputCallback :: C_SpinButtonInputCallback -> IO (FunPtr C_SpinButtonInputCallback) Source #
Generate a function pointer callable from C code, from a C_SpinButtonInputCallback
.
noSpinButtonInputCallback :: Maybe SpinButtonInputCallback Source #
A convenience synonym for
.Nothing
:: Maybe
SpinButtonInputCallback
onSpinButtonInput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonInputCallback -> m SignalHandlerId Source #
Connect a signal handler for the “input
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
spinButton #input callback
wrap_SpinButtonInputCallback :: SpinButtonInputCallback -> C_SpinButtonInputCallback Source #
Wrap a SpinButtonInputCallback
into a C_SpinButtonInputCallback
.
output
type C_SpinButtonOutputCallback = Ptr () -> Ptr () -> IO CInt Source #
Type for the callback on the (unwrapped) C side.
type SpinButtonOutputCallback Source #
The ::output signal can be used to change to formatting of the value that is displayed in the spin buttons entry.
C code
// 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; }
afterSpinButtonOutput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonOutputCallback -> m SignalHandlerId Source #
Connect a signal handler for the “output
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
spinButton #output callback
genClosure_SpinButtonOutput :: SpinButtonOutputCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_SpinButtonOutputCallback :: C_SpinButtonOutputCallback -> IO (FunPtr C_SpinButtonOutputCallback) Source #
Generate a function pointer callable from C code, from a C_SpinButtonOutputCallback
.
noSpinButtonOutputCallback :: Maybe SpinButtonOutputCallback Source #
A convenience synonym for
.Nothing
:: Maybe
SpinButtonOutputCallback
onSpinButtonOutput :: (IsSpinButton a, MonadIO m) => a -> SpinButtonOutputCallback -> m SignalHandlerId Source #
Connect a signal handler for the “output
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
spinButton #output callback
wrap_SpinButtonOutputCallback :: SpinButtonOutputCallback -> C_SpinButtonOutputCallback Source #
Wrap a SpinButtonOutputCallback
into a C_SpinButtonOutputCallback
.
valueChanged
type C_SpinButtonValueChangedCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type SpinButtonValueChangedCallback = IO () Source #
The ::value-changed signal is emitted when the value represented by
spinbutton
changes. Also see the SpinButton
::output
signal.
afterSpinButtonValueChanged :: (IsSpinButton a, MonadIO m) => a -> SpinButtonValueChangedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “value-changed
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
spinButton #valueChanged callback
genClosure_SpinButtonValueChanged :: SpinButtonValueChangedCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_SpinButtonValueChangedCallback :: C_SpinButtonValueChangedCallback -> IO (FunPtr C_SpinButtonValueChangedCallback) Source #
Generate a function pointer callable from C code, from a C_SpinButtonValueChangedCallback
.
noSpinButtonValueChangedCallback :: Maybe SpinButtonValueChangedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
SpinButtonValueChangedCallback
onSpinButtonValueChanged :: (IsSpinButton a, MonadIO m) => a -> SpinButtonValueChangedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “value-changed
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
spinButton #valueChanged callback
wrap_SpinButtonValueChangedCallback :: SpinButtonValueChangedCallback -> C_SpinButtonValueChangedCallback Source #
Wrap a SpinButtonValueChangedCallback
into a C_SpinButtonValueChangedCallback
.
wrapped
type C_SpinButtonWrappedCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type SpinButtonWrappedCallback = IO () Source #
The ::wrapped signal is emitted right after the spinbutton wraps from its maximum to minimum value or vice-versa.
Since: 2.10
afterSpinButtonWrapped :: (IsSpinButton a, MonadIO m) => a -> SpinButtonWrappedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “wrapped
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
spinButton #wrapped callback
genClosure_SpinButtonWrapped :: SpinButtonWrappedCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_SpinButtonWrappedCallback :: C_SpinButtonWrappedCallback -> IO (FunPtr C_SpinButtonWrappedCallback) Source #
Generate a function pointer callable from C code, from a C_SpinButtonWrappedCallback
.
noSpinButtonWrappedCallback :: Maybe SpinButtonWrappedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
SpinButtonWrappedCallback
onSpinButtonWrapped :: (IsSpinButton a, MonadIO m) => a -> SpinButtonWrappedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “wrapped
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
spinButton #wrapped callback