Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
A scrollable [classclamp
].
AdwClampScrollable
is a variant of [classclamp
] that implements the
Scrollable
interface.
The primary use case for AdwClampScrollable
is clamping
ListView
.
Synopsis
- newtype ClampScrollable = ClampScrollable (ManagedPtr ClampScrollable)
- class (GObject o, IsDescendantOf ClampScrollable o) => IsClampScrollable o
- toClampScrollable :: (MonadIO m, IsClampScrollable o) => o -> m ClampScrollable
- clampScrollableGetChild :: (HasCallStack, MonadIO m, IsClampScrollable a) => a -> m (Maybe Widget)
- clampScrollableGetMaximumSize :: (HasCallStack, MonadIO m, IsClampScrollable a) => a -> m Int32
- clampScrollableGetTighteningThreshold :: (HasCallStack, MonadIO m, IsClampScrollable a) => a -> m Int32
- clampScrollableNew :: (HasCallStack, MonadIO m) => m ClampScrollable
- clampScrollableSetChild :: (HasCallStack, MonadIO m, IsClampScrollable a, IsWidget b) => a -> Maybe b -> m ()
- clampScrollableSetMaximumSize :: (HasCallStack, MonadIO m, IsClampScrollable a) => a -> Int32 -> m ()
- clampScrollableSetTighteningThreshold :: (HasCallStack, MonadIO m, IsClampScrollable a) => a -> Int32 -> m ()
- clearClampScrollableChild :: (MonadIO m, IsClampScrollable o) => o -> m ()
- constructClampScrollableChild :: (IsClampScrollable o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getClampScrollableChild :: (MonadIO m, IsClampScrollable o) => o -> m (Maybe Widget)
- setClampScrollableChild :: (MonadIO m, IsClampScrollable o, IsWidget a) => o -> a -> m ()
- constructClampScrollableMaximumSize :: (IsClampScrollable o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getClampScrollableMaximumSize :: (MonadIO m, IsClampScrollable o) => o -> m Int32
- setClampScrollableMaximumSize :: (MonadIO m, IsClampScrollable o) => o -> Int32 -> m ()
- constructClampScrollableTighteningThreshold :: (IsClampScrollable o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getClampScrollableTighteningThreshold :: (MonadIO m, IsClampScrollable o) => o -> m Int32
- setClampScrollableTighteningThreshold :: (MonadIO m, IsClampScrollable o) => o -> Int32 -> m ()
Exported types
newtype ClampScrollable Source #
Memory-managed wrapper type.
ClampScrollable (ManagedPtr ClampScrollable) |
Instances
class (GObject o, IsDescendantOf ClampScrollable o) => IsClampScrollable o Source #
Type class for types which can be safely cast to ClampScrollable
, for instance with toClampScrollable
.
Instances
(GObject o, IsDescendantOf ClampScrollable o) => IsClampScrollable o Source # | |
Defined in GI.Adw.Objects.ClampScrollable |
toClampScrollable :: (MonadIO m, IsClampScrollable o) => o -> m ClampScrollable Source #
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, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBorder, getBounds, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHadjustment, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHscrollPolicy, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMaximumSize, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOrientation, getOverflow, getPangoContext, getParent, getPlatformState, 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
setAccessibleParent, 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 Source #
:: (HasCallStack, MonadIO m, IsClampScrollable a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the child widget of |
Gets the child widget of self
.
getMaximumSize
clampScrollableGetMaximumSize Source #
:: (HasCallStack, MonadIO m, IsClampScrollable a) | |
=> a |
|
-> m Int32 | Returns: the maximum size to allocate to the child |
Gets the maximum size allocated to the child.
getTighteningThreshold
clampScrollableGetTighteningThreshold Source #
:: (HasCallStack, MonadIO m, IsClampScrollable a) | |
=> a |
|
-> m Int32 | Returns: the size above which the child is clamped |
Gets the size above which the child is clamped.
new
:: (HasCallStack, MonadIO m) | |
=> m ClampScrollable | Returns: the newly created |
Creates a new AdwClampScrollable
.
setChild
clampScrollableSetChild Source #
:: (HasCallStack, MonadIO m, IsClampScrollable a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the child widget of self
.
setMaximumSize
clampScrollableSetMaximumSize Source #
:: (HasCallStack, MonadIO m, IsClampScrollable a) | |
=> a |
|
-> Int32 |
|
-> 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.
setTighteningThreshold
clampScrollableSetTighteningThreshold Source #
:: (HasCallStack, MonadIO m, IsClampScrollable a) | |
=> a |
|
-> Int32 |
|
-> 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.
Properties
child
The child widget of the AdwClampScrollable
.
clearClampScrollableChild :: (MonadIO m, IsClampScrollable o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
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.
constructClampScrollableMaximumSize :: (IsClampScrollable o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
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.
constructClampScrollableTighteningThreshold :: (IsClampScrollable o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “tightening-threshold
” property.
When overloading is enabled, this is equivalent to
set
clampScrollable [ #tighteningThreshold:=
value ]