GI.Gtk.Objects.Adjustment

The Adjustment object represents a value which has an associated lower and upper bound, together with step and page increments, and a page size. It is used within several GTK+ widgets, including SpinButton, Viewport, and Range (which is a base class for Scrollbar and Scale).

The Adjustment object does not update the value itself. Instead it is left up to the owner of the Adjustment to control the value.

Exported types

newtype Adjustment

Memory-managed wrapper type.

Constructors

Adjustment (ManagedPtr Adjustment)

Instances

GObject Adjustment

Methods

gobjectType :: Adjustment -> IO GType

IsObject Adjustment

IsAdjustment Adjustment

class GObject o => IsAdjustment o

Type class for types which can be safely cast to Adjustment, for instance with toAdjustment.

Instances

(GObject a, UnknownAncestorError Constraint Adjustment a) => IsAdjustment a

IsAdjustment Adjustment

toAdjustment :: (MonadIO m, IsAdjustment o) => o -> m Adjustment

Cast to Adjustment, for types for which this is known to be safe. For general casts, use castTo.

noAdjustment :: Maybe Adjustment

A convenience alias for Nothing :: Maybe Adjustment.

Methods

changed

adjustmentChanged

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m ()

Deprecated: (Since version 3.18)GTK+ emits Adjustment::changed itself whenever any of the properties (other than value) change

Emits a Adjustment::changed signal from the Adjustment. This is typically called by the owner of the Adjustment after it has changed any of the Adjustment properties other than the value.

clampPage

adjustmentClampPage

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> Double

lower: the lower value

-> Double

upper: the upper value

-> m ()

Updates the Adjustment:value property to ensure that the range between lower and upper is in the current page (i.e. between Adjustment:value and Adjustment:value + Adjustment:page-size). If the range is larger than the page size, then only the start of it will be in the current page.

A Adjustment::value-changed signal will be emitted if the value is changed.

configure

adjustmentConfigure

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> Double

value: the new value

-> Double

lower: the new minimum value

-> Double

upper: the new maximum value

-> Double

stepIncrement: the new step increment

-> Double

pageIncrement: the new page increment

-> Double

pageSize: the new page size

-> m ()

Sets all properties of the adjustment at once.

Use this function to avoid multiple emissions of the Adjustment::changed signal. See adjustmentSetLower for an alternative way of compressing multiple emissions of Adjustment::changed into one.

Since: 2.14

getLower

adjustmentGetLower

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m Double

Returns: The current minimum value of the adjustment

Retrieves the minimum value of the adjustment.

Since: 2.14

getMinimumIncrement

adjustmentGetMinimumIncrement

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m Double

Returns: the minimum increment of adjustment

Gets the smaller of step increment and page increment.

Since: 3.2

getPageIncrement

adjustmentGetPageIncrement

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m Double

Returns: The current page increment of the adjustment

Retrieves the page increment of the adjustment.

Since: 2.14

getPageSize

adjustmentGetPageSize

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m Double

Returns: The current page size of the adjustment

Retrieves the page size of the adjustment.

Since: 2.14

getStepIncrement

adjustmentGetStepIncrement

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m Double

Returns: The current step increment of the adjustment.

Retrieves the step increment of the adjustment.

Since: 2.14

getUpper

adjustmentGetUpper

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m Double

Returns: The current maximum value of the adjustment

Retrieves the maximum value of the adjustment.

Since: 2.14

getValue

adjustmentGetValue

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m Double

Returns: The current value of the adjustment

Gets the current value of the adjustment. See adjustmentSetValue.

new

adjustmentNew

Arguments

:: (HasCallStack, MonadIO m)

=> Double

value: the initial value

-> Double

lower: the minimum value

-> Double

upper: the maximum value

-> Double

stepIncrement: the step increment

-> Double

pageIncrement: the page increment

-> Double

pageSize: the page size

-> m Adjustment

Returns: a new Adjustment

Creates a new Adjustment.

setLower

adjustmentSetLower

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> Double

lower: the new minimum value

-> m ()

Sets the minimum value of the adjustment.

When setting multiple adjustment properties via their individual setters, multiple Adjustment::changed signals will be emitted. However, since the emission of the Adjustment::changed signal is tied to the emission of the Object::notify signals of the changed properties, it’s possible to compress the Adjustment::changed signals into one by calling objectFreezeNotify and objectThawNotify around the calls to the individual setters.

Alternatively, using a single g_object_set() for all the properties to change, or using adjustmentConfigure has the same effect of compressing Adjustment::changed emissions.

Since: 2.14

setPageIncrement

adjustmentSetPageIncrement

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> Double

pageIncrement: the new page increment

-> m ()

Sets the page increment of the adjustment.

See adjustmentSetLower about how to compress multiple emissions of the Adjustment::changed signal when setting multiple adjustment properties.

Since: 2.14

setPageSize

adjustmentSetPageSize

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> Double

pageSize: the new page size

-> m ()

Sets the page size of the adjustment.

See adjustmentSetLower about how to compress multiple emissions of the GtkAdjustment::changed signal when setting multiple adjustment properties.

Since: 2.14

setStepIncrement

adjustmentSetStepIncrement

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> Double

stepIncrement: the new step increment

-> m ()

Sets the step increment of the adjustment.

See adjustmentSetLower about how to compress multiple emissions of the Adjustment::changed signal when setting multiple adjustment properties.

Since: 2.14

setUpper

adjustmentSetUpper

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> Double

upper: the new maximum value

-> m ()

Sets the maximum value of the adjustment.

Note that values will be restricted by upper - page-size if the page-size property is nonzero.

See adjustmentSetLower about how to compress multiple emissions of the Adjustment::changed signal when setting multiple adjustment properties.

Since: 2.14

setValue

adjustmentSetValue

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> Double

value: the new value

-> m ()

Sets the Adjustment value. The value is clamped to lie between Adjustment:lower and Adjustment:upper.

Note that for adjustments which are used in a Scrollbar, the effective range of allowed values goes from Adjustment:lower to Adjustment:upper - Adjustment:page-size.

valueChanged

adjustmentValueChanged

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> a

adjustment: a Adjustment

-> m ()

Deprecated: (Since version 3.18)GTK+ emits Adjustment::value-changed itself whenever the value changes

Emits a Adjustment::value-changed signal from the Adjustment. This is typically called by the owner of the Adjustment after it has changed the Adjustment:value property.

Properties

lower

The minimum value of the adjustment.

Since: 2.4

constructAdjustmentLower :: IsAdjustment o => Double -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “lower” property. This is rarely needed directly, but it is used by new.

getAdjustmentLower :: (MonadIO m, IsAdjustment o) => o -> m Double

Get the value of the “lower” property. When overloading is enabled, this is equivalent to

get adjustment #lower

setAdjustmentLower :: (MonadIO m, IsAdjustment o) => o -> Double -> m ()

Set the value of the “lower” property. When overloading is enabled, this is equivalent to

set adjustment [ #lower := value ]

pageIncrement

The page increment of the adjustment.

Since: 2.4

constructAdjustmentPageIncrement :: IsAdjustment o => Double -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “page-increment” property. This is rarely needed directly, but it is used by new.

getAdjustmentPageIncrement :: (MonadIO m, IsAdjustment o) => o -> m Double

Get the value of the “page-increment” property. When overloading is enabled, this is equivalent to

get adjustment #pageIncrement

setAdjustmentPageIncrement :: (MonadIO m, IsAdjustment o) => o -> Double -> m ()

Set the value of the “page-increment” property. When overloading is enabled, this is equivalent to

set adjustment [ #pageIncrement := value ]

pageSize

The page size of the adjustment. Note that the page-size is irrelevant and should be set to zero if the adjustment is used for a simple scalar value, e.g. in a SpinButton.

Since: 2.4

constructAdjustmentPageSize :: IsAdjustment o => Double -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “page-size” property. This is rarely needed directly, but it is used by new.

getAdjustmentPageSize :: (MonadIO m, IsAdjustment o) => o -> m Double

Get the value of the “page-size” property. When overloading is enabled, this is equivalent to

get adjustment #pageSize

setAdjustmentPageSize :: (MonadIO m, IsAdjustment o) => o -> Double -> m ()

Set the value of the “page-size” property. When overloading is enabled, this is equivalent to

set adjustment [ #pageSize := value ]

stepIncrement

The step increment of the adjustment.

Since: 2.4

constructAdjustmentStepIncrement :: IsAdjustment o => Double -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “step-increment” property. This is rarely needed directly, but it is used by new.

getAdjustmentStepIncrement :: (MonadIO m, IsAdjustment o) => o -> m Double

Get the value of the “step-increment” property. When overloading is enabled, this is equivalent to

get adjustment #stepIncrement

setAdjustmentStepIncrement :: (MonadIO m, IsAdjustment o) => o -> Double -> m ()

Set the value of the “step-increment” property. When overloading is enabled, this is equivalent to

set adjustment [ #stepIncrement := value ]

upper

The maximum value of the adjustment. Note that values will be restricted by upper - page-size if the page-size property is nonzero.

Since: 2.4

constructAdjustmentUpper :: IsAdjustment o => Double -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “upper” property. This is rarely needed directly, but it is used by new.

getAdjustmentUpper :: (MonadIO m, IsAdjustment o) => o -> m Double

Get the value of the “upper” property. When overloading is enabled, this is equivalent to

get adjustment #upper

setAdjustmentUpper :: (MonadIO m, IsAdjustment o) => o -> Double -> m ()

Set the value of the “upper” property. When overloading is enabled, this is equivalent to

set adjustment [ #upper := value ]

value

The value of the adjustment.

Since: 2.4

constructAdjustmentValue :: IsAdjustment o => Double -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “value” property. This is rarely needed directly, but it is used by new.

getAdjustmentValue :: (MonadIO m, IsAdjustment o) => o -> m Double

Get the value of the “value” property. When overloading is enabled, this is equivalent to

get adjustment #value

setAdjustmentValue :: (MonadIO m, IsAdjustment o) => o -> Double -> m ()

Set the value of the “value” property. When overloading is enabled, this is equivalent to

set adjustment [ #value := value ]

Signals

changed

type AdjustmentChangedCallback = IO ()

Emitted when one or more of the Adjustment properties have been changed, other than the Adjustment:value property.

type C_AdjustmentChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

afterAdjustmentChanged :: (IsAdjustment a, MonadIO m) => a -> AdjustmentChangedCallback -> m SignalHandlerId

Connect a signal handler for the “changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after adjustment #changed callback

genClosure_AdjustmentChanged :: AdjustmentChangedCallback -> IO Closure

Wrap the callback into a Closure.

mk_AdjustmentChangedCallback :: C_AdjustmentChangedCallback -> IO (FunPtr C_AdjustmentChangedCallback)

Generate a function pointer callable from C code, from a C_AdjustmentChangedCallback.

noAdjustmentChangedCallback :: Maybe AdjustmentChangedCallback

A convenience synonym for Nothing :: Maybe AdjustmentChangedCallback.

onAdjustmentChanged :: (IsAdjustment a, MonadIO m) => a -> AdjustmentChangedCallback -> m SignalHandlerId

Connect a signal handler for the “changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on adjustment #changed callback

wrap_AdjustmentChangedCallback :: AdjustmentChangedCallback -> C_AdjustmentChangedCallback

Wrap a AdjustmentChangedCallback into a C_AdjustmentChangedCallback.

valueChanged

type AdjustmentValueChangedCallback = IO ()

Emitted when the Adjustment:value property has been changed.

type C_AdjustmentValueChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

afterAdjustmentValueChanged :: (IsAdjustment a, MonadIO m) => a -> AdjustmentValueChangedCallback -> m SignalHandlerId

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 adjustment #valueChanged callback

genClosure_AdjustmentValueChanged :: AdjustmentValueChangedCallback -> IO Closure

Wrap the callback into a Closure.

mk_AdjustmentValueChangedCallback :: C_AdjustmentValueChangedCallback -> IO (FunPtr C_AdjustmentValueChangedCallback)

Generate a function pointer callable from C code, from a C_AdjustmentValueChangedCallback.

noAdjustmentValueChangedCallback :: Maybe AdjustmentValueChangedCallback

A convenience synonym for Nothing :: Maybe AdjustmentValueChangedCallback.

onAdjustmentValueChanged :: (IsAdjustment a, MonadIO m) => a -> AdjustmentValueChangedCallback -> m SignalHandlerId

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 adjustment #valueChanged callback

wrap_AdjustmentValueChangedCallback :: AdjustmentValueChangedCallback -> C_AdjustmentValueChangedCallback

Wrap a AdjustmentValueChangedCallback into a C_AdjustmentValueChangedCallback.