GI.Gtk.Objects.Range

Range is the common base class for widgets which visualize an adjustment, e.g Scale or Scrollbar.

Apart from signals for monitoring the parameters of the adjustment, Range provides properties and methods for influencing the sensitivity of the “steppers”. It also provides properties and methods for setting a “fill level” on range widgets. See rangeSetFillLevel.

Exported types

newtype Range

Constructors

Range (ManagedPtr Range)

Instances

GObject Range

Methods

gobjectType :: Range -> IO GType

IsImplementorIface Range

IsObject Range

IsWidget Range

IsRange Range

IsOrientable Range

IsBuildable Range

class GObject o => IsRange o

Instances

(GObject a, UnknownAncestorError Constraint Range a) => IsRange a

IsRange Scrollbar

IsRange Scale

IsRange Range

IsRange HScale

IsRange HScrollbar

IsRange VScale

IsRange VScrollbar

toRange :: (MonadIO m, IsRange o) => o -> m Range

noRange :: Maybe Range

Methods

getAdjustment

rangeGetAdjustment

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m Adjustment

Returns: a Adjustment

Get the Adjustment which is the “model” object for Range. See rangeSetAdjustment for details. The return value does not have a reference added, so should not be unreferenced.

getFillLevel

rangeGetFillLevel

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: A Range

-> m Double

Returns: The current fill level

Gets the current position of the fill level indicator.

Since: 2.12

getFlippable

rangeGetFlippable

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m Bool

Returns: True if the range is flippable

Gets the value set by rangeSetFlippable.

Since: 2.18

getInverted

rangeGetInverted

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m Bool

Returns: True if the range is inverted

Gets the value set by rangeSetInverted.

getLowerStepperSensitivity

rangeGetLowerStepperSensitivity

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m SensitivityType

Returns: The lower stepper’s sensitivity policy.

Gets the sensitivity policy for the stepper that points to the 'lower' end of the GtkRange’s adjustment.

Since: 2.10

getMinSliderSize

rangeGetMinSliderSize

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m Int32

Returns: The minimum size of the range’s slider.

Deprecated: (Since version 3.20)Use the min-height/min-width CSS properties on the slider node.

This function is useful mainly for Range subclasses.

See rangeSetMinSliderSize.

Since: 2.20

getRangeRect

rangeGetRangeRect

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m Rectangle

This function returns the area that contains the range’s trough and its steppers, in widget->window coordinates.

This function is useful mainly for Range subclasses.

Since: 2.20

getRestrictToFillLevel

rangeGetRestrictToFillLevel

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: A Range

-> m Bool

Returns: True if range is restricted to the fill level.

Gets whether the range is restricted to the fill level.

Since: 2.12

getRoundDigits

rangeGetRoundDigits

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m Int32

Returns: the number of digits to round to

Gets the number of digits to round the value to when it changes. See Range::change-value.

Since: 2.24

getShowFillLevel

rangeGetShowFillLevel

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: A Range

-> m Bool

Returns: True if range shows the fill level.

Gets whether the range displays the fill level graphically.

Since: 2.12

getSliderRange

rangeGetSliderRange

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m (Int32, Int32)

This function returns sliders range along the long dimension, in widget->window coordinates.

This function is useful mainly for Range subclasses.

Since: 2.20

getSliderSizeFixed

rangeGetSliderSizeFixed

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m Bool

Returns: whether the range’s slider has a fixed size.

This function is useful mainly for Range subclasses.

See rangeSetSliderSizeFixed.

Since: 2.20

getUpperStepperSensitivity

rangeGetUpperStepperSensitivity

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m SensitivityType

Returns: The upper stepper’s sensitivity policy.

Gets the sensitivity policy for the stepper that points to the 'upper' end of the GtkRange’s adjustment.

Since: 2.10

getValue

rangeGetValue

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> m Double

Returns: current value of the range.

Gets the current value of the range.

setAdjustment

rangeSetAdjustment

Arguments

:: (HasCallStack, MonadIO m, IsRange a, IsAdjustment b)

=> a

range: a Range

-> b

adjustment: a Adjustment

-> m ()

Sets the adjustment to be used as the “model” object for this range widget. The adjustment indicates the current range value, the minimum and maximum range values, the step/page increments used for keybindings and scrolling, and the page size. The page size is normally 0 for Scale and nonzero for Scrollbar, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider.

setFillLevel

rangeSetFillLevel

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Double

fillLevel: the new position of the fill level indicator

-> m ()

Set the new position of the fill level indicator.

The “fill level” is probably best described by its most prominent use case, which is an indicator for the amount of pre-buffering in a streaming media player. In that use case, the value of the range would indicate the current play position, and the fill level would be the position up to which the file/stream has been downloaded.

This amount of prebuffering can be displayed on the range’s trough and is themeable separately from the trough. To enable fill level display, use rangeSetShowFillLevel. The range defaults to not showing the fill level.

Additionally, it’s possible to restrict the range’s slider position to values which are smaller than the fill level. This is controller by rangeSetRestrictToFillLevel and is by default enabled.

Since: 2.12

setFlippable

rangeSetFlippable

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Bool

flippable: True to make the range flippable

-> m ()

If a range is flippable, it will switch its direction if it is horizontal and its direction is TextDirectionRtl.

See widgetGetDirection.

Since: 2.18

setIncrements

rangeSetIncrements

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Double

step: step size

-> Double

page: page size

-> m ()

Sets the step and page sizes for the range. The step size is used when the user clicks the Scrollbar arrows or moves Scale via arrow keys. The page size is used for example when moving via Page Up or Page Down keys.

setInverted

rangeSetInverted

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Bool

setting: True to invert the range

-> m ()

Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right. Inverted ranges have higher values at the top or on the right rather than on the bottom or left.

setLowerStepperSensitivity

rangeSetLowerStepperSensitivity

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> SensitivityType

sensitivity: the lower stepper’s sensitivity policy.

-> m ()

Sets the sensitivity policy for the stepper that points to the 'lower' end of the GtkRange’s adjustment.

Since: 2.10

setMinSliderSize

rangeSetMinSliderSize

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Int32

minSize: The slider’s minimum size

-> m ()

Deprecated: (Since version 3.20)Use the min-height/min-width CSS properties on the slider node.

Sets the minimum size of the range’s slider.

This function is useful mainly for Range subclasses.

Since: 2.20

setRange

rangeSetRange

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Double

min: minimum range value

-> Double

max: maximum range value

-> m ()

Sets the allowable values in the Range, and clamps the range value to be between min and max. (If the range has a non-zero page size, it is clamped between min and max - page-size.)

setRestrictToFillLevel

rangeSetRestrictToFillLevel

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: A Range

-> Bool

restrictToFillLevel: Whether the fill level restricts slider movement.

-> m ()

Sets whether the slider is restricted to the fill level. See rangeSetFillLevel for a general description of the fill level concept.

Since: 2.12

setRoundDigits

rangeSetRoundDigits

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Int32

roundDigits: the precision in digits, or -1

-> m ()

Sets the number of digits to round the value to when it changes. See Range::change-value.

Since: 2.24

setShowFillLevel

rangeSetShowFillLevel

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: A Range

-> Bool

showFillLevel: Whether a fill level indicator graphics is shown.

-> m ()

Sets whether a graphical fill level is show on the trough. See rangeSetFillLevel for a general description of the fill level concept.

Since: 2.12

setSliderSizeFixed

rangeSetSliderSizeFixed

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Bool

sizeFixed: True to make the slider size constant

-> m ()

Sets whether the range’s slider has a fixed size, or a size that depends on its adjustment’s page size.

This function is useful mainly for Range subclasses.

Since: 2.20

setUpperStepperSensitivity

rangeSetUpperStepperSensitivity

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> SensitivityType

sensitivity: the upper stepper’s sensitivity policy.

-> m ()

Sets the sensitivity policy for the stepper that points to the 'upper' end of the GtkRange’s adjustment.

Since: 2.10

setValue

rangeSetValue

Arguments

:: (HasCallStack, MonadIO m, IsRange a)

=> a

range: a Range

-> Double

value: new value of the range

-> m ()

Sets the current value of the range; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The range emits the Range::value-changed signal if the value changes.

Properties

adjustment

constructRangeAdjustment :: (IsRange o, IsAdjustment a) => a -> IO (GValueConstruct o)

getRangeAdjustment :: (MonadIO m, IsRange o) => o -> m Adjustment

setRangeAdjustment :: (MonadIO m, IsRange o, IsAdjustment a) => o -> a -> m ()

fillLevel

constructRangeFillLevel :: IsRange o => Double -> IO (GValueConstruct o)

getRangeFillLevel :: (MonadIO m, IsRange o) => o -> m Double

setRangeFillLevel :: (MonadIO m, IsRange o) => o -> Double -> m ()

inverted

constructRangeInverted :: IsRange o => Bool -> IO (GValueConstruct o)

getRangeInverted :: (MonadIO m, IsRange o) => o -> m Bool

setRangeInverted :: (MonadIO m, IsRange o) => o -> Bool -> m ()

lowerStepperSensitivity

constructRangeLowerStepperSensitivity :: IsRange o => SensitivityType -> IO (GValueConstruct o)

getRangeLowerStepperSensitivity :: (MonadIO m, IsRange o) => o -> m SensitivityType

setRangeLowerStepperSensitivity :: (MonadIO m, IsRange o) => o -> SensitivityType -> m ()

restrictToFillLevel

constructRangeRestrictToFillLevel :: IsRange o => Bool -> IO (GValueConstruct o)

getRangeRestrictToFillLevel :: (MonadIO m, IsRange o) => o -> m Bool

setRangeRestrictToFillLevel :: (MonadIO m, IsRange o) => o -> Bool -> m ()

roundDigits

constructRangeRoundDigits :: IsRange o => Int32 -> IO (GValueConstruct o)

getRangeRoundDigits :: (MonadIO m, IsRange o) => o -> m Int32

setRangeRoundDigits :: (MonadIO m, IsRange o) => o -> Int32 -> m ()

showFillLevel

constructRangeShowFillLevel :: IsRange o => Bool -> IO (GValueConstruct o)

getRangeShowFillLevel :: (MonadIO m, IsRange o) => o -> m Bool

setRangeShowFillLevel :: (MonadIO m, IsRange o) => o -> Bool -> m ()

upperStepperSensitivity

constructRangeUpperStepperSensitivity :: IsRange o => SensitivityType -> IO (GValueConstruct o)

getRangeUpperStepperSensitivity :: (MonadIO m, IsRange o) => o -> m SensitivityType

setRangeUpperStepperSensitivity :: (MonadIO m, IsRange o) => o -> SensitivityType -> m ()

Signals

adjustBounds

type C_RangeAdjustBoundsCallback = Ptr () -> CDouble -> Ptr () -> IO ()

type RangeAdjustBoundsCallback = Double -> IO ()

afterRangeAdjustBounds :: (IsRange a, MonadIO m) => a -> RangeAdjustBoundsCallback -> m SignalHandlerId

genClosure_RangeAdjustBounds :: RangeAdjustBoundsCallback -> IO Closure

mk_RangeAdjustBoundsCallback :: C_RangeAdjustBoundsCallback -> IO (FunPtr C_RangeAdjustBoundsCallback)

noRangeAdjustBoundsCallback :: Maybe RangeAdjustBoundsCallback

onRangeAdjustBounds :: (IsRange a, MonadIO m) => a -> RangeAdjustBoundsCallback -> m SignalHandlerId

wrap_RangeAdjustBoundsCallback :: RangeAdjustBoundsCallback -> Ptr () -> CDouble -> Ptr () -> IO ()

changeValue

type C_RangeChangeValueCallback = Ptr () -> CUInt -> CDouble -> Ptr () -> IO CInt

type RangeChangeValueCallback = ScrollType -> Double -> IO Bool

afterRangeChangeValue :: (IsRange a, MonadIO m) => a -> RangeChangeValueCallback -> m SignalHandlerId

genClosure_RangeChangeValue :: RangeChangeValueCallback -> IO Closure

mk_RangeChangeValueCallback :: C_RangeChangeValueCallback -> IO (FunPtr C_RangeChangeValueCallback)

noRangeChangeValueCallback :: Maybe RangeChangeValueCallback

onRangeChangeValue :: (IsRange a, MonadIO m) => a -> RangeChangeValueCallback -> m SignalHandlerId

wrap_RangeChangeValueCallback :: RangeChangeValueCallback -> Ptr () -> CUInt -> CDouble -> Ptr () -> IO CInt

moveSlider

type C_RangeMoveSliderCallback = Ptr () -> CUInt -> Ptr () -> IO ()

type RangeMoveSliderCallback = ScrollType -> IO ()

afterRangeMoveSlider :: (IsRange a, MonadIO m) => a -> RangeMoveSliderCallback -> m SignalHandlerId

genClosure_RangeMoveSlider :: RangeMoveSliderCallback -> IO Closure

mk_RangeMoveSliderCallback :: C_RangeMoveSliderCallback -> IO (FunPtr C_RangeMoveSliderCallback)

noRangeMoveSliderCallback :: Maybe RangeMoveSliderCallback

onRangeMoveSlider :: (IsRange a, MonadIO m) => a -> RangeMoveSliderCallback -> m SignalHandlerId

wrap_RangeMoveSliderCallback :: RangeMoveSliderCallback -> Ptr () -> CUInt -> Ptr () -> IO ()

valueChanged

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

type RangeValueChangedCallback = IO ()

afterRangeValueChanged :: (IsRange a, MonadIO m) => a -> RangeValueChangedCallback -> m SignalHandlerId

genClosure_RangeValueChanged :: RangeValueChangedCallback -> IO Closure

mk_RangeValueChangedCallback :: C_RangeValueChangedCallback -> IO (FunPtr C_RangeValueChangedCallback)

noRangeValueChangedCallback :: Maybe RangeValueChangedCallback

onRangeValueChanged :: (IsRange a, MonadIO m) => a -> RangeValueChangedCallback -> m SignalHandlerId

wrap_RangeValueChangedCallback :: RangeValueChangedCallback -> Ptr () -> Ptr () -> IO ()