| 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 |
GI.Adw.Objects.ExpanderRow
Contents
Description
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.
Synopsis
- newtype ExpanderRow = ExpanderRow (ManagedPtr ExpanderRow)
- class (GObject o, IsDescendantOf ExpanderRow o) => IsExpanderRow o
- toExpanderRow :: (MonadIO m, IsExpanderRow o) => o -> m ExpanderRow
- expanderRowAddAction :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) => a -> b -> m ()
- expanderRowAddPrefix :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) => a -> b -> m ()
- expanderRowAddRow :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) => a -> b -> m ()
- expanderRowGetEnableExpansion :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Bool
- expanderRowGetExpanded :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Bool
- expanderRowGetIconName :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m (Maybe Text)
- expanderRowGetShowEnableSwitch :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Bool
- expanderRowGetSubtitle :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Text
- expanderRowGetSubtitleLines :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Bool
- expanderRowGetTitleLines :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Bool
- expanderRowNew :: (HasCallStack, MonadIO m) => m ExpanderRow
- expanderRowRemove :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) => a -> b -> m ()
- expanderRowSetEnableExpansion :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Bool -> m ()
- expanderRowSetExpanded :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Bool -> m ()
- expanderRowSetIconName :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Maybe Text -> m ()
- expanderRowSetShowEnableSwitch :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Bool -> m ()
- expanderRowSetSubtitle :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Text -> m ()
- expanderRowSetSubtitleLines :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Int32 -> m ()
- expanderRowSetTitleLines :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Int32 -> m ()
- constructExpanderRowEnableExpansion :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getExpanderRowEnableExpansion :: (MonadIO m, IsExpanderRow o) => o -> m Bool
- setExpanderRowEnableExpansion :: (MonadIO m, IsExpanderRow o) => o -> Bool -> m ()
- constructExpanderRowExpanded :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getExpanderRowExpanded :: (MonadIO m, IsExpanderRow o) => o -> m Bool
- setExpanderRowExpanded :: (MonadIO m, IsExpanderRow o) => o -> Bool -> m ()
- clearExpanderRowIconName :: (MonadIO m, IsExpanderRow o) => o -> m ()
- constructExpanderRowIconName :: (IsExpanderRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getExpanderRowIconName :: (MonadIO m, IsExpanderRow o) => o -> m (Maybe Text)
- setExpanderRowIconName :: (MonadIO m, IsExpanderRow o) => o -> Text -> m ()
- constructExpanderRowShowEnableSwitch :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getExpanderRowShowEnableSwitch :: (MonadIO m, IsExpanderRow o) => o -> m Bool
- setExpanderRowShowEnableSwitch :: (MonadIO m, IsExpanderRow o) => o -> Bool -> m ()
- constructExpanderRowSubtitle :: (IsExpanderRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getExpanderRowSubtitle :: (MonadIO m, IsExpanderRow o) => o -> m Text
- setExpanderRowSubtitle :: (MonadIO m, IsExpanderRow o) => o -> Text -> m ()
- constructExpanderRowSubtitleLines :: (IsExpanderRow o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getExpanderRowSubtitleLines :: (MonadIO m, IsExpanderRow o) => o -> m Int32
- setExpanderRowSubtitleLines :: (MonadIO m, IsExpanderRow o) => o -> Int32 -> m ()
- constructExpanderRowTitleLines :: (IsExpanderRow o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getExpanderRowTitleLines :: (MonadIO m, IsExpanderRow o) => o -> m Int32
- setExpanderRowTitleLines :: (MonadIO m, IsExpanderRow o) => o -> Int32 -> m ()
Exported types
newtype ExpanderRow Source #
Memory-managed wrapper type.
Constructors
| ExpanderRow (ManagedPtr ExpanderRow) |
Instances
| Eq ExpanderRow Source # | |
Defined in GI.Adw.Objects.ExpanderRow | |
| GObject ExpanderRow Source # | |
Defined in GI.Adw.Objects.ExpanderRow | |
| ManagedPtrNewtype ExpanderRow Source # | |
Defined in GI.Adw.Objects.ExpanderRow Methods toManagedPtr :: ExpanderRow -> ManagedPtr ExpanderRow | |
| TypedObject ExpanderRow Source # | |
Defined in GI.Adw.Objects.ExpanderRow | |
| HasParentTypes ExpanderRow Source # | |
Defined in GI.Adw.Objects.ExpanderRow | |
| IsGValue (Maybe ExpanderRow) Source # | Convert |
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 Source # | |
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 Source #
Type class for types which can be safely cast to ExpanderRow, for instance with toExpanderRow.
Instances
| (GObject o, IsDescendantOf ExpanderRow o) => IsExpanderRow o Source # | |
Defined in GI.Adw.Objects.ExpanderRow | |
toExpanderRow :: (MonadIO m, IsExpanderRow o) => o -> m ExpanderRow Source #
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, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getActionName, getActionTargetValue, getActivatable, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBounds, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getEnableExpansion, getExpanded, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeader, getHeight, getHexpand, getHexpandSet, getIconName, getIndex, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSelectable, getSensitive, getSettings, getShowEnableSwitch, getSize, getSizeRequest, getStateFlags, getStyleContext, getSubtitle, getSubtitleLines, getTemplateChild, getTitle, getTitleLines, getTitleSelectable, getTooltipMarkup, getTooltipText, getUseMarkup, getUseUnderline, getValign, getVexpand, getVexpandSet, getVisible, getWidth.
Setters
setAccessibleParent, 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, setSubtitleLines, setTitle, setTitleLines, setTitleSelectable, setTooltipMarkup, setTooltipText, setUseMarkup, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible.
addAction
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) | |
| => a |
|
| -> b |
|
| -> m () |
Adds an action widget to self.
addPrefix
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) | |
| => a |
|
| -> b |
|
| -> m () |
Adds a prefix widget to self.
addRow
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) | |
| => a |
|
| -> b |
|
| -> m () |
Adds a widget to self.
The widget will appear in the expanding list below self.
getEnableExpansion
expanderRowGetEnableExpansion Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> m Bool | Returns: whether the expansion of |
Gets whether the expansion of self is enabled.
getExpanded
expanderRowGetExpanded Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> m Bool | Returns: whether |
Gets whether self is expanded.
getIconName
expanderRowGetIconName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> m (Maybe Text) | Returns: the icon name for |
Deprecated: (Since version 1.3)Use [methodexpanderRow.add_prefix] to add an icon.
Gets the icon name for self.
getShowEnableSwitch
expanderRowGetShowEnableSwitch Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> m Bool | Returns: whether the switch enabling the expansion is visible |
Gets whether the switch enabling the expansion of self is visible.
getSubtitle
expanderRowGetSubtitle Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> m Text | Returns: the subtitle for |
Gets the subtitle for self.
getSubtitleLines
expanderRowGetSubtitleLines Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> m Bool | Returns: the number of lines at the end of which the subtitle label will be ellipsized |
Gets the number of lines at the end of which the subtitle label will be ellipsized.
Since: 1.3
getTitleLines
expanderRowGetTitleLines Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> m Bool | Returns: the number of lines at the end of which the title label will be ellipsized |
Gets the number of lines at the end of which the title label will be ellipsized.
Since: 1.3
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m ExpanderRow | Returns: the newly created |
Creates a new AdwExpanderRow.
remove
expanderRowRemove :: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) => a -> b -> m () Source #
No description available in the introspection data.
setEnableExpansion
expanderRowSetEnableExpansion Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the expansion of self is enabled.
setExpanded
expanderRowSetExpanded Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether self is expanded.
setIconName
expanderRowSetIconName Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Deprecated: (Since version 1.3)Use [methodexpanderRow.add_prefix] to add an icon.
Sets the icon name for self.
setShowEnableSwitch
expanderRowSetShowEnableSwitch Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the switch enabling the expansion of self is visible.
setSubtitle
expanderRowSetSubtitle Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> Text |
|
| -> m () |
Sets the subtitle for self.
The subtitle is interpreted as Pango markup unless
[propertypreferencesRow:use-markup] is set to FALSE.
setSubtitleLines
expanderRowSetSubtitleLines Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> Int32 |
|
| -> m () |
Sets the number of lines at the end of which the subtitle label will be ellipsized.
If the value is 0, the number of lines won't be limited.
Since: 1.3
setTitleLines
expanderRowSetTitleLines Source #
Arguments
| :: (HasCallStack, MonadIO m, IsExpanderRow a) | |
| => a |
|
| -> Int32 |
|
| -> m () |
Sets the number of lines at the end of which the title label will be ellipsized.
If the value is 0, the number of lines won't be limited.
Since: 1.3
Properties
enableExpansion
Whether expansion is enabled.
constructExpanderRowEnableExpansion :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “enable-expansion” property.
When overloading is enabled, this is equivalent to
setexpanderRow [ #enableExpansion:=value ]
expanded
Whether the row is expanded.
constructExpanderRowExpanded :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “expanded” property.
When overloading is enabled, this is equivalent to
setexpanderRow [ #expanded:=value ]
iconName
The icon name for this row.
clearExpanderRowIconName :: (MonadIO m, IsExpanderRow o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
Set the value of the “icon-name” property.
When overloading is enabled, this is equivalent to
setexpanderRow [ #iconName:=value ]
showEnableSwitch
Whether the switch enabling the expansion is visible.
constructExpanderRowShowEnableSwitch :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “show-enable-switch” property.
When overloading is enabled, this is equivalent to
setexpanderRow [ #showEnableSwitch:=value ]
subtitle
The subtitle for this row.
The subtitle is interpreted as Pango markup unless
[propertypreferencesRow:use-markup] is set to FALSE.
constructExpanderRowSubtitle :: (IsExpanderRow o, MonadIO m) => Text -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “subtitle” property.
When overloading is enabled, this is equivalent to
setexpanderRow [ #subtitle:=value ]
subtitleLines
The number of lines at the end of which the subtitle label will be ellipsized.
If the value is 0, the number of lines won't be limited.
Since: 1.3
constructExpanderRowSubtitleLines :: (IsExpanderRow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “subtitle-lines” property. This is rarely needed directly, but it is used by new.
getExpanderRowSubtitleLines :: (MonadIO m, IsExpanderRow o) => o -> m Int32 Source #
Get the value of the “subtitle-lines” property.
When overloading is enabled, this is equivalent to
get expanderRow #subtitleLines
setExpanderRowSubtitleLines :: (MonadIO m, IsExpanderRow o) => o -> Int32 -> m () Source #
Set the value of the “subtitle-lines” property.
When overloading is enabled, this is equivalent to
setexpanderRow [ #subtitleLines:=value ]
titleLines
The number of lines at the end of which the title label will be ellipsized.
If the value is 0, the number of lines won't be limited.
Since: 1.3
constructExpanderRowTitleLines :: (IsExpanderRow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “title-lines” property. This is rarely needed directly, but it is used by new.
getExpanderRowTitleLines :: (MonadIO m, IsExpanderRow o) => o -> m Int32 Source #
Get the value of the “title-lines” property.
When overloading is enabled, this is equivalent to
get expanderRow #titleLines
setExpanderRowTitleLines :: (MonadIO m, IsExpanderRow o) => o -> Int32 -> m () Source #
Set the value of the “title-lines” property.
When overloading is enabled, this is equivalent to
setexpanderRow [ #titleLines:=value ]