GI.Adw.Objects.Flap

An adaptive container acting like a box or an overlay.

<picture> <source srcset="flap-wide-dark.png" media="(prefers-color-scheme: dark)"> <img src="flap-wide.png" alt="flap-wide"> </picture> <picture> <source srcset="flap-narrow-dark.png" media="(prefers-color-scheme: dark)"> <img src="flap-narrow.png" alt="flap-narrow"> </picture>

The AdwFlap widget can display its children like a Box does or like a Overlay does, according to the [propertyflap:fold-policy] value.

AdwFlap has at most three children: [propertyflap:content], [propertyflap:flap] and [propertyflap:separator]. Content is the primary child, flap is displayed next to it when unfolded, or overlays it when folded. Flap can be shown or hidden by changing the [propertyflap:reveal-flap] value, as well as via swipe gestures if [propertyflap:swipe-to-open] and/or [propertyflap:swipe-to-close] are set to TRUE.

Optionally, a separator can be provided, which would be displayed between the content and the flap when there's no shadow to separate them, depending on the transition type.

propertyflap:flap

is transparent by default; add the `.background` style class to it if this is unwanted.

If [propertyflap:modal] is set to TRUE, content becomes completely inaccessible when the flap is revealed while folded.

The position of the flap and separator children relative to the content is determined by orientation, as well as the [propertyflap:flap-position] value.

Folding the flap will automatically hide the flap widget, and unfolding it will automatically reveal it. If this behavior is not desired, the [propertyflap:locked] property can be used to override it.

Common use cases include sidebars, header bars that need to be able to overlap the window content (for example, in fullscreen mode) and bottom sheets.

AdwFlap as GtkBuildable

The AdwFlap implementation of the Buildable interface supports setting the flap child by specifying “flap” as the “type” attribute of a <child> element, and separator by specifying “separator”. Specifying “content” child type or omitting it results in setting the content child.

CSS nodes

AdwFlap has a single CSS node with name flap. The node will get the style classes .folded when it is folded, and .unfolded when it's not.

Since: 1.0

Exported types

newtype Flap

Memory-managed wrapper type.

Constructors

Flap (ManagedPtr Flap)

Instances

Eq Flap

Defined in GI.Adw.Objects.Flap

Methods

(==) :: Flap -> Flap -> Bool

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

GObject Flap

Defined in GI.Adw.Objects.Flap

ManagedPtrNewtype Flap

Defined in GI.Adw.Objects.Flap

Methods

toManagedPtr :: Flap -> ManagedPtr Flap

TypedObject Flap

Defined in GI.Adw.Objects.Flap

Methods

glibType :: IO GType

HasParentTypes Flap

Defined in GI.Adw.Objects.Flap

IsGValue (Maybe Flap)

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

Defined in GI.Adw.Objects.Flap

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Flap

Defined in GI.Adw.Objects.Flap

type ParentTypes Flap = '[Widget, Object, Swipeable, Accessible, Buildable, ConstraintTarget, Orientable]

class (GObject o, IsDescendantOf Flap o) => IsFlap o

Type class for types which can be safely cast to Flap, for instance with toFlap.

Instances

(GObject o, IsDescendantOf Flap o) => IsFlap o

Defined in GI.Adw.Objects.Flap

toFlap :: (MonadIO m, IsFlap o) => o -> m Flap

Cast to Flap, 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, getBuildableId, getCanFocus, getCanTarget, getCancelProgress, getChildVisible, getClipboard, getContent, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getDistance, getFirstChild, getFlap, getFlapPosition, getFocusChild, getFocusOnClick, getFocusable, getFoldDuration, getFoldPolicy, getFoldThresholdPolicy, getFolded, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLocked, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getModal, getName, getNative, getNextSibling, getOpacity, getOrientation, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProgress, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRevealFlap, getRevealParams, getRevealProgress, getRoot, getScaleFactor, getSensitive, getSeparator, getSettings, getSize, getSizeRequest, getSnapPoints, getStateFlags, getStyleContext, getSwipeArea, getSwipeToClose, getSwipeToOpen, getTemplateChild, getTooltipMarkup, getTooltipText, getTransitionType, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setCanFocus, setCanTarget, setChildVisible, setContent, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFlap, setFlapPosition, setFocusChild, setFocusOnClick, setFocusable, setFoldDuration, setFoldPolicy, setFoldThresholdPolicy, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLocked, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setModal, setName, setOpacity, setOrientation, setOverflow, setParent, setProperty, setReceivesDefault, setRevealFlap, setRevealParams, setSensitive, setSeparator, setSizeRequest, setStateFlags, setSwipeToClose, setSwipeToOpen, setTooltipMarkup, setTooltipText, setTransitionType, setValign, setVexpand, setVexpandSet, setVisible.

getContent

flapGetContent

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m (Maybe Widget)

Returns: the content widget for self

Gets the content widget for self.

Since: 1.0

getFlap

flapGetFlap

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m (Maybe Widget)

Returns: the flap widget for self

Gets the flap widget for self.

Since: 1.0

getFlapPosition

flapGetFlapPosition

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m PackType

Returns: the flap position for self

Gets the flap position for self.

Since: 1.0

getFoldDuration

flapGetFoldDuration

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m Word32

Returns: the fold transition duration

Gets the fold transition animation duration for self, in milliseconds.

Since: 1.0

getFoldPolicy

flapGetFoldPolicy

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m FlapFoldPolicy

Returns: the fold policy for self

Gets the fold policy for self.

Since: 1.0

getFoldThresholdPolicy

flapGetFoldThresholdPolicy

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m FoldThresholdPolicy

Gets the fold threshold policy for self.

Since: 1.0

getFolded

flapGetFolded

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m Bool

Returns: TRUE if self is currently folded

Gets whether self is currently folded.

See [propertyflap:fold-policy].

Since: 1.0

getLocked

flapGetLocked

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m Bool

Returns: TRUE if self is locked

Gets whether self is locked.

Since: 1.0

getModal

flapGetModal

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m Bool

Returns: TRUE if self is modal

Gets whether self is modal.

Since: 1.0

getRevealFlap

flapGetRevealFlap

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m Bool

Returns: TRUE if the flap widget is revealed

Gets whether the flap widget is revealed for self.

Since: 1.0

getRevealParams

flapGetRevealParams

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m SpringParams

Returns: the reveal animation parameters

Gets the reveal animation spring parameters for self.

Since: 1.0

getRevealProgress

flapGetRevealProgress

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m Double

Returns: the current reveal progress for self

Gets the current reveal progress for self.

0 means fully hidden, 1 means fully revealed.

See [propertyflap:reveal-flap].

Since: 1.0

getSeparator

flapGetSeparator

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m (Maybe Widget)

Returns: the separator widget for self

Gets the separator widget for self.

Since: 1.0

getSwipeToClose

flapGetSwipeToClose

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m Bool

Returns: TRUE if self can be closed with a swipe gesture

Gets whether self can be closed with a swipe gesture.

Since: 1.0

getSwipeToOpen

flapGetSwipeToOpen

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m Bool

Returns: TRUE if self can be opened with a swipe gesture

Gets whether self can be opened with a swipe gesture.

Since: 1.0

getTransitionType

flapGetTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> m FlapTransitionType

Returns: the current transition type of self

Gets the type of animation used for reveal and fold transitions in self.

Since: 1.0

new

flapNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Flap

Returns: the newly created AdwFlap

Creates a new AdwFlap.

Since: 1.0

setContent

flapSetContent

Arguments

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

=> a

self: a flap

-> Maybe b

content: the content widget

-> m ()

Sets the content widget for self.

It's always displayed when unfolded, and partially visible when folded.

Since: 1.0

setFlap

flapSetFlap

Arguments

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

=> a

self: a flap

-> Maybe b

flap: the flap widget

-> m ()

Sets the flap widget for self.

It's only visible when [propertyflap:reveal-progress] is greater than 0.

Since: 1.0

setFlapPosition

flapSetFlapPosition

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> PackType

position: the new value

-> m ()

Sets the flap position for self.

If it's set to GTK_PACK_START, the flap is displayed before the content, if GTK_PACK_END, it's displayed after the content.

Since: 1.0

setFoldDuration

flapSetFoldDuration

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> Word32

duration: the new duration, in milliseconds

-> m ()

Sets the fold transition animation duration for self, in milliseconds.

Since: 1.0

setFoldPolicy

flapSetFoldPolicy

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> FlapFoldPolicy

policy: the fold policy

-> m ()

Sets the fold policy for self.

Since: 1.0

setFoldThresholdPolicy

flapSetFoldThresholdPolicy

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> FoldThresholdPolicy

policy: the policy to use

-> m ()

Sets the fold threshold policy for self.

If set to ADW_FOLD_THRESHOLD_POLICY_MINIMUM, flap will only fold when the children cannot fit anymore. With ADW_FOLD_THRESHOLD_POLICY_NATURAL, it will fold as soon as children don't get their natural size.

This can be useful if you have a long ellipsizing label and want to let it ellipsize instead of immediately folding.

Since: 1.0

setLocked

flapSetLocked

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> Bool

locked: the new value

-> m ()

Sets whether self is locked.

If FALSE, folding when the flap is revealed automatically closes it, and unfolding it when the flap is not revealed opens it. If TRUE, [propertyflap:reveal-flap] value never changes on its own.

Since: 1.0

setModal

flapSetModal

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> Bool

modal: whether self is modal

-> m ()

Sets whether self is modal.

If TRUE, clicking the content widget while flap is revealed, as well as pressing the <kbd>Esc</kbd> key, will close the flap. If FALSE, clicks are passed through to the content widget.

Since: 1.0

setRevealFlap

flapSetRevealFlap

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> Bool

revealFlap: whether to reveal the flap widget

-> m ()

Sets whether the flap widget is revealed for self.

Since: 1.0

setRevealParams

flapSetRevealParams

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> SpringParams

params: the new parameters

-> m ()

Sets the reveal animation spring parameters for self.

The default value is equivalent to:

c code

adw_spring_params_new (1, 0.5, 500)

Since: 1.0

setSeparator

flapSetSeparator

Arguments

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

=> a

self: a flap

-> Maybe b

separator: the separator widget

-> m ()

Sets the separator widget for self.

It's displayed between content and flap when there's no shadow to display. When exactly it's visible depends on the [propertyflap:transition-type] value.

Since: 1.0

setSwipeToClose

flapSetSwipeToClose

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> Bool

swipeToClose: whether self can be closed with a swipe gesture

-> m ()

Sets whether self can be closed with a swipe gesture.

The area that can be swiped depends on the [propertyflap:transition-type] value.

Since: 1.0

setSwipeToOpen

flapSetSwipeToOpen

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> Bool

swipeToOpen: whether self can be opened with a swipe gesture

-> m ()

Sets whether self can be opened with a swipe gesture.

The area that can be swiped depends on the [propertyflap:transition-type] value.

Since: 1.0

setTransitionType

flapSetTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsFlap a)

=> a

self: a flap

-> FlapTransitionType

transitionType: the new transition type

-> m ()

Sets the type of animation used for reveal and fold transitions in self.

propertyflap:flap

is transparent by default, which means the content will be seen through it with ADW_FLAP_TRANSITION_TYPE_OVER transitions; add the `.background` style class to it if this is unwanted.

Since: 1.0

Properties

content

The content widget.

It's always displayed when unfolded, and partially visible when folded.

Since: 1.0

clearFlapContent :: (MonadIO m, IsFlap o) => o -> m ()

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

clear #content

constructFlapContent :: (IsFlap o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getFlapContent :: (MonadIO m, IsFlap o) => o -> m (Maybe Widget)

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

get flap #content

setFlapContent :: (MonadIO m, IsFlap o, IsWidget a) => o -> a -> m ()

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

set flap [ #content := value ]

flap

The flap widget.

It's only visible when [propertyflap:reveal-progress] is greater than 0.

Since: 1.0

clearFlapFlap :: (MonadIO m, IsFlap o) => o -> m ()

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

clear #flap

constructFlapFlap :: (IsFlap o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getFlapFlap :: (MonadIO m, IsFlap o) => o -> m (Maybe Widget)

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

get flap #flap

setFlapFlap :: (MonadIO m, IsFlap o, IsWidget a) => o -> a -> m ()

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

set flap [ #flap := value ]

flapPosition

The flap position.

If it's set to GTK_PACK_START, the flap is displayed before the content, if GTK_PACK_END, it's displayed after the content.

Since: 1.0

constructFlapFlapPosition :: (IsFlap o, MonadIO m) => PackType -> m (GValueConstruct o)

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

getFlapFlapPosition :: (MonadIO m, IsFlap o) => o -> m PackType

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

get flap #flapPosition

setFlapFlapPosition :: (MonadIO m, IsFlap o) => o -> PackType -> m ()

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

set flap [ #flapPosition := value ]

foldDuration

The fold transition animation duration, in milliseconds.

Since: 1.0

constructFlapFoldDuration :: (IsFlap o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getFlapFoldDuration :: (MonadIO m, IsFlap o) => o -> m Word32

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

get flap #foldDuration

setFlapFoldDuration :: (MonadIO m, IsFlap o) => o -> Word32 -> m ()

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

set flap [ #foldDuration := value ]

foldPolicy

The fold policy for the flap.

Since: 1.0

constructFlapFoldPolicy :: (IsFlap o, MonadIO m) => FlapFoldPolicy -> m (GValueConstruct o)

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

getFlapFoldPolicy :: (MonadIO m, IsFlap o) => o -> m FlapFoldPolicy

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

get flap #foldPolicy

setFlapFoldPolicy :: (MonadIO m, IsFlap o) => o -> FlapFoldPolicy -> m ()

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

set flap [ #foldPolicy := value ]

foldThresholdPolicy

Determines when the flap will fold.

If set to ADW_FOLD_THRESHOLD_POLICY_MINIMUM, flap will only fold when the children cannot fit anymore. With ADW_FOLD_THRESHOLD_POLICY_NATURAL, it will fold as soon as children don't get their natural size.

This can be useful if you have a long ellipsizing label and want to let it ellipsize instead of immediately folding.

Since: 1.0

constructFlapFoldThresholdPolicy :: (IsFlap o, MonadIO m) => FoldThresholdPolicy -> m (GValueConstruct o)

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

getFlapFoldThresholdPolicy :: (MonadIO m, IsFlap o) => o -> m FoldThresholdPolicy

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

get flap #foldThresholdPolicy

setFlapFoldThresholdPolicy :: (MonadIO m, IsFlap o) => o -> FoldThresholdPolicy -> m ()

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

set flap [ #foldThresholdPolicy := value ]

folded

Whether the flap is currently folded.

See [propertyflap:fold-policy].

Since: 1.0

getFlapFolded :: (MonadIO m, IsFlap o) => o -> m Bool

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

get flap #folded

locked

Whether the flap is locked.

If FALSE, folding when the flap is revealed automatically closes it, and unfolding it when the flap is not revealed opens it. If TRUE, [propertyflap:reveal-flap] value never changes on its own.

Since: 1.0

constructFlapLocked :: (IsFlap o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getFlapLocked :: (MonadIO m, IsFlap o) => o -> m Bool

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

get flap #locked

setFlapLocked :: (MonadIO m, IsFlap o) => o -> Bool -> m ()

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

set flap [ #locked := value ]

modal

Whether the flap is modal.

If TRUE, clicking the content widget while flap is revealed, as well as pressing the <kbd>Esc</kbd> key, will close the flap. If FALSE, clicks are passed through to the content widget.

Since: 1.0

constructFlapModal :: (IsFlap o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getFlapModal :: (MonadIO m, IsFlap o) => o -> m Bool

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

get flap #modal

setFlapModal :: (MonadIO m, IsFlap o) => o -> Bool -> m ()

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

set flap [ #modal := value ]

revealFlap

Whether the flap widget is revealed.

Since: 1.0

constructFlapRevealFlap :: (IsFlap o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getFlapRevealFlap :: (MonadIO m, IsFlap o) => o -> m Bool

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

get flap #revealFlap

setFlapRevealFlap :: (MonadIO m, IsFlap o) => o -> Bool -> m ()

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

set flap [ #revealFlap := value ]

revealParams

The reveal animation spring parameters.

The default value is equivalent to:

c code

adw_spring_params_new (1, 0.5, 500)

Since: 1.0

constructFlapRevealParams :: (IsFlap o, MonadIO m) => SpringParams -> m (GValueConstruct o)

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

getFlapRevealParams :: (MonadIO m, IsFlap o) => o -> m (Maybe SpringParams)

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

get flap #revealParams

setFlapRevealParams :: (MonadIO m, IsFlap o) => o -> SpringParams -> m ()

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

set flap [ #revealParams := value ]

revealProgress

The current reveal transition progress.

0 means fully hidden, 1 means fully revealed.

See [propertyflap:reveal-flap].

Since: 1.0

getFlapRevealProgress :: (MonadIO m, IsFlap o) => o -> m Double

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

get flap #revealProgress

separator

The separator widget.

It's displayed between content and flap when there's no shadow to display. When exactly it's visible depends on the [propertyflap:transition-type] value.

Since: 1.0

clearFlapSeparator :: (MonadIO m, IsFlap o) => o -> m ()

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

clear #separator

constructFlapSeparator :: (IsFlap o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getFlapSeparator :: (MonadIO m, IsFlap o) => o -> m (Maybe Widget)

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

get flap #separator

setFlapSeparator :: (MonadIO m, IsFlap o, IsWidget a) => o -> a -> m ()

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

set flap [ #separator := value ]

swipeToClose

Whether the flap can be closed with a swipe gesture.

The area that can be swiped depends on the [propertyflap:transition-type] value.

Since: 1.0

constructFlapSwipeToClose :: (IsFlap o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getFlapSwipeToClose :: (MonadIO m, IsFlap o) => o -> m Bool

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

get flap #swipeToClose

setFlapSwipeToClose :: (MonadIO m, IsFlap o) => o -> Bool -> m ()

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

set flap [ #swipeToClose := value ]

swipeToOpen

Whether the flap can be opened with a swipe gesture.

The area that can be swiped depends on the [propertyflap:transition-type] value.

Since: 1.0

constructFlapSwipeToOpen :: (IsFlap o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getFlapSwipeToOpen :: (MonadIO m, IsFlap o) => o -> m Bool

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

get flap #swipeToOpen

setFlapSwipeToOpen :: (MonadIO m, IsFlap o) => o -> Bool -> m ()

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

set flap [ #swipeToOpen := value ]

transitionType

the type of animation used for reveal and fold transitions.

propertyflap:flap

is transparent by default, which means the content will be seen through it with ADW_FLAP_TRANSITION_TYPE_OVER transitions; add the `.background` style class to it if this is unwanted.

Since: 1.0

constructFlapTransitionType :: (IsFlap o, MonadIO m) => FlapTransitionType -> m (GValueConstruct o)

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

getFlapTransitionType :: (MonadIO m, IsFlap o) => o -> m FlapTransitionType

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

get flap #transitionType

setFlapTransitionType :: (MonadIO m, IsFlap o) => o -> FlapTransitionType -> m ()

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

set flap [ #transitionType := value ]