gi-handy-1.0.4: libhandy bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Handy.Objects.Leaflet

Description

An adaptive container acting like a box or a stack.

The HdyLeaflet widget can display its children like a Box does or like a Stack does, adapting to size changes by switching between the two modes.

When there is enough space the children are displayed side by side, otherwise only one is displayed and the leaflet is said to be “folded”. The threshold is dictated by the preferred minimum sizes of the children. When a leaflet is folded, the children can be navigated using swipe gestures.

The “over” and “under” transition types stack the children one on top of the other, while the “slide” transition puts the children side by side. While navigating to a child on the side or below can be performed by swiping the current child away, navigating to an upper child requires dragging it from the edge where it resides. This doesn't affect non-dragging swipes.

The “over” and “under” transitions can draw their shadow on top of the window's transparent areas, like the rounded corners. This is a side-effect of allowing shadows to be drawn on top of OpenGL areas. It can be mitigated by using [classwindow] or [classapplicationWindow] as they will crop anything drawn beyond the rounded corners.

The child property navigatable can be set on HdyLeaflet children to determine whether they can be navigated to when folded. If FALSE, the child will be ignored by [methodleaflet.get_adjacent_child], [methodleaflet.navigate], and swipe gestures. This can be used used to prevent switching to widgets like separators.

CSS nodes

HdyLeaflet has a single CSS node with name leaflet. The node will get the style classes .folded when it is folded, .unfolded when it's not, or none if it didn't compute its fold yet.

Since: 1.0

Synopsis

Exported types

newtype Leaflet Source #

Memory-managed wrapper type.

Constructors

Leaflet (ManagedPtr Leaflet) 

Instances

Instances details
Eq Leaflet Source # 
Instance details

Defined in GI.Handy.Objects.Leaflet

Methods

(==) :: Leaflet -> Leaflet -> Bool #

(/=) :: Leaflet -> Leaflet -> Bool #

GObject Leaflet Source # 
Instance details

Defined in GI.Handy.Objects.Leaflet

ManagedPtrNewtype Leaflet Source # 
Instance details

Defined in GI.Handy.Objects.Leaflet

Methods

toManagedPtr :: Leaflet -> ManagedPtr Leaflet

TypedObject Leaflet Source # 
Instance details

Defined in GI.Handy.Objects.Leaflet

Methods

glibType :: IO GType

HasParentTypes Leaflet Source # 
Instance details

Defined in GI.Handy.Objects.Leaflet

IsGValue (Maybe Leaflet) Source #

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

Instance details

Defined in GI.Handy.Objects.Leaflet

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Leaflet Source # 
Instance details

Defined in GI.Handy.Objects.Leaflet

type ParentTypes Leaflet = '[Container, Widget, Object, ImplementorIface, Buildable, Orientable, Swipeable]

class (GObject o, IsDescendantOf Leaflet o) => IsLeaflet o Source #

Type class for types which can be safely cast to Leaflet, for instance with toLeaflet.

Instances

Instances details
(GObject o, IsDescendantOf Leaflet o) => IsLeaflet o Source # 
Instance details

Defined in GI.Handy.Objects.Leaflet

toLeaflet :: (MonadIO m, IsLeaflet o) => o -> m Leaflet Source #

Cast to Leaflet, 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

Expand

Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, emitChildSwitched, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, insertChildAfter, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, navigate, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, prepend, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reorderChildAfter, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, switchChild, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

Getters

getAccessible, getActionGroup, getAdjacentChild, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getCanSwipeBack, getCanSwipeForward, getCancelProgress, getChildByName, getChildRequisition, getChildTransitionDuration, getChildTransitionRunning, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDistance, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFolded, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHomogeneous, getInternalChild, getInterpolateSize, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModeTransitionDuration, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProgress, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getSnapPoints, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getSwipeArea, getSwipeTracker, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getTransitionType, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleChild, getVisibleChildName, getVisual, getWindow.

Setters

setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setCanSwipeBack, setCanSwipeForward, setChildTransitionDuration, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHomogeneous, setInterpolateSize, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setModeTransitionDuration, setName, setNoShowAll, setOpacity, setOrientation, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setTransitionType, setValign, setVexpand, setVexpandSet, setVisible, setVisibleChild, setVisibleChildName, setVisual, setWindow.

getAdjacentChild

leafletGetAdjacentChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> NavigationDirection

direction: the direction

-> m (Maybe Widget)

Returns: the previous or next child

Finds the previous or next navigatable child.

This will be the same widget [methodleaflet.navigate] will navigate to.

If there's no child to navigate to, NULL will be returned instead.

Since: 1.0

getCanSwipeBack

leafletGetCanSwipeBack Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Bool

Returns: TRUE if back swipe is enabled

Gets whether swipe gestures switch to the previous navigatable child.

Since: 1.0

getCanSwipeForward

leafletGetCanSwipeForward Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Bool

Returns: TRUE if forward swipe is enabled

Gets whether swipe gestures switch to the next navigatable child.

Since: 1.0

getChildByName

leafletGetChildByName Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Text

name: the name of the child to find

-> m (Maybe Widget)

Returns: the requested child of self

Finds the child of self with the name given as the argument.

Returns NULL if there is no child with this name.

Since: 1.0

getChildTransitionDuration

leafletGetChildTransitionDuration Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Word32

Returns: the child transition duration, in milliseconds

Gets the amount of time that transitions between children will take.

Since: 1.0

getChildTransitionRunning

leafletGetChildTransitionRunning Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Bool

Returns: whether a transition is currently running

Returns whether self is currently in a transition from one page to another.

Since: 1.0

getFolded

leafletGetFolded Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Bool

Returns: whether self is folded

Gets whether self is folded.

Since: 1.0

getHomogeneous

leafletGetHomogeneous Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Bool

folded: the fold

-> Orientation

orientation: the orientation

-> m Bool

Returns: whether self is homogeneous for the given fold and orientation

Gets whether self is homogeneous for the given fold and orientation.

Since: 1.0

getInterpolateSize

leafletGetInterpolateSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Bool

Returns: TRUE if child sizes are interpolated

Gets whether to interpolate between the sizes of children on page switches.

Since: 1.0

getModeTransitionDuration

leafletGetModeTransitionDuration Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Word32

Returns: the mode transition duration, in milliseconds

Gets the amount of time that transitions between modes in self will take.

Since: 1.0

getTransitionType

leafletGetTransitionType Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m LeafletTransitionType

Returns: the current transition type of self

Gets the animation type that will be used for transitions between modes and children.

Since: 1.0

getVisibleChild

leafletGetVisibleChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Widget

Returns: the visible child widget

Gets the visible child widget.

Since: 1.0

getVisibleChildName

leafletGetVisibleChildName Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> m Text

Returns: the name of the visible child

Gets the name of the currently visible child widget.

Since: 1.0

insertChildAfter

leafletInsertChildAfter Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a, IsWidget b, IsWidget c) 
=> a

self: a leaflet

-> b

child: the widget to insert

-> Maybe c

sibling: the sibling after which to insert child

-> m () 

Inserts child in the position after sibling in the list of children.

If sibling is NULL, inserts child at the first position.

Since: 1.2

navigate

leafletNavigate Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> NavigationDirection

direction: the direction

-> m Bool

Returns: whether the visible child was changed

Navigates to the previous or next navigatable child.

The switch is similar to performing a swipe gesture to go in direction.

Since: 1.0

new

leafletNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m Leaflet

Returns: the newly created HdyLeaflet

Creates a new HdyLeaflet.

Since: 1.0

prepend

leafletPrepend Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a, IsWidget b) 
=> a

self: a leaflet

-> b

child: the widget to prepend

-> m () 

Inserts child at the first position in self.

Since: 1.2

reorderChildAfter

leafletReorderChildAfter Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a, IsWidget b, IsWidget c) 
=> a

self: a leaflet

-> b

child: the widget to move, must be a child of self

-> Maybe c

sibling: the sibling to move child after

-> m () 

Moves child to the position after sibling in the list of children.

If sibling is NULL, move child to the first position.

Since: 1.2

setCanSwipeBack

leafletSetCanSwipeBack Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Bool

canSwipeBack: the new value

-> m () 

Sets whether swipe gestures switch to the previous navigatable child.

Since: 1.0

setCanSwipeForward

leafletSetCanSwipeForward Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Bool

canSwipeForward: the new value

-> m () 

Sets whether swipe gestures switch to the next navigatable child.

Since: 1.0

setChildTransitionDuration

leafletSetChildTransitionDuration Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Word32

duration: the new duration, in milliseconds

-> m () 

Sets the duration that transitions between children in self will take.

Since: 1.0

setHomogeneous

leafletSetHomogeneous Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Bool

folded: the fold

-> Orientation

orientation: the orientation

-> Bool

homogeneous: TRUE to make self homogeneous

-> m () 

Sets whether to be homogeneous for the given fold and orientation.

If it is homogeneous, the [classleaflet] will request the same width or height for all its children depending on the orientation. If it isn't and it is folded, the leaflet may change width or height when a different child becomes visible.

Since: 1.0

setInterpolateSize

leafletSetInterpolateSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Bool

interpolateSize: the new value

-> m () 

Sets whether self will interpolate its size when changing the visible child.

If the [propertyleaflet:interpolate-size] property is set to TRUE, self will interpolate its size between the current one and the one it'll take after changing the visible child, according to the set transition duration.

Since: 1.0

setModeTransitionDuration

leafletSetModeTransitionDuration Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Word32

duration: the new duration, in milliseconds

-> m () 

Sets the duration that transitions between modes in self will take.

Since: 1.0

setTransitionType

leafletSetTransitionType Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> LeafletTransitionType

transition: the new transition type

-> m () 

Sets the animation type that will be used for transitions between modes and children.

The transition type can be changed without problems at runtime, so it is possible to change the animation based on the mode or child that is about to become current.

Since: 1.0

setVisibleChild

leafletSetVisibleChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a, IsWidget b) 
=> a

self: a leaflet

-> b

visibleChild: the new child

-> m () 

Sets the currently visible widget when the leaflet is folded.

Since: 1.0

setVisibleChildName

leafletSetVisibleChildName Source #

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a) 
=> a

self: a leaflet

-> Text

name: the name of a child

-> m () 

Makes the child with the name name visible.

See [methodleaflet.set_visible_child] for more details.

Since: 1.0

Properties

canSwipeBack

Whether swipe gestures allow switching to the previous navigatable child.

Since: 1.0

constructLeafletCanSwipeBack :: (IsLeaflet o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getLeafletCanSwipeBack :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #canSwipeBack

setLeafletCanSwipeBack :: (MonadIO m, IsLeaflet o) => o -> Bool -> m () Source #

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

set leaflet [ #canSwipeBack := value ]

canSwipeForward

Whether swipe gestures allow switching to the next navigatable child.

Since: 1.0

constructLeafletCanSwipeForward :: (IsLeaflet o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getLeafletCanSwipeForward :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #canSwipeForward

setLeafletCanSwipeForward :: (MonadIO m, IsLeaflet o) => o -> Bool -> m () Source #

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

set leaflet [ #canSwipeForward := value ]

childTransitionDuration

The child transition animation duration, in milliseconds.

Since: 1.0

constructLeafletChildTransitionDuration :: (IsLeaflet o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getLeafletChildTransitionDuration :: (MonadIO m, IsLeaflet o) => o -> m Word32 Source #

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

get leaflet #childTransitionDuration

setLeafletChildTransitionDuration :: (MonadIO m, IsLeaflet o) => o -> Word32 -> m () Source #

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

set leaflet [ #childTransitionDuration := value ]

childTransitionRunning

Whether a child transition is currently running.

Since: 1.0

getLeafletChildTransitionRunning :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #childTransitionRunning

folded

Whether the leaflet is folded.

The leaflet will be folded if the size allocated to it is smaller than the sum of the natural size of its children, it will be unfolded otherwise.

Since: 1.0

getLeafletFolded :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #folded

hhomogeneousFolded

Whether to allocate the same width for all children when folded.

Since: 1.0

constructLeafletHhomogeneousFolded :: (IsLeaflet o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getLeafletHhomogeneousFolded :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #hhomogeneousFolded

setLeafletHhomogeneousFolded :: (MonadIO m, IsLeaflet o) => o -> Bool -> m () Source #

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

set leaflet [ #hhomogeneousFolded := value ]

hhomogeneousUnfolded

Whether to allocate the same width for all children when unfolded.

Since: 1.0

constructLeafletHhomogeneousUnfolded :: (IsLeaflet o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getLeafletHhomogeneousUnfolded :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #hhomogeneousUnfolded

setLeafletHhomogeneousUnfolded :: (MonadIO m, IsLeaflet o) => o -> Bool -> m () Source #

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

set leaflet [ #hhomogeneousUnfolded := value ]

interpolateSize

Whether the size should smoothly change when changing between children.

Since: 1.0

constructLeafletInterpolateSize :: (IsLeaflet o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getLeafletInterpolateSize :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #interpolateSize

setLeafletInterpolateSize :: (MonadIO m, IsLeaflet o) => o -> Bool -> m () Source #

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

set leaflet [ #interpolateSize := value ]

modeTransitionDuration

The mode transition animation duration, in milliseconds.

Since: 1.0

constructLeafletModeTransitionDuration :: (IsLeaflet o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getLeafletModeTransitionDuration :: (MonadIO m, IsLeaflet o) => o -> m Word32 Source #

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

get leaflet #modeTransitionDuration

setLeafletModeTransitionDuration :: (MonadIO m, IsLeaflet o) => o -> Word32 -> m () Source #

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

set leaflet [ #modeTransitionDuration := value ]

transitionType

The animation type used for transitions between modes and children.

The transition type can be changed without problems at runtime, so it is possible to change the animation based on the mode or child that is about to become current.

Since: 1.0

constructLeafletTransitionType :: (IsLeaflet o, MonadIO m) => LeafletTransitionType -> m (GValueConstruct o) Source #

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

getLeafletTransitionType :: (MonadIO m, IsLeaflet o) => o -> m LeafletTransitionType Source #

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

get leaflet #transitionType

setLeafletTransitionType :: (MonadIO m, IsLeaflet o) => o -> LeafletTransitionType -> m () Source #

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

set leaflet [ #transitionType := value ]

vhomogeneousFolded

Whether to allocates the same height for all children when folded.

Since: 1.0

constructLeafletVhomogeneousFolded :: (IsLeaflet o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getLeafletVhomogeneousFolded :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #vhomogeneousFolded

setLeafletVhomogeneousFolded :: (MonadIO m, IsLeaflet o) => o -> Bool -> m () Source #

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

set leaflet [ #vhomogeneousFolded := value ]

vhomogeneousUnfolded

Whether to allocate the same height for all children when unfolded.

Since: 1.0

constructLeafletVhomogeneousUnfolded :: (IsLeaflet o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getLeafletVhomogeneousUnfolded :: (MonadIO m, IsLeaflet o) => o -> m Bool Source #

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

get leaflet #vhomogeneousUnfolded

setLeafletVhomogeneousUnfolded :: (MonadIO m, IsLeaflet o) => o -> Bool -> m () Source #

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

set leaflet [ #vhomogeneousUnfolded := value ]

visibleChild

The widget currently visible when the leaflet is folded.

The transition is determined by [propertyleaflet:transition-type] and [propertyleaflet:child-transition-duration]. The transition can be cancelled by the user, in which case visible child will change back to the previously visible child.

Since: 1.0

constructLeafletVisibleChild :: (IsLeaflet o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

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

getLeafletVisibleChild :: (MonadIO m, IsLeaflet o) => o -> m Widget Source #

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

get leaflet #visibleChild

setLeafletVisibleChild :: (MonadIO m, IsLeaflet o, IsWidget a) => o -> a -> m () Source #

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

set leaflet [ #visibleChild := value ]

visibleChildName

The name of the widget currently visible when the leaflet is folded.

See [propertyleaflet:visible-child].

Since: 1.0

constructLeafletVisibleChildName :: (IsLeaflet o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getLeafletVisibleChildName :: (MonadIO m, IsLeaflet o) => o -> m Text Source #

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

get leaflet #visibleChildName

setLeafletVisibleChildName :: (MonadIO m, IsLeaflet o) => o -> Text -> m () Source #

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

set leaflet [ #visibleChildName := value ]