GI.Adw.Objects.ExpanderRow

A ListBoxRow used to reveal widgets.

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

The AdwExpanderRow widget allows the user to reveal or hide widgets below it. It also allows the user to enable the expansion of the row, allowing to disable all that the row contains.

AdwExpanderRow as GtkBuildable

The AdwExpanderRow implementation of the Buildable interface supports adding a child as an action widget by specifying “action” as the “type” attribute of a <child> element.

It also supports adding it as a prefix widget by specifying “prefix” as the “type” attribute of a <child> element.

CSS nodes

AdwExpanderRow has a main CSS node with name row and the .expander style class. It has the .empty style class when it contains no children.

It contains the subnodes row.header for its main embedded row, list.nested for the list it can expand, and image.expander-row-arrow for its arrow.

Since: 1.0

Exported types

newtype ExpanderRow

Memory-managed wrapper type.

Constructors

ExpanderRow (ManagedPtr ExpanderRow)

Instances

Eq ExpanderRow

Defined in GI.Adw.Objects.ExpanderRow

Methods

(==) :: ExpanderRow -> ExpanderRow -> Bool

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

GObject ExpanderRow

Defined in GI.Adw.Objects.ExpanderRow

ManagedPtrNewtype ExpanderRow

Defined in GI.Adw.Objects.ExpanderRow

Methods

toManagedPtr :: ExpanderRow -> ManagedPtr ExpanderRow

TypedObject ExpanderRow

Defined in GI.Adw.Objects.ExpanderRow

Methods

glibType :: IO GType

HasParentTypes ExpanderRow

Defined in GI.Adw.Objects.ExpanderRow

IsGValue (Maybe ExpanderRow)

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

Defined in GI.Adw.Objects.ExpanderRow

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ExpanderRow

Defined in GI.Adw.Objects.ExpanderRow

type ParentTypes ExpanderRow = '[PreferencesRow, ListBoxRow, Widget, Object, Accessible, Actionable, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf ExpanderRow o) => IsExpanderRow o

Type class for types which can be safely cast to ExpanderRow, for instance with toExpanderRow.

Instances

(GObject o, IsDescendantOf ExpanderRow o) => IsExpanderRow o

Defined in GI.Adw.Objects.ExpanderRow

toExpanderRow :: (MonadIO m, IsExpanderRow o) => o -> m ExpanderRow

Cast to ExpanderRow, 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, addAction, addController, addCssClass, addMnemonicLabel, addPrefix, addRow, addTickCallback, allocate, bindProperty, bindPropertyFull, changed, 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, isSelected, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, remove, 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, getActionName, getActionTargetValue, getActivatable, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getEnableExpansion, getExpanded, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeader, getHeight, getHexpand, getHexpandSet, getIconName, getIndex, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSelectable, getSensitive, getSettings, getShowEnableSwitch, getSize, getSizeRequest, getStateFlags, getStyleContext, getSubtitle, getTemplateChild, getTitle, getTitleSelectable, getTooltipMarkup, getTooltipText, getUseMarkup, getUseUnderline, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setActionName, setActionTargetValue, setActivatable, setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDetailedActionName, setDirection, setEnableExpansion, setExpanded, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHeader, setHexpand, setHexpandSet, setIconName, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSelectable, setSensitive, setShowEnableSwitch, setSizeRequest, setStateFlags, setSubtitle, setTitle, setTitleSelectable, setTooltipMarkup, setTooltipText, setUseMarkup, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible.

addAction

expanderRowAddAction

Arguments

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

=> a

self: an expander row

-> b

widget: a widget

-> m ()

Adds an action widget to self.

Since: 1.0

addPrefix

expanderRowAddPrefix

Arguments

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

=> a

self: an expander row

-> b

widget: a widget

-> m ()

Adds a prefix widget to self.

Since: 1.0

addRow

expanderRowAddRow

Arguments

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

=> a

self: an expander row

-> b

child: a widget

-> m ()

Adds a widget to self.

The widget will appear in the expanding list below self.

Since: 1.0

getEnableExpansion

expanderRowGetEnableExpansion

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> m Bool

Returns: whether the expansion of self is enabled.

Gets whether the expansion of self is enabled.

Since: 1.0

getExpanded

expanderRowGetExpanded

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> m Bool

Returns: whether self is expanded

Gets whether self is expanded.

Since: 1.0

getIconName

expanderRowGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> m (Maybe Text)

Returns: the icon name for self

Gets the icon name for self.

Since: 1.0

getShowEnableSwitch

expanderRowGetShowEnableSwitch

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> m Bool

Returns: whether the switch enabling the expansion is visible

Gets whether the switch enabling the expansion of self is visible.

Since: 1.0

getSubtitle

expanderRowGetSubtitle

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> m Text

Returns: the subtitle for self

Gets the subtitle for self.

Since: 1.0

new

expanderRowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ExpanderRow

Returns: the newly created AdwExpanderRow

Creates a new AdwExpanderRow.

Since: 1.0

remove

expanderRowRemove :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) => a -> b -> m ()

No description available in the introspection data.

setEnableExpansion

expanderRowSetEnableExpansion

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> Bool

enableExpansion: whether to enable the expansion

-> m ()

Sets whether the expansion of self is enabled.

Since: 1.0

setExpanded

expanderRowSetExpanded

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> Bool

expanded: whether to expand the row

-> m ()

Sets whether self is expanded.

Since: 1.0

setIconName

expanderRowSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> Maybe Text

iconName: the icon name

-> m ()

Sets the icon name for self.

Since: 1.0

setShowEnableSwitch

expanderRowSetShowEnableSwitch

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> Bool

showEnableSwitch: whether to show the switch enabling the expansion

-> m ()

Sets whether the switch enabling the expansion of self is visible.

Since: 1.0

setSubtitle

expanderRowSetSubtitle

Arguments

:: (HasCallStack, MonadIO m, IsExpanderRow a)

=> a

self: an expander row

-> Text

subtitle: the subtitle

-> m ()

Sets the subtitle for self.

The subtitle is interpreted as Pango markup unless [propertypreferencesRow:use-markup] is set to FALSE.

Since: 1.0

Properties

enableExpansion

Whether expansion is enabled.

Since: 1.0

constructExpanderRowEnableExpansion :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getExpanderRowEnableExpansion :: (MonadIO m, IsExpanderRow o) => o -> m Bool

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

get expanderRow #enableExpansion

setExpanderRowEnableExpansion :: (MonadIO m, IsExpanderRow o) => o -> Bool -> m ()

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

set expanderRow [ #enableExpansion := value ]

expanded

Whether the row is expanded.

Since: 1.0

constructExpanderRowExpanded :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getExpanderRowExpanded :: (MonadIO m, IsExpanderRow o) => o -> m Bool

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

get expanderRow #expanded

setExpanderRowExpanded :: (MonadIO m, IsExpanderRow o) => o -> Bool -> m ()

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

set expanderRow [ #expanded := value ]

iconName

The icon name for this row.

Since: 1.0

clearExpanderRowIconName :: (MonadIO m, IsExpanderRow o) => o -> m ()

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

clear #iconName

constructExpanderRowIconName :: (IsExpanderRow 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.

getExpanderRowIconName :: (MonadIO m, IsExpanderRow o) => o -> m (Maybe Text)

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

get expanderRow #iconName

setExpanderRowIconName :: (MonadIO m, IsExpanderRow o) => o -> Text -> m ()

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

set expanderRow [ #iconName := value ]

showEnableSwitch

Whether the switch enabling the expansion is visible.

Since: 1.0

constructExpanderRowShowEnableSwitch :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getExpanderRowShowEnableSwitch :: (MonadIO m, IsExpanderRow o) => o -> m Bool

Get the value of the “show-enable-switch” property. When overloading is enabled, this is equivalent to

get expanderRow #showEnableSwitch

setExpanderRowShowEnableSwitch :: (MonadIO m, IsExpanderRow o) => o -> Bool -> m ()

Set the value of the “show-enable-switch” property. When overloading is enabled, this is equivalent to

set expanderRow [ #showEnableSwitch := value ]

subtitle

The subtitle for this row.

The subtitle is interpreted as Pango markup unless [propertypreferencesRow:use-markup] is set to FALSE.

Since: 1.0

constructExpanderRowSubtitle :: (IsExpanderRow o, MonadIO m) => Text -> m (GValueConstruct o)

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

getExpanderRowSubtitle :: (MonadIO m, IsExpanderRow o) => o -> m Text

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

get expanderRow #subtitle

setExpanderRowSubtitle :: (MonadIO m, IsExpanderRow o) => o -> Text -> m ()

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

set expanderRow [ #subtitle := value ]