GI.Adw.Objects.StatusPage

A page used for empty/error states and similar use-cases.

<picture> <source srcset="status-page-dark.png" media="(prefers-color-scheme: dark)"> <img src="status-page.png" alt="status-page"> </picture>

The AdwStatusPage widget can have an icon, a title, a description and a custom widget which is displayed below them.

CSS nodes

AdwStatusPage has a main CSS node with name statuspage.

AdwStatusPage can use the `.compact` style class for when it needs to fit into a small space such a sidebar or a popover.

Since: 1.0

Exported types

newtype StatusPage

Memory-managed wrapper type.

Constructors

StatusPage (ManagedPtr StatusPage)

Instances

Eq StatusPage

Defined in GI.Adw.Objects.StatusPage

Methods

(==) :: StatusPage -> StatusPage -> Bool

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

GObject StatusPage

Defined in GI.Adw.Objects.StatusPage

ManagedPtrNewtype StatusPage

Defined in GI.Adw.Objects.StatusPage

Methods

toManagedPtr :: StatusPage -> ManagedPtr StatusPage

TypedObject StatusPage

Defined in GI.Adw.Objects.StatusPage

Methods

glibType :: IO GType

HasParentTypes StatusPage

Defined in GI.Adw.Objects.StatusPage

IsGValue (Maybe StatusPage)

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

Defined in GI.Adw.Objects.StatusPage

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes StatusPage

Defined in GI.Adw.Objects.StatusPage

type ParentTypes StatusPage = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf StatusPage o) => IsStatusPage o

Type class for types which can be safely cast to StatusPage, for instance with toStatusPage.

Instances

(GObject o, IsDescendantOf StatusPage o) => IsStatusPage o

Defined in GI.Adw.Objects.StatusPage

toStatusPage :: (MonadIO m, IsStatusPage o) => o -> m StatusPage

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

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDescription, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getIconName, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPaintable, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDescription, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setIconName, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setPaintable, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTitle, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

getChild

statusPageGetChild

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> m (Maybe Widget)

Returns: the child widget of self

Gets the child widget of self.

Since: 1.0

getDescription

statusPageGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> m (Maybe Text)

Returns: the description

Gets the description for self.

Since: 1.0

getIconName

statusPageGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> m (Maybe Text)

Returns: the icon name

Gets the icon name for self.

Since: 1.0

getPaintable

statusPageGetPaintable

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> m (Maybe Paintable)

Returns: the paintable

Gets the paintable for self.

Since: 1.0

getTitle

statusPageGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> m Text

Returns: the title

Gets the title for self.

Since: 1.0

new

statusPageNew

Arguments

:: (HasCallStack, MonadIO m)

=> m StatusPage

Returns: the newly created AdwStatusPage

Creates a new AdwStatusPage.

Since: 1.0

setChild

statusPageSetChild

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a, IsWidget b)

=> a

self: a status page

-> Maybe b

child: the child widget

-> m ()

Sets the child widget of self.

Since: 1.0

setDescription

statusPageSetDescription

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> Maybe Text

description: the description

-> m ()

Sets the description for self.

The description is displayed below the title.

Since: 1.0

setIconName

statusPageSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> Maybe Text

iconName: the icon name

-> m ()

Sets the icon name for self.

Changing this will set [propertystatusPage:paintable] to NULL.

Since: 1.0

setPaintable

statusPageSetPaintable

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a, IsPaintable b)

=> a

self: a status page

-> Maybe b

paintable: the paintable

-> m ()

Sets the paintable for self.

Changing this will set [propertystatusPage:icon-name] to NULL.

Since: 1.0

setTitle

statusPageSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> Text

title: the title

-> m ()

Sets the title for self.

The title is displayed below the icon.

Since: 1.0

Properties

child

The child widget.

Since: 1.0

clearStatusPageChild :: (MonadIO m, IsStatusPage o) => o -> m ()

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

clear #child

constructStatusPageChild :: (IsStatusPage 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.

getStatusPageChild :: (MonadIO m, IsStatusPage o) => o -> m (Maybe Widget)

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

get statusPage #child

setStatusPageChild :: (MonadIO m, IsStatusPage o, IsWidget a) => o -> a -> m ()

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

set statusPage [ #child := value ]

description

The description to be displayed below the title.

Since: 1.0

clearStatusPageDescription :: (MonadIO m, IsStatusPage o) => o -> m ()

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

clear #description

constructStatusPageDescription :: (IsStatusPage o, MonadIO m) => Text -> m (GValueConstruct o)

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

getStatusPageDescription :: (MonadIO m, IsStatusPage o) => o -> m (Maybe Text)

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

get statusPage #description

setStatusPageDescription :: (MonadIO m, IsStatusPage o) => o -> Text -> m ()

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

set statusPage [ #description := value ]

iconName

The name of the icon to be used.

Changing this will set [propertystatusPage:paintable] to NULL.

Since: 1.0

clearStatusPageIconName :: (MonadIO m, IsStatusPage o) => o -> m ()

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

clear #iconName

constructStatusPageIconName :: (IsStatusPage 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.

getStatusPageIconName :: (MonadIO m, IsStatusPage o) => o -> m (Maybe Text)

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

get statusPage #iconName

setStatusPageIconName :: (MonadIO m, IsStatusPage o) => o -> Text -> m ()

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

set statusPage [ #iconName := value ]

paintable

The paintable to be used.

Changing this will set [propertystatusPage:icon-name] to NULL.

Since: 1.0

clearStatusPagePaintable :: (MonadIO m, IsStatusPage o) => o -> m ()

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

clear #paintable

constructStatusPagePaintable :: (IsStatusPage o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o)

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

getStatusPagePaintable :: (MonadIO m, IsStatusPage o) => o -> m (Maybe Paintable)

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

get statusPage #paintable

setStatusPagePaintable :: (MonadIO m, IsStatusPage o, IsPaintable a) => o -> a -> m ()

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

set statusPage [ #paintable := value ]

title

The title to be displayed below the icon.

Since: 1.0

constructStatusPageTitle :: (IsStatusPage 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.

getStatusPageTitle :: (MonadIO m, IsStatusPage o) => o -> m Text

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

get statusPage #title

setStatusPageTitle :: (MonadIO m, IsStatusPage o) => o -> Text -> m ()

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

set statusPage [ #title := value ]