Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
The ActionRow
widget can have a title, a subtitle and an icon. The row
can receive action widgets at its end, prefix widgets at its start or widgets
below it.
Note that action widgets are packed starting from the end.
It is convenient to present a list of preferences and their related actions.
HdyActionRow as GtkBuildable
The GtkWindow implementation of the GtkBuildable interface supports setting a child as an action widget by specifying “action” as the “type” attribute of a <child> element.
It also supports setting a child as a prefix widget by specifying “prefix” as the “type” attribute of a <child> element.
Since: 0.0.6
Synopsis
- newtype ActionRow = ActionRow (ManagedPtr ActionRow)
- class (GObject o, IsDescendantOf ActionRow o) => IsActionRow o
- toActionRow :: (MonadIO m, IsActionRow o) => o -> m ActionRow
- actionRowActivate :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m ()
- actionRowAddAction :: (HasCallStack, MonadIO m, IsActionRow a, IsWidget b) => a -> Maybe b -> m ()
- actionRowAddPrefix :: (HasCallStack, MonadIO m, IsActionRow a, IsWidget b) => a -> Maybe b -> m ()
- actionRowGetActivatableWidget :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m (Maybe Widget)
- actionRowGetIconName :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m Text
- actionRowGetSubtitle :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m Text
- actionRowGetTitle :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m Text
- actionRowGetUseUnderline :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m Bool
- actionRowNew :: (HasCallStack, MonadIO m) => m ActionRow
- actionRowSetActivatableWidget :: (HasCallStack, MonadIO m, IsActionRow a, IsWidget b) => a -> Maybe b -> m ()
- actionRowSetIconName :: (HasCallStack, MonadIO m, IsActionRow a) => a -> Text -> m ()
- actionRowSetSubtitle :: (HasCallStack, MonadIO m, IsActionRow a) => a -> Text -> m ()
- actionRowSetTitle :: (HasCallStack, MonadIO m, IsActionRow a) => a -> Text -> m ()
- actionRowSetUseUnderline :: (HasCallStack, MonadIO m, IsActionRow a) => a -> Bool -> m ()
- clearActionRowActivatableWidget :: (MonadIO m, IsActionRow o) => o -> m ()
- constructActionRowActivatableWidget :: (IsActionRow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getActionRowActivatableWidget :: (MonadIO m, IsActionRow o) => o -> m (Maybe Widget)
- setActionRowActivatableWidget :: (MonadIO m, IsActionRow o, IsWidget a) => o -> a -> m ()
- constructActionRowIconName :: (IsActionRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getActionRowIconName :: (MonadIO m, IsActionRow o) => o -> m Text
- setActionRowIconName :: (MonadIO m, IsActionRow o) => o -> Text -> m ()
- constructActionRowSubtitle :: (IsActionRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> m Text
- setActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> Text -> m ()
- constructActionRowTitle :: (IsActionRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getActionRowTitle :: (MonadIO m, IsActionRow o) => o -> m Text
- setActionRowTitle :: (MonadIO m, IsActionRow o) => o -> Text -> m ()
- constructActionRowUseUnderline :: (IsActionRow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getActionRowUseUnderline :: (MonadIO m, IsActionRow o) => o -> m Bool
- setActionRowUseUnderline :: (MonadIO m, IsActionRow o) => o -> Bool -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq ActionRow Source # | |
GObject ActionRow Source # | |
Defined in GI.Handy.Objects.ActionRow | |
ManagedPtrNewtype ActionRow Source # | |
Defined in GI.Handy.Objects.ActionRow toManagedPtr :: ActionRow -> ManagedPtr ActionRow | |
TypedObject ActionRow Source # | |
Defined in GI.Handy.Objects.ActionRow | |
HasParentTypes ActionRow Source # | |
Defined in GI.Handy.Objects.ActionRow | |
IsGValue (Maybe ActionRow) Source # | Convert |
Defined in GI.Handy.Objects.ActionRow gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ActionRow -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ActionRow) | |
type ParentTypes ActionRow Source # | |
Defined in GI.Handy.Objects.ActionRow type ParentTypes ActionRow = '[PreferencesRow, ListBoxRow, Bin, Container, Widget, Object, ImplementorIface, Actionable, Buildable] |
class (GObject o, IsDescendantOf ActionRow o) => IsActionRow o Source #
Type class for types which can be safely cast to ActionRow
, for instance with toActionRow
.
Instances
(GObject o, IsDescendantOf ActionRow o) => IsActionRow o Source # | |
Defined in GI.Handy.Objects.ActionRow |
toActionRow :: (MonadIO m, IsActionRow o) => o -> m ActionRow Source #
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, getActivatableWidget, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, 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, 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, setActivatableWidget, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDetailedActionName, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, 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, setSizeRequest, setState, setStateFlags, setStyle, setSubtitle, setSupportMultidevice, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
activate
actionRowActivate :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m () Source #
No description available in the introspection data.
addAction
:: (HasCallStack, MonadIO m, IsActionRow a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Adds an action widget to self
.
Since: 0.0.6
addPrefix
:: (HasCallStack, MonadIO m, IsActionRow a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Adds a prefix widget to self
.
Since: 0.0.6
getActivatableWidget
actionRowGetActivatableWidget Source #
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the widget activated when |
Gets the widget activated when self
is activated.
Since: 0.0.7
getIconName
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> m Text | Returns: the icon name for |
Gets the icon name for self
.
Since: 0.0.6
getSubtitle
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> m Text | Returns: the subtitle for |
Gets the subtitle for self
.
Since: 0.0.6
getTitle
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> m Text | Returns: the title for |
Gets the title for self
.
Since: 0.0.6
getUseUnderline
actionRowGetUseUnderline Source #
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether an embedded underline in the text of the title and subtitle
labels indicates a mnemonic. See actionRowSetUseUnderline
.
Since: 0.0.6
new
:: (HasCallStack, MonadIO m) | |
=> m ActionRow | Returns: a new |
Creates a new ActionRow
.
Since: 0.0.6
setActivatableWidget
actionRowSetActivatableWidget Source #
:: (HasCallStack, MonadIO m, IsActionRow a, IsWidget b) | |
=> a |
|
-> Maybe b | |
-> m () |
Sets the widget to activate when self
is activated, either by clicking
on it, by calling actionRowActivate
, or via mnemonics in the title or
the subtitle. See the “use_underline” property to enable mnemonics.
The target widget will be activated by emitting the GtkWidget[mnemonicActivate](#g:signal:mnemonicActivate) signal on it.
Since: 0.0.7
setIconName
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the icon name for self
.
Since: 0.0.6
setSubtitle
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the subtitle for self
.
Since: 0.0.6
setTitle
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the title for self
.
Since: 0.0.6
setUseUnderline
actionRowSetUseUnderline Source #
:: (HasCallStack, MonadIO m, IsActionRow a) | |
=> a |
|
-> Bool |
|
-> m () |
If true, an underline in the text of the title and subtitle labels indicates the next character should be used for the mnemonic accelerator key.
Since: 0.0.6
Properties
activatableWidget
The activatable widget for this row.
Since: 0.0.7
clearActionRowActivatableWidget :: (MonadIO m, IsActionRow o) => o -> m () Source #
Set the value of the “activatable-widget
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#activatableWidget
constructActionRowActivatableWidget :: (IsActionRow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “activatable-widget
” property. This is rarely needed directly, but it is used by new
.
getActionRowActivatableWidget :: (MonadIO m, IsActionRow o) => o -> m (Maybe Widget) Source #
Get the value of the “activatable-widget
” property.
When overloading is enabled, this is equivalent to
get
actionRow #activatableWidget
setActionRowActivatableWidget :: (MonadIO m, IsActionRow o, IsWidget a) => o -> a -> m () Source #
Set the value of the “activatable-widget
” property.
When overloading is enabled, this is equivalent to
set
actionRow [ #activatableWidget:=
value ]
iconName
The icon name for this row.
Since: 0.0.6
constructActionRowIconName :: (IsActionRow 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
.
getActionRowIconName :: (MonadIO m, IsActionRow o) => o -> m Text Source #
Get the value of the “icon-name
” property.
When overloading is enabled, this is equivalent to
get
actionRow #iconName
setActionRowIconName :: (MonadIO m, IsActionRow o) => o -> Text -> m () Source #
Set the value of the “icon-name
” property.
When overloading is enabled, this is equivalent to
set
actionRow [ #iconName:=
value ]
subtitle
The subtitle for this row.
Since: 0.0.6
constructActionRowSubtitle :: (IsActionRow 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
.
getActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> m Text Source #
Get the value of the “subtitle
” property.
When overloading is enabled, this is equivalent to
get
actionRow #subtitle
setActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> Text -> m () Source #
Set the value of the “subtitle
” property.
When overloading is enabled, this is equivalent to
set
actionRow [ #subtitle:=
value ]
title
The title for this row.
Since: 0.0.6
constructActionRowTitle :: (IsActionRow 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
.
getActionRowTitle :: (MonadIO m, IsActionRow o) => o -> m Text Source #
Get the value of the “title
” property.
When overloading is enabled, this is equivalent to
get
actionRow #title
setActionRowTitle :: (MonadIO m, IsActionRow o) => o -> Text -> m () Source #
Set the value of the “title
” property.
When overloading is enabled, this is equivalent to
set
actionRow [ #title:=
value ]
useUnderline
Whether an embedded underline in the text of the title and subtitle labels indicates a mnemonic.
Since: 0.0.6
constructActionRowUseUnderline :: (IsActionRow 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
.
getActionRowUseUnderline :: (MonadIO m, IsActionRow o) => o -> m Bool Source #
Get the value of the “use-underline
” property.
When overloading is enabled, this is equivalent to
get
actionRow #useUnderline
setActionRowUseUnderline :: (MonadIO m, IsActionRow o) => o -> Bool -> m () Source #
Set the value of the “use-underline
” property.
When overloading is enabled, this is equivalent to
set
actionRow [ #useUnderline:=
value ]