gi-adwaita-1.0.1: Adwaita bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Adw.Objects.LeafletPage

Description

An auxiliary class used by Leaflet.

Synopsis

Exported types

newtype LeafletPage Source #

Memory-managed wrapper type.

class (GObject o, IsDescendantOf LeafletPage o) => IsLeafletPage o Source #

Type class for types which can be safely cast to LeafletPage, for instance with toLeafletPage.

Instances

Instances details
(GObject o, IsDescendantOf LeafletPage o) => IsLeafletPage o Source # 
Instance details

Defined in GI.Adw.Objects.LeafletPage

toLeafletPage :: (MonadIO m, IsLeafletPage o) => o -> m LeafletPage Source #

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

Methods

getChild

leafletPageGetChild Source #

Arguments

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

self: a AdwLeafletPage

-> m Widget

Returns: the child to which self belongs

Gets the leaflet child th which self belongs.

Since: 1.0

getName

leafletPageGetName Source #

Arguments

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

self: a AdwLeafletPage

-> m (Maybe Text)

Returns: the name of self.

Gets the name of self.

Since: 1.0

getNavigatable

leafletPageGetNavigatable Source #

Arguments

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

self: a AdwLeafletPage

-> m Bool

Returns: whether self can be navigated to when folded

Gets whether the child can be navigated to when folded.

Since: 1.0

setName

leafletPageSetName Source #

Arguments

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

self: a AdwLeafletPage

-> Maybe Text

name: the new value to set

-> m () 

Sets the name of the self.

Since: 1.0

setNavigatable

leafletPageSetNavigatable Source #

Arguments

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

self: a AdwLeafletPage

-> Bool

navigatable: whether self can be navigated to when folded

-> m () 

Sets whether self can be navigated to when folded.

Since: 1.0

Properties

child

The child of the page.

Since: 1.0

constructLeafletPageChild :: (IsLeafletPage 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.

getLeafletPageChild :: (MonadIO m, IsLeafletPage o) => o -> m Widget Source #

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

get leafletPage #child

name

The name of the child page.

Since: 1.0

clearLeafletPageName :: (MonadIO m, IsLeafletPage o) => o -> m () Source #

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

clear #name

constructLeafletPageName :: (IsLeafletPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getLeafletPageName :: (MonadIO m, IsLeafletPage o) => o -> m (Maybe Text) Source #

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

get leafletPage #name

setLeafletPageName :: (MonadIO m, IsLeafletPage o) => o -> Text -> m () Source #

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

set leafletPage [ #name := value ]

navigatable

Whether the child can be navigated to when folded.

If FALSE, the child will be ignored by leafletGetAdjacentChild, leafletNavigate, and swipe gestures.

This can be used used to prevent switching to widgets like separators.

Since: 1.0

constructLeafletPageNavigatable :: (IsLeafletPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getLeafletPageNavigatable :: (MonadIO m, IsLeafletPage o) => o -> m Bool Source #

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

get leafletPage #navigatable

setLeafletPageNavigatable :: (MonadIO m, IsLeafletPage o) => o -> Bool -> m () Source #

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

set leafletPage [ #navigatable := value ]