GI.Adw.Objects.ViewStackPage

An auxiliary class used by [classviewStack].

Exported types

newtype ViewStackPage

Memory-managed wrapper type.

Constructors

ViewStackPage (ManagedPtr ViewStackPage)

Instances

Eq ViewStackPage

Defined in GI.Adw.Objects.ViewStackPage

Methods

(==) :: ViewStackPage -> ViewStackPage -> Bool

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

GObject ViewStackPage

Defined in GI.Adw.Objects.ViewStackPage

ManagedPtrNewtype ViewStackPage

Defined in GI.Adw.Objects.ViewStackPage

Methods

toManagedPtr :: ViewStackPage -> ManagedPtr ViewStackPage

TypedObject ViewStackPage

Defined in GI.Adw.Objects.ViewStackPage

Methods

glibType :: IO GType

HasParentTypes ViewStackPage

Defined in GI.Adw.Objects.ViewStackPage

IsGValue (Maybe ViewStackPage)

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

Defined in GI.Adw.Objects.ViewStackPage

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ViewStackPage

Defined in GI.Adw.Objects.ViewStackPage

type ParentTypes ViewStackPage = '[Object, Accessible]

class (GObject o, IsDescendantOf ViewStackPage o) => IsViewStackPage o

Type class for types which can be safely cast to ViewStackPage, for instance with toViewStackPage.

Instances

(GObject o, IsDescendantOf ViewStackPage o) => IsViewStackPage o

Defined in GI.Adw.Objects.ViewStackPage

toViewStackPage :: (MonadIO m, IsViewStackPage o) => o -> m ViewStackPage

Cast to ViewStackPage, 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, resetProperty, resetRelation, resetState, runDispose, stealData, stealQdata, thawNotify, unref, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAtContext, getBadgeNumber, getBounds, getChild, getData, getFirstAccessibleChild, getIconName, getName, getNeedsAttention, getNextAccessibleSibling, getPlatformState, getProperty, getQdata, getTitle, getUseUnderline, getVisible.

Setters

setAccessibleParent, setBadgeNumber, setData, setDataFull, setIconName, setName, setNeedsAttention, setProperty, setTitle, setUseUnderline, setVisible.

getBadgeNumber

viewStackPageGetBadgeNumber

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> m Word32

Returns: the badge number for this page

Gets the badge number for this page.

getChild

viewStackPageGetChild

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> m Widget

Returns: the child to which self belongs

Gets the stack child to which self belongs.

getIconName

viewStackPageGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> m (Maybe Text)

Returns: the icon name of the page

Gets the icon name of the page.

getName

viewStackPageGetName

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> m (Maybe Text)

Returns: the name of the page

Gets the name of the page.

getNeedsAttention

viewStackPageGetNeedsAttention

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> m Bool

Returns: whether the page needs attention

Gets whether the page requires the user attention.

getTitle

viewStackPageGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> m (Maybe Text)

Returns: the page title

Gets the page title.

getUseUnderline

viewStackPageGetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> m Bool

Returns: whether underlines in the page title indicate mnemonics

Gets whether underlines in the page title indicate mnemonics.

getVisible

viewStackPageGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> m Bool

Returns: whether self is visible

Gets whether self is visible in its AdwViewStack.

This is independent from the Widget:visible property of its widget.

setBadgeNumber

viewStackPageSetBadgeNumber

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> Word32

badgeNumber: the new value to set

-> m ()

Sets the badge number for this page.

classviewSwitcher

can display it as a badge next to the page icon. It is commonly used to display a number of unread items within the page.

It can be used together with [propertyviewStack{age}:needs-attention].

setIconName

viewStackPageSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> Maybe Text

iconName: the icon name

-> m ()

Sets the icon name of the page.

setName

viewStackPageSetName

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> Maybe Text

name: the page name

-> m ()

Sets the name of the page.

setNeedsAttention

viewStackPageSetNeedsAttention

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> Bool

needsAttention: the new value to set

-> m ()

Sets whether the page requires the user attention.

classviewSwitcher

will display it as a dot next to the page icon.

setTitle

viewStackPageSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> Maybe Text

title: the page title

-> m ()

Sets the page title.

setUseUnderline

viewStackPageSetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> Bool

useUnderline: the new value to set

-> m ()

Sets whether underlines in the page title indicate mnemonics.

setVisible

viewStackPageSetVisible

Arguments

:: (HasCallStack, MonadIO m, IsViewStackPage a)

=> a

self: a view stack page

-> Bool

visible: whether self is visible

-> m ()

Sets whether page is visible in its AdwViewStack.

This is independent from the Widget:visible property of [propertyviewStackPage:child].

Properties

badgeNumber

The badge number for this page.

classviewSwitcher

can display it as a badge next to the page icon. It is commonly used to display a number of unread items within the page.

It can be used together with [propertyviewStack{age}:needs-attention].

constructViewStackPageBadgeNumber :: (IsViewStackPage o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getViewStackPageBadgeNumber :: (MonadIO m, IsViewStackPage o) => o -> m Word32

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

get viewStackPage #badgeNumber

setViewStackPageBadgeNumber :: (MonadIO m, IsViewStackPage o) => o -> Word32 -> m ()

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

set viewStackPage [ #badgeNumber := value ]

child

The stack child to which the page belongs.

constructViewStackPageChild :: (IsViewStackPage 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.

getViewStackPageChild :: (MonadIO m, IsViewStackPage o) => o -> m Widget

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

get viewStackPage #child

iconName

The icon name of the child page.

clearViewStackPageIconName :: (MonadIO m, IsViewStackPage o) => o -> m ()

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

clear #iconName

constructViewStackPageIconName :: (IsViewStackPage o, MonadIO m) => Text -> m (GValueConstruct o)

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

getViewStackPageIconName :: (MonadIO m, IsViewStackPage o) => o -> m (Maybe Text)

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

get viewStackPage #iconName

setViewStackPageIconName :: (MonadIO m, IsViewStackPage o) => o -> Text -> m ()

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

set viewStackPage [ #iconName := value ]

name

The name of the child page.

clearViewStackPageName :: (MonadIO m, IsViewStackPage o) => o -> m ()

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

clear #name

constructViewStackPageName :: (IsViewStackPage 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.

getViewStackPageName :: (MonadIO m, IsViewStackPage o) => o -> m (Maybe Text)

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

get viewStackPage #name

setViewStackPageName :: (MonadIO m, IsViewStackPage o) => o -> Text -> m ()

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

set viewStackPage [ #name := value ]

needsAttention

Whether the page requires the user attention.

classviewSwitcher

will display it as a dot next to the page icon.

constructViewStackPageNeedsAttention :: (IsViewStackPage o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewStackPageNeedsAttention :: (MonadIO m, IsViewStackPage o) => o -> m Bool

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

get viewStackPage #needsAttention

setViewStackPageNeedsAttention :: (MonadIO m, IsViewStackPage o) => o -> Bool -> m ()

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

set viewStackPage [ #needsAttention := value ]

title

The title of the child page.

clearViewStackPageTitle :: (MonadIO m, IsViewStackPage o) => o -> m ()

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

clear #title

constructViewStackPageTitle :: (IsViewStackPage o, MonadIO m) => Text -> m (GValueConstruct o)

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

getViewStackPageTitle :: (MonadIO m, IsViewStackPage o) => o -> m (Maybe Text)

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

get viewStackPage #title

setViewStackPageTitle :: (MonadIO m, IsViewStackPage o) => o -> Text -> m ()

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

set viewStackPage [ #title := value ]

useUnderline

Whether an embedded underline in the title indicates a mnemonic.

constructViewStackPageUseUnderline :: (IsViewStackPage o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewStackPageUseUnderline :: (MonadIO m, IsViewStackPage o) => o -> m Bool

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

get viewStackPage #useUnderline

setViewStackPageUseUnderline :: (MonadIO m, IsViewStackPage o) => o -> Bool -> m ()

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

set viewStackPage [ #useUnderline := value ]

visible

Whether this page is visible.

This is independent from the Widget:visible property of [propertyviewStackPage:child].

constructViewStackPageVisible :: (IsViewStackPage o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getViewStackPageVisible :: (MonadIO m, IsViewStackPage o) => o -> m Bool

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

get viewStackPage #visible

setViewStackPageVisible :: (MonadIO m, IsViewStackPage o) => o -> Bool -> m ()

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

set viewStackPage [ #visible := value ]