GI.Handy.Objects.ActionRow

A ListBoxRow used to present actions.

The HdyActionRow widget can have a title, a subtitle and an icon. The row can receive additional widgets at its end, or prefix widgets at its start.

It is convenient to present a preference and its related actions.

HdyActionRow is unactivatable by default, giving it an activatable widget will automatically make it activatable, but unsetting it won't change the row's activatability.

HdyActionRow as GtkBuildable

The HdyActionRow implementation of the Buildable interface supports adding a child at its end by specifying “suffix” or omitting the “type” attribute of a <child> element.

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

CSS nodes

HdyActionRow has a main CSS node with name row.

It contains the subnode box.header for its main horizontal box, and box.title for the vertical box containing the title and subtitle labels.

It contains subnodes label.title and label.subtitle representing respectively the title label and subtitle label.

Since: 1.0

Exported types

newtype ActionRow

Memory-managed wrapper type.

Constructors

ActionRow (ManagedPtr ActionRow)

Instances

Eq ActionRow

Defined in GI.Handy.Objects.ActionRow

Methods

(==) :: ActionRow -> ActionRow -> Bool

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

GObject ActionRow

Defined in GI.Handy.Objects.ActionRow

ManagedPtrNewtype ActionRow

Defined in GI.Handy.Objects.ActionRow

Methods

toManagedPtr :: ActionRow -> ManagedPtr ActionRow

TypedObject ActionRow

Defined in GI.Handy.Objects.ActionRow

Methods

glibType :: IO GType

HasParentTypes ActionRow

Defined in GI.Handy.Objects.ActionRow

IsGValue (Maybe ActionRow)

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

Defined in GI.Handy.Objects.ActionRow

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ActionRow

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

Type class for types which can be safely cast to ActionRow, for instance with toActionRow.

Instances

(GObject o, IsDescendantOf ActionRow o) => IsActionRow o

Defined in GI.Handy.Objects.ActionRow

toActionRow :: (MonadIO m, IsActionRow o) => o -> m ActionRow

Cast to ActionRow, 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, 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, getSubtitleLines, getSupportMultidevice, getTemplateChild, getTitle, getTitleLines, 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, setSubtitleLines, setSupportMultidevice, setTitle, setTitleLines, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

activate

actionRowActivate

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> m ()

Activates self.

Since: 1.0

addPrefix

actionRowAddPrefix

Arguments

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

=> a

self: an action row

-> b

widget: the prefix widget

-> m ()

Adds a prefix widget to self.

Since: 1.0

getActivatableWidget

actionRowGetActivatableWidget

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> m (Maybe Widget)

Returns: the activatable widget for self

Gets the widget activated when self is activated.

Since: 1.0

getIconName

actionRowGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> m Text

Returns: the icon name for self

Gets the icon name for self.

Since: 1.0

getSubtitle

actionRowGetSubtitle

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> m (Maybe Text)

Returns: the subtitle for self

Gets the subtitle for self.

Since: 1.0

getSubtitleLines

actionRowGetSubtitleLines

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> m Int32

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.

If the value is 0, the number of lines won't be limited.

Since: 1.2

getTitleLines

actionRowGetTitleLines

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> m Int32

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.

If the value is 0, the number of lines won't be limited.

Since: 1.2

getUseUnderline

actionRowGetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> m Bool

Returns: whether an embedded underline in the title or subtitle indicates a mnemonic

Gets whether an embedded underline in the title or subtitle indicates a mnemonic.

Since: 1.0

new

actionRowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ActionRow

Returns: the newly created HdyActionRow

Creates a new HdyActionRow.

Since: 1.0

setActivatableWidget

actionRowSetActivatableWidget

Arguments

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

=> a

self: an action row

-> Maybe b

widget: the target widget

-> m ()

Sets the widget to activate when self is activated.

Since: 1.0

setIconName

actionRowSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> Text

iconName: the icon name

-> m ()

Sets the icon name for self.

Since: 1.0

setSubtitle

actionRowSetSubtitle

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> Maybe Text

subtitle: the subtitle

-> m ()

Sets the subtitle for self.

Since: 1.0

setSubtitleLines

actionRowSetSubtitleLines

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> Int32

subtitleLines: the number of lines at the end of which the subtitle label will be ellipsized

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

setTitleLines

actionRowSetTitleLines

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> Int32

titleLines: the number of lines at the end of which the title label will be ellipsized

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

setUseUnderline

actionRowSetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: an action row

-> Bool

useUnderline: TRUE if underlines in the text indicate mnemonics

-> m ()

Sets whether an embedded underline in the title or subtitle indicates a mnemonic.

Since: 1.0

Properties

activatableWidget

The activatable widget for this row.

The widget is activated, either by clicking on it, by calling [methodactionRow.activate], or via mnemonics in the title or the subtitle. See the [propertyactionRow:use-underline] property to enable mnemonics.

The target widget will be activated by emitting the Widget::mnemonicActivate signal on it.

Since: 1.0

clearActionRowActivatableWidget :: (MonadIO m, IsActionRow o) => o -> m ()

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)

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)

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 ()

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: 1.0

constructActionRowIconName :: (IsActionRow 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.

getActionRowIconName :: (MonadIO m, IsActionRow o) => o -> m Text

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 ()

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: 1.0

clearActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> m ()

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

clear #subtitle

constructActionRowSubtitle :: (IsActionRow 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.

getActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> m (Maybe Text)

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 ()

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

set actionRow [ #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.2

constructActionRowSubtitleLines :: (IsActionRow o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getActionRowSubtitleLines :: (MonadIO m, IsActionRow o) => o -> m Int32

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

get actionRow #subtitleLines

setActionRowSubtitleLines :: (MonadIO m, IsActionRow o) => o -> Int32 -> m ()

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

set actionRow [ #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.2

constructActionRowTitleLines :: (IsActionRow o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getActionRowTitleLines :: (MonadIO m, IsActionRow o) => o -> m Int32

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

get actionRow #titleLines

setActionRowTitleLines :: (MonadIO m, IsActionRow o) => o -> Int32 -> m ()

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

set actionRow [ #titleLines := value ]

useUnderline

Whether embedded underlines in the title or subtitle indicates a mnemonic.

If true, an underline in the text of the title or subtitle labels indicates the next character should be used for the mnemonic accelerator key.

Since: 1.0

constructActionRowUseUnderline :: (IsActionRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

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 ()

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

set actionRow [ #useUnderline := value ]

Signals

activated

type ActionRowActivatedCallback = IO ()

This signal is emitted after the row has been activated.

Since: 1.0

afterActionRowActivated :: (IsActionRow a, MonadIO m) => a -> ((?self :: a) => ActionRowActivatedCallback) -> m SignalHandlerId

Connect a signal handler for the activated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after actionRow #activated callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onActionRowActivated :: (IsActionRow a, MonadIO m) => a -> ((?self :: a) => ActionRowActivatedCallback) -> m SignalHandlerId

Connect a signal handler for the activated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on actionRow #activated callback