GI.Handy.Objects.StatusPage

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

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

CSS nodes

HdyStatusPage has a main CSS node with name statuspage.

Since: 1.2

Exported types

newtype StatusPage

Memory-managed wrapper type.

Constructors

StatusPage (ManagedPtr StatusPage)

Instances

Eq StatusPage

Defined in GI.Handy.Objects.StatusPage

Methods

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

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

GObject StatusPage

Defined in GI.Handy.Objects.StatusPage

ManagedPtrNewtype StatusPage

Defined in GI.Handy.Objects.StatusPage

Methods

toManagedPtr :: StatusPage -> ManagedPtr StatusPage

TypedObject StatusPage

Defined in GI.Handy.Objects.StatusPage

Methods

glibType :: IO GType

HasParentTypes StatusPage

Defined in GI.Handy.Objects.StatusPage

IsGValue (Maybe StatusPage)

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

Defined in GI.Handy.Objects.StatusPage

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes StatusPage

Defined in GI.Handy.Objects.StatusPage

type ParentTypes StatusPage = '[Bin, Container, Widget, Object, ImplementorIface, Buildable]

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.Handy.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

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

Getters

getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDescription, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getIconName, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

Setters

setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDescription, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setIconName, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

getDescription

statusPageGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> m (Maybe Text)

Returns: the description for self

Gets the description for self.

Since: 1.2

getIconName

statusPageGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> m (Maybe Text)

Returns: the icon name for self

Gets the icon name for self.

Since: 1.2

getTitle

statusPageGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> m (Maybe Text)

Returns: the title for self

Gets the title for self.

Since: 1.2

new

statusPageNew

Arguments

:: (HasCallStack, MonadIO m)

=> m StatusPage

Returns: the newly created HdyStatusPage

Creates a new HdyStatusPage.

Since: 1.2

setDescription

statusPageSetDescription

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> Maybe Text

description: the description

-> m ()

Sets the description for self.

Since: 1.2

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.

Since: 1.2

setTitle

statusPageSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsStatusPage a)

=> a

self: a status page

-> Maybe Text

title: the title

-> m ()

Sets the title for self.

Since: 1.2

Properties

description

The description to be displayed below the title.

Since: 1.2

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.

Since: 1.2

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 ]

title

The title to be displayed below the icon.

Since: 1.2

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

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

clear #title

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 (Maybe 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 ]