GI.Adw.Objects.LeafletPage

An auxiliary class used by [classleaflet].

Exported types

newtype LeafletPage

Memory-managed wrapper type.

Constructors

LeafletPage (ManagedPtr LeafletPage)

Instances

Eq LeafletPage

Defined in GI.Adw.Objects.LeafletPage

Methods

(==) :: LeafletPage -> LeafletPage -> Bool

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

GObject LeafletPage

Defined in GI.Adw.Objects.LeafletPage

ManagedPtrNewtype LeafletPage

Defined in GI.Adw.Objects.LeafletPage

Methods

toManagedPtr :: LeafletPage -> ManagedPtr LeafletPage

TypedObject LeafletPage

Defined in GI.Adw.Objects.LeafletPage

Methods

glibType :: IO GType

HasParentTypes LeafletPage

Defined in GI.Adw.Objects.LeafletPage

IsGValue (Maybe LeafletPage)

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

Defined in GI.Adw.Objects.LeafletPage

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes LeafletPage

Defined in GI.Adw.Objects.LeafletPage

type ParentTypes LeafletPage = '[Object]

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

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

Instances

(GObject o, IsDescendantOf LeafletPage o) => IsLeafletPage o

Defined in GI.Adw.Objects.LeafletPage

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

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

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getChild, getData, getName, getNavigatable, getProperty, getQdata.

Setters

setData, setDataFull, setName, setNavigatable, setProperty.

getChild

leafletPageGetChild

Arguments

:: (HasCallStack, MonadIO m, IsLeafletPage a)

=> a

self: a leaflet page

-> m Widget

Returns: the child to which self belongs

Deprecated: (Since version 1.4)See the migration guide

Gets the leaflet child to which self belongs.

getName

leafletPageGetName

Arguments

:: (HasCallStack, MonadIO m, IsLeafletPage a)

=> a

self: a leaflet page

-> m (Maybe Text)

Returns: the name of self.

Deprecated: (Since version 1.4)See the migration guide

Gets the name of self.

getNavigatable

leafletPageGetNavigatable

Arguments

:: (HasCallStack, MonadIO m, IsLeafletPage a)

=> a

self: a leaflet page

-> m Bool

Returns: whether self can be navigated to when folded

Deprecated: (Since version 1.4)See the migration guide

Gets whether the child can be navigated to when folded.

setName

leafletPageSetName

Arguments

:: (HasCallStack, MonadIO m, IsLeafletPage a)

=> a

self: a leaflet page

-> Maybe Text

name: the new value to set

-> m ()

Deprecated: (Since version 1.4)See the migration guide

Sets the name of the self.

setNavigatable

leafletPageSetNavigatable

Arguments

:: (HasCallStack, MonadIO m, IsLeafletPage a)

=> a

self: a leaflet page

-> Bool

navigatable: whether self can be navigated to when folded

-> m ()

Deprecated: (Since version 1.4)See the migration guide

Sets whether self 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.

Properties

child

The leaflet child to which the page belongs.

constructLeafletPageChild :: (IsLeafletPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

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.

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

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)

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)

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

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 [methodleaflet.get_adjacent_child], [methodleaflet.navigate], and swipe gestures.

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

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

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

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

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

set leafletPage [ #navigatable := value ]