GI.Adw.Objects.ClampScrollable

A scrollable [classclamp].

AdwClampScrollable is a variant of [classclamp] that implements the Scrollable interface.

The primary use case for AdwClampScrollable is clamping ListView.

Since: 1.0

Exported types

newtype ClampScrollable

Memory-managed wrapper type.

Constructors

ClampScrollable (ManagedPtr ClampScrollable)

Instances

Eq ClampScrollable

Defined in GI.Adw.Objects.ClampScrollable

Methods

(==) :: ClampScrollable -> ClampScrollable -> Bool

(/=) :: ClampScrollable -> ClampScrollable -> Bool

GObject ClampScrollable

Defined in GI.Adw.Objects.ClampScrollable

ManagedPtrNewtype ClampScrollable

Defined in GI.Adw.Objects.ClampScrollable

Methods

toManagedPtr :: ClampScrollable -> ManagedPtr ClampScrollable

TypedObject ClampScrollable

Defined in GI.Adw.Objects.ClampScrollable

Methods

glibType :: IO GType

HasParentTypes ClampScrollable

Defined in GI.Adw.Objects.ClampScrollable

IsGValue (Maybe ClampScrollable)

Convert ClampScrollable to and from GValue. See toGValue and fromGValue.

Defined in GI.Adw.Objects.ClampScrollable

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ClampScrollable -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ClampScrollable)

type ParentTypes ClampScrollable

Defined in GI.Adw.Objects.ClampScrollable

type ParentTypes ClampScrollable = '[Widget, Object, Accessible, Buildable, ConstraintTarget, Orientable, Scrollable]

class (GObject o, IsDescendantOf ClampScrollable o) => IsClampScrollable o

Type class for types which can be safely cast to ClampScrollable, for instance with toClampScrollable.

Instances

(GObject o, IsDescendantOf ClampScrollable o) => IsClampScrollable o

Defined in GI.Adw.Objects.ClampScrollable

toClampScrollable :: (MonadIO m, IsClampScrollable o) => o -> m ClampScrollable

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

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBorder, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHadjustment, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHscrollPolicy, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMaximumSize, getName, getNative, getNextSibling, getOpacity, getOrientation, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTighteningThreshold, getTooltipMarkup, getTooltipText, getVadjustment, getValign, getVexpand, getVexpandSet, getVisible, getVscrollPolicy, getWidth.

Setters

setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHadjustment, setHalign, setHasTooltip, setHexpand, setHexpandSet, setHscrollPolicy, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMaximumSize, setName, setOpacity, setOrientation, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTighteningThreshold, setTooltipMarkup, setTooltipText, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVscrollPolicy.

getChild

clampScrollableGetChild

Arguments

:: (HasCallStack, MonadIO m, IsClampScrollable a)

=> a

self: a clamp scrollable

-> m (Maybe Widget)

Returns: the child widget of self

Gets the child widget of self.

Since: 1.0

getMaximumSize

clampScrollableGetMaximumSize

Arguments

:: (HasCallStack, MonadIO m, IsClampScrollable a)

=> a

self: a clamp scrollable

-> m Int32

Returns: the maximum size to allocate to the child

Gets the maximum size allocated to the child.

Since: 1.0

getTighteningThreshold

clampScrollableGetTighteningThreshold

Arguments

:: (HasCallStack, MonadIO m, IsClampScrollable a)

=> a

self: a clamp scrollable

-> m Int32

Returns: the size above which the child is clamped

Gets the size above which the child is clamped.

Since: 1.0

new

clampScrollableNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ClampScrollable

Returns: the newly created AdwClampScrollable

Creates a new AdwClampScrollable.

Since: 1.0

setChild

clampScrollableSetChild

Arguments

:: (HasCallStack, MonadIO m, IsClampScrollable a, IsWidget b)

=> a

self: a clamp scrollable

-> Maybe b

child: the child widget

-> m ()

Sets the child widget of self.

Since: 1.0

setMaximumSize

clampScrollableSetMaximumSize

Arguments

:: (HasCallStack, MonadIO m, IsClampScrollable a)

=> a

self: a clamp scrollable

-> Int32

maximumSize: the maximum size

-> m ()

Sets the maximum size allocated to the child.

It is the width if the clamp is horizontal, or the height if it is vertical.

Since: 1.0

setTighteningThreshold

clampScrollableSetTighteningThreshold

Arguments

:: (HasCallStack, MonadIO m, IsClampScrollable a)

=> a

self: a clamp scrollable

-> Int32

tighteningThreshold: the tightening threshold

-> m ()

Sets the size above which the child is clamped.

Starting from this size, the clamp will tighten its grip on the child, slowly allocating less and less of the available size up to the maximum allocated size. Below that threshold and below the maximum width, the child will be allocated all the available size.

If the threshold is greater than the maximum size to allocate to the child, the child will be allocated all the width up to the maximum. If the threshold is lower than the minimum size to allocate to the child, that size will be used as the tightening threshold.

Effectively, tightening the grip on the child before it reaches its maximum size makes transitions to and from the maximum size smoother when resizing.

Since: 1.0

Properties

child

The child widget of the AdwClampScrollable.

Since: 1.0

clearClampScrollableChild :: (MonadIO m, IsClampScrollable o) => o -> m ()

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

clear #child

constructClampScrollableChild :: (IsClampScrollable o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getClampScrollableChild :: (MonadIO m, IsClampScrollable o) => o -> m (Maybe Widget)

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

get clampScrollable #child

setClampScrollableChild :: (MonadIO m, IsClampScrollable o, IsWidget a) => o -> a -> m ()

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

set clampScrollable [ #child := value ]

maximumSize

The maximum size allocated to the child.

It is the width if the clamp is horizontal, or the height if it is vertical.

Since: 1.0

constructClampScrollableMaximumSize :: (IsClampScrollable o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getClampScrollableMaximumSize :: (MonadIO m, IsClampScrollable o) => o -> m Int32

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

get clampScrollable #maximumSize

setClampScrollableMaximumSize :: (MonadIO m, IsClampScrollable o) => o -> Int32 -> m ()

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

set clampScrollable [ #maximumSize := value ]

tighteningThreshold

The size above which the child is clamped.

Starting from this size, the clamp will tighten its grip on the child, slowly allocating less and less of the available size up to the maximum allocated size. Below that threshold and below the maximum width, the child will be allocated all the available size.

If the threshold is greater than the maximum size to allocate to the child, the child will be allocated all the width up to the maximum. If the threshold is lower than the minimum size to allocate to the child, that size will be used as the tightening threshold.

Effectively, tightening the grip on the child before it reaches its maximum size makes transitions to and from the maximum size smoother when resizing.

Since: 1.0

constructClampScrollableTighteningThreshold :: (IsClampScrollable o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getClampScrollableTighteningThreshold :: (MonadIO m, IsClampScrollable o) => o -> m Int32

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

get clampScrollable #tighteningThreshold

setClampScrollableTighteningThreshold :: (MonadIO m, IsClampScrollable o) => o -> Int32 -> m ()

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

set clampScrollable [ #tighteningThreshold := value ]