GI.Handy.Objects.Leaflet

No description available in the introspection data.

Exported types

newtype Leaflet

Memory-managed wrapper type.

Constructors

Leaflet (ManagedPtr Leaflet)

Instances

GObject Leaflet

Defined in GI.Handy.Objects.Leaflet

Methods

gobjectType :: IO GType

HasParentTypes Leaflet

Defined in GI.Handy.Objects.Leaflet

type ParentTypes Leaflet

Defined in GI.Handy.Objects.Leaflet

type ParentTypes Leaflet = Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': (Orientable ': ([] :: [Type]))))))

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

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

Instances

(GObject o, IsDescendantOf Leaflet o) => IsLeaflet o

Defined in GI.Handy.Objects.Leaflet

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

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

noLeaflet :: Maybe Leaflet

A convenience alias for Nothing :: Maybe Leaflet.

Methods

getChildTransitionDuration

leafletGetChildTransitionDuration

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> m Word32

Returns: the mode transition duration

Returns the amount of time (in milliseconds) that transitions between children in self will take.

getChildTransitionRunning

leafletGetChildTransitionRunning

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> m Bool

Returns: True if the transition is currently running, False otherwise.

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

getChildTransitionType

leafletGetChildTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> m LeafletChildTransitionType

Returns: the current mode transition type of self

Gets the type of animation that will be used for transitions between modes in self.

getFold

leafletGetFold

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> m Fold

Returns: the fold of self.

Gets the fold of self.

getHomogeneous

leafletGetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> Fold

fold: 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. See leafletSetHomogeneous.

getInterpolateSize

leafletGetInterpolateSize

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> m Bool

Returns: True if child sizes are interpolated

Returns wether the Leaflet is set up to interpolate between the sizes of children on page switch.

getModeTransitionDuration

leafletGetModeTransitionDuration

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> m Word32

Returns: the mode transition duration

Returns the amount of time (in milliseconds) that transitions between modes in self will take.

getModeTransitionType

leafletGetModeTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> m LeafletModeTransitionType

Returns: the current mode transition type of self

Gets the type of animation that will be used for transitions between modes in self.

getVisibleChild

leafletGetVisibleChild

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> m Widget

Returns: the visible child widget

Get the visible child widget.

getVisibleChildName

leafletGetVisibleChildName :: (HasCallStack, MonadIO m, IsLeaflet a) => a -> m Text

No description available in the introspection data.

new

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

No description available in the introspection data.

setChildTransitionDuration

leafletSetChildTransitionDuration

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.

setChildTransitionType

leafletSetChildTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> LeafletChildTransitionType

transition: the new transition type

-> m ()

Sets the type of animation that will be used for transitions between children in self.

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

setHomogeneous

leafletSetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> Fold

fold: the fold

-> Orientation

orientation: the orientation

-> Bool

homogeneous: True to make self homogeneous

-> m ()

Sets the Leaflet to be homogeneous or not for the given fold and orientation. If it is homogeneous, the Leaflet 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.

setInterpolateSize

leafletSetInterpolateSize

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> Bool

interpolateSize: the new value

-> m ()

Sets whether or not self will interpolate its size when changing the visible child. If the Leaflet:interpolate-size property is set to True, stack 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.

setModeTransitionDuration

leafletSetModeTransitionDuration

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.

setModeTransitionType

leafletSetModeTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsLeaflet a)

=> a

self: a Leaflet

-> LeafletModeTransitionType

transition: the new transition type

-> m ()

Sets the type of animation that will be used for transitions between modes in self.

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

setVisibleChild

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

No description available in the introspection data.

setVisibleChildName

leafletSetVisibleChildName :: (HasCallStack, MonadIO m, IsLeaflet a) => a -> Text -> m ()

No description available in the introspection data.

Properties

childTransitionDuration

No description available in the introspection data.

constructLeafletChildTransitionDuration :: IsLeaflet o => Word32 -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #childTransitionDuration := value ]

childTransitionRunning

No description available in the introspection data.

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

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

get leaflet #childTransitionRunning

childTransitionType

No description available in the introspection data.

constructLeafletChildTransitionType :: IsLeaflet o => LeafletChildTransitionType -> IO (GValueConstruct o)

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

getLeafletChildTransitionType :: (MonadIO m, IsLeaflet o) => o -> m LeafletChildTransitionType

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

get leaflet #childTransitionType

setLeafletChildTransitionType :: (MonadIO m, IsLeaflet o) => o -> LeafletChildTransitionType -> m ()

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

set leaflet [ #childTransitionType := value ]

fold

The fold of the leaflet.

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.

See also: Leaflet:folded.

getLeafletFold :: (MonadIO m, IsLeaflet o) => o -> m Fold

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

get leaflet #fold

folded

True if the leaflet is folded.

This is similar to the Leaflet:fold property but expressed as a Bool rather than a GEnum. This makes it convenient to bind the Leaflet:fold of a leaflet to any other Bool property of other 'GI.GObject.Objects.Object.Object'\'s using g_object_bind_property().

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

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

get leaflet #folded

hhomogeneousFolded

No description available in the introspection data.

constructLeafletHhomogeneousFolded :: IsLeaflet o => Bool -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #hhomogeneousFolded := value ]

hhomogeneousUnfolded

No description available in the introspection data.

constructLeafletHhomogeneousUnfolded :: IsLeaflet o => Bool -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #hhomogeneousUnfolded := value ]

interpolateSize

No description available in the introspection data.

constructLeafletInterpolateSize :: IsLeaflet o => Bool -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #interpolateSize := value ]

modeTransitionDuration

No description available in the introspection data.

constructLeafletModeTransitionDuration :: IsLeaflet o => Word32 -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #modeTransitionDuration := value ]

modeTransitionType

No description available in the introspection data.

constructLeafletModeTransitionType :: IsLeaflet o => LeafletModeTransitionType -> IO (GValueConstruct o)

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

getLeafletModeTransitionType :: (MonadIO m, IsLeaflet o) => o -> m LeafletModeTransitionType

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

get leaflet #modeTransitionType

setLeafletModeTransitionType :: (MonadIO m, IsLeaflet o) => o -> LeafletModeTransitionType -> m ()

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

set leaflet [ #modeTransitionType := value ]

vhomogeneousFolded

No description available in the introspection data.

constructLeafletVhomogeneousFolded :: IsLeaflet o => Bool -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #vhomogeneousFolded := value ]

vhomogeneousUnfolded

No description available in the introspection data.

constructLeafletVhomogeneousUnfolded :: IsLeaflet o => Bool -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #vhomogeneousUnfolded := value ]

visibleChild

No description available in the introspection data.

constructLeafletVisibleChild :: (IsLeaflet o, IsWidget a) => a -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #visibleChild := value ]

visibleChildName

No description available in the introspection data.

constructLeafletVisibleChildName :: IsLeaflet o => Text -> IO (GValueConstruct o)

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

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 ()

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

set leaflet [ #visibleChildName := value ]