Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- newtype StatusPage = StatusPage (ManagedPtr StatusPage)
- class (GObject o, IsDescendantOf StatusPage o) => IsStatusPage o
- toStatusPage :: (MonadIO m, IsStatusPage o) => o -> m StatusPage
- statusPageGetChild :: (HasCallStack, MonadIO m, IsStatusPage a) => a -> m (Maybe Widget)
- statusPageGetDescription :: (HasCallStack, MonadIO m, IsStatusPage a) => a -> m (Maybe Text)
- statusPageGetIconName :: (HasCallStack, MonadIO m, IsStatusPage a) => a -> m (Maybe Text)
- statusPageGetPaintable :: (HasCallStack, MonadIO m, IsStatusPage a) => a -> m (Maybe Paintable)
- statusPageGetTitle :: (HasCallStack, MonadIO m, IsStatusPage a) => a -> m Text
- statusPageNew :: (HasCallStack, MonadIO m) => m StatusPage
- statusPageSetChild :: (HasCallStack, MonadIO m, IsStatusPage a, IsWidget b) => a -> Maybe b -> m ()
- statusPageSetDescription :: (HasCallStack, MonadIO m, IsStatusPage a) => a -> Maybe Text -> m ()
- statusPageSetIconName :: (HasCallStack, MonadIO m, IsStatusPage a) => a -> Maybe Text -> m ()
- statusPageSetPaintable :: (HasCallStack, MonadIO m, IsStatusPage a, IsPaintable b) => a -> Maybe b -> m ()
- statusPageSetTitle :: (HasCallStack, MonadIO m, IsStatusPage a) => a -> Text -> m ()
- clearStatusPageChild :: (MonadIO m, IsStatusPage o) => o -> m ()
- constructStatusPageChild :: (IsStatusPage o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getStatusPageChild :: (MonadIO m, IsStatusPage o) => o -> m (Maybe Widget)
- setStatusPageChild :: (MonadIO m, IsStatusPage o, IsWidget a) => o -> a -> m ()
- clearStatusPageDescription :: (MonadIO m, IsStatusPage o) => o -> m ()
- constructStatusPageDescription :: (IsStatusPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getStatusPageDescription :: (MonadIO m, IsStatusPage o) => o -> m (Maybe Text)
- setStatusPageDescription :: (MonadIO m, IsStatusPage o) => o -> Text -> m ()
- clearStatusPageIconName :: (MonadIO m, IsStatusPage o) => o -> m ()
- constructStatusPageIconName :: (IsStatusPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getStatusPageIconName :: (MonadIO m, IsStatusPage o) => o -> m (Maybe Text)
- setStatusPageIconName :: (MonadIO m, IsStatusPage o) => o -> Text -> m ()
- clearStatusPagePaintable :: (MonadIO m, IsStatusPage o) => o -> m ()
- constructStatusPagePaintable :: (IsStatusPage o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o)
- getStatusPagePaintable :: (MonadIO m, IsStatusPage o) => o -> m (Maybe Paintable)
- setStatusPagePaintable :: (MonadIO m, IsStatusPage o, IsPaintable a) => o -> a -> m ()
- constructStatusPageTitle :: (IsStatusPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getStatusPageTitle :: (MonadIO m, IsStatusPage o) => o -> m Text
- setStatusPageTitle :: (MonadIO m, IsStatusPage o) => o -> Text -> m ()
Exported types
newtype StatusPage Source #
Memory-managed wrapper type.
StatusPage (ManagedPtr StatusPage) |
Instances
Eq StatusPage Source # | |
Defined in GI.Adw.Objects.StatusPage (==) :: StatusPage -> StatusPage -> Bool # (/=) :: StatusPage -> StatusPage -> Bool # | |
GObject StatusPage Source # | |
Defined in GI.Adw.Objects.StatusPage | |
ManagedPtrNewtype StatusPage Source # | |
Defined in GI.Adw.Objects.StatusPage toManagedPtr :: StatusPage -> ManagedPtr StatusPage | |
TypedObject StatusPage Source # | |
Defined in GI.Adw.Objects.StatusPage | |
HasParentTypes StatusPage Source # | |
Defined in GI.Adw.Objects.StatusPage | |
IsGValue (Maybe StatusPage) Source # | Convert |
Defined in GI.Adw.Objects.StatusPage gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe StatusPage -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe StatusPage) | |
type ParentTypes StatusPage Source # | |
Defined in GI.Adw.Objects.StatusPage type ParentTypes StatusPage = '[Widget, Object, Accessible, Buildable, ConstraintTarget] |
class (GObject o, IsDescendantOf StatusPage o) => IsStatusPage o Source #
Type class for types which can be safely cast to StatusPage
, for instance with toStatusPage
.
Instances
(GObject o, IsDescendantOf StatusPage o) => IsStatusPage o Source # | |
Defined in GI.Adw.Objects.StatusPage |
toStatusPage :: (MonadIO m, IsStatusPage o) => o -> m StatusPage Source #
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, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBounds, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDescription, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getIconName, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPaintable, getPangoContext, getParent, getPlatformState, 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
setAccessibleParent, 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
:: (HasCallStack, MonadIO m, IsStatusPage a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the child widget of |
Gets the child widget of self
.
getDescription
statusPageGetDescription Source #
:: (HasCallStack, MonadIO m, IsStatusPage a) | |
=> a |
|
-> m (Maybe Text) | Returns: the description |
Gets the description for self
.
getIconName
statusPageGetIconName Source #
:: (HasCallStack, MonadIO m, IsStatusPage a) | |
=> a |
|
-> m (Maybe Text) | Returns: the icon name |
Gets the icon name for self
.
getPaintable
statusPageGetPaintable Source #
:: (HasCallStack, MonadIO m, IsStatusPage a) | |
=> a |
|
-> m (Maybe Paintable) | Returns: the paintable |
Gets the paintable for self
.
getTitle
:: (HasCallStack, MonadIO m, IsStatusPage a) | |
=> a |
|
-> m Text | Returns: the title |
Gets the title for self
.
new
:: (HasCallStack, MonadIO m) | |
=> m StatusPage | Returns: the newly created |
Creates a new AdwStatusPage
.
setChild
:: (HasCallStack, MonadIO m, IsStatusPage a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the child widget of self
.
setDescription
statusPageSetDescription Source #
:: (HasCallStack, MonadIO m, IsStatusPage a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the description for self
.
The description is displayed below the title.
setIconName
statusPageSetIconName Source #
:: (HasCallStack, MonadIO m, IsStatusPage a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the icon name for self
.
Changing this will set [propertystatusPage
:paintable] to NULL
.
setPaintable
statusPageSetPaintable Source #
:: (HasCallStack, MonadIO m, IsStatusPage a, IsPaintable b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the paintable for self
.
Changing this will set [propertystatusPage
:icon-name] to NULL
.
setTitle
:: (HasCallStack, MonadIO m, IsStatusPage a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the title for self
.
The title is displayed below the icon.
Properties
child
The child widget.
clearStatusPageChild :: (MonadIO m, IsStatusPage o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
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.
clearStatusPageDescription :: (MonadIO m, IsStatusPage o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
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
.
clearStatusPageIconName :: (MonadIO m, IsStatusPage o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
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
.
clearStatusPagePaintable :: (MonadIO m, IsStatusPage o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
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.
constructStatusPageTitle :: (IsStatusPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “title
” property.
When overloading is enabled, this is equivalent to
set
statusPage [ #title:=
value ]