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 ListBoxRow
used to reveal widgets.
The HdyExpanderRow
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.
HdyExpanderRow as GtkBuildable
The HdyExpanderRow
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
HdyExpanderRow
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.
When expanded, HdyExpanderRow
will add the
.checked-expander-row-previous-sibling
style class to its previous sibling,
and remove it when retracted.
Since: 1.0
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 ()
- 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 Text
- expanderRowGetShowEnableSwitch :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Bool
- expanderRowGetSubtitle :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m (Maybe Text)
- expanderRowGetUseUnderline :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Bool
- expanderRowNew :: (HasCallStack, MonadIO m) => m ExpanderRow
- 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 -> Text -> m ()
- expanderRowSetShowEnableSwitch :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Bool -> m ()
- expanderRowSetSubtitle :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Maybe Text -> m ()
- expanderRowSetUseUnderline :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Bool -> 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 ()
- constructExpanderRowIconName :: (IsExpanderRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getExpanderRowIconName :: (MonadIO m, IsExpanderRow o) => o -> m 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 ()
- clearExpanderRowSubtitle :: (MonadIO m, IsExpanderRow o) => o -> m ()
- constructExpanderRowSubtitle :: (IsExpanderRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getExpanderRowSubtitle :: (MonadIO m, IsExpanderRow o) => o -> m (Maybe Text)
- setExpanderRowSubtitle :: (MonadIO m, IsExpanderRow o) => o -> Text -> m ()
- constructExpanderRowUseUnderline :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getExpanderRowUseUnderline :: (MonadIO m, IsExpanderRow o) => o -> m Bool
- setExpanderRowUseUnderline :: (MonadIO m, IsExpanderRow o) => o -> Bool -> m ()
Exported types
newtype ExpanderRow Source #
Memory-managed wrapper type.
ExpanderRow (ManagedPtr ExpanderRow) |
Instances
Eq ExpanderRow Source # | |
Defined in GI.Handy.Objects.ExpanderRow (==) :: ExpanderRow -> ExpanderRow -> Bool # (/=) :: ExpanderRow -> ExpanderRow -> Bool # | |
GObject ExpanderRow Source # | |
Defined in GI.Handy.Objects.ExpanderRow | |
ManagedPtrNewtype ExpanderRow Source # | |
Defined in GI.Handy.Objects.ExpanderRow toManagedPtr :: ExpanderRow -> ManagedPtr ExpanderRow | |
TypedObject ExpanderRow Source # | |
Defined in GI.Handy.Objects.ExpanderRow | |
HasParentTypes ExpanderRow Source # | |
Defined in GI.Handy.Objects.ExpanderRow | |
IsGValue (Maybe ExpanderRow) Source # | Convert |
Defined in GI.Handy.Objects.ExpanderRow gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ExpanderRow -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ExpanderRow) | |
type ParentTypes ExpanderRow Source # | |
Defined in GI.Handy.Objects.ExpanderRow type ParentTypes ExpanderRow = '[PreferencesRow, ListBoxRow, Bin, Container, Widget, Object, ImplementorIface, Actionable, Buildable] |
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.Handy.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
activate, add, addAccelerator, addAction, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addPrefix, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, changed, 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, isSelected, 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, getActionName, getActionTargetValue, getActivatable, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEnableExpansion, getEvents, getExpanded, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHeader, getHexpand, getHexpandSet, getIconName, getIndex, 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, getSelectable, getSensitive, getSettings, getShowEnableSwitch, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSubtitle, getSupportMultidevice, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseUnderline, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.
Setters
setAccelPath, setActionName, setActionTargetValue, setActivatable, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDetailedActionName, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEnableExpansion, setEvents, setExpanded, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHeader, setHexpand, setHexpandSet, setIconName, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSelectable, setSensitive, setShowEnableSwitch, setSizeRequest, setState, setStateFlags, setStyle, setSubtitle, setSupportMultidevice, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
addAction
:: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Adds an action widget to self
.
Since: 1.0
addPrefix
:: (HasCallStack, MonadIO m, IsExpanderRow a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Adds a prefix widget to self
.
Since: 1.0
getEnableExpansion
expanderRowGetEnableExpansion Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> m Bool | Returns: whether the expansion of |
Gets whether the expansion of self
is enabled.
Since: 1.0
getExpanded
expanderRowGetExpanded :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> m Bool Source #
No description available in the introspection data.
getIconName
expanderRowGetIconName Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> m Text | Returns: the icon name for |
Gets the icon name for self
.
Since: 1.0
getShowEnableSwitch
expanderRowGetShowEnableSwitch Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> m Bool | Returns: whether the switch enabling the expansion of |
Gets whether the switch enabling the expansion of self
is visible.
Since: 1.0
getSubtitle
expanderRowGetSubtitle Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> m (Maybe Text) | Returns: the subtitle for |
Gets the subtitle for self
.
Since: 1.0
getUseUnderline
expanderRowGetUseUnderline Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> m Bool | Returns: whether an embedded underlines indicates a mnemonic |
Gets whether an embedded underline in the title or subtitle labels indicates a mnemonic.
Since: 1.0
new
:: (HasCallStack, MonadIO m) | |
=> m ExpanderRow | Returns: the newly created |
Creates a new HdyExpanderRow
.
Since: 1.0
setEnableExpansion
expanderRowSetEnableExpansion Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the expansion of self
is enabled.
Since: 1.0
setExpanded
expanderRowSetExpanded :: (HasCallStack, MonadIO m, IsExpanderRow a) => a -> Bool -> m () Source #
No description available in the introspection data.
setIconName
expanderRowSetIconName Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the icon name for self
.
Since: 1.0
setShowEnableSwitch
expanderRowSetShowEnableSwitch Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the switch enabling the expansion of self
is visible.
Since: 1.0
setSubtitle
expanderRowSetSubtitle Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the subtitle for self
.
Since: 1.0
setUseUnderline
expanderRowSetUseUnderline Source #
:: (HasCallStack, MonadIO m, IsExpanderRow a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether an embedded underline in the title or subtitle labels indicates a mnemonic.
Since: 1.0
Properties
enableExpansion
Whether expansion is enabled.
Since: 1.0
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
set
expanderRow [ #enableExpansion:=
value ]
expanded
Whether the row is expanded.
Since: 1.0
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
set
expanderRow [ #expanded:=
value ]
iconName
The icon name for this row.
Since: 1.0
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 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
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) 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
set
expanderRow [ #showEnableSwitch:=
value ]
subtitle
The subtitle for this row.
Since: 1.0
clearExpanderRowSubtitle :: (MonadIO m, IsExpanderRow o) => o -> m () Source #
Set the value of the “subtitle
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#subtitle
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 (Maybe 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
set
expanderRow [ #subtitle:=
value ]
useUnderline
Whether an embedded underline in the title or subtitle labels indicates a mnemonic.
Since: 1.0
constructExpanderRowUseUnderline :: (IsExpanderRow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “use-underline
” property. This is rarely needed directly, but it is used by new
.
getExpanderRowUseUnderline :: (MonadIO m, IsExpanderRow o) => o -> m Bool Source #
Get the value of the “use-underline
” property.
When overloading is enabled, this is equivalent to
get
expanderRow #useUnderline
setExpanderRowUseUnderline :: (MonadIO m, IsExpanderRow o) => o -> Bool -> m () Source #
Set the value of the “use-underline
” property.
When overloading is enabled, this is equivalent to
set
expanderRow [ #useUnderline:=
value ]