GI.Adw.Objects.ActionRow

A ListBoxRow used to present actions.

The AdwActionRow 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.

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

AdwActionRow as GtkBuildable

The AdwActionRow 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

AdwActionRow 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.Adw.Objects.ActionRow

Methods

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

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

GObject ActionRow

Defined in GI.Adw.Objects.ActionRow

ManagedPtrNewtype ActionRow

Defined in GI.Adw.Objects.ActionRow

Methods

toManagedPtr :: ActionRow -> ManagedPtr ActionRow

TypedObject ActionRow

Defined in GI.Adw.Objects.ActionRow

Methods

glibType :: IO GType

HasParentTypes ActionRow

Defined in GI.Adw.Objects.ActionRow

IsGValue (Maybe ActionRow)

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

Defined in GI.Adw.Objects.ActionRow

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ActionRow

Defined in GI.Adw.Objects.ActionRow

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

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

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addPrefix, addSuffix, addTickCallback, allocate, bindProperty, bindPropertyFull, changed, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, 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, getActivatableWidget, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, 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, getSize, getSizeRequest, getStateFlags, getStyleContext, getSubtitle, getSubtitleLines, getTemplateChild, getTitle, getTitleLines, getTooltipMarkup, getTooltipText, getUseUnderline, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

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

activate

actionRowActivate

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a AdwActionRow

-> m ()

Activates self.

Since: 1.0

addPrefix

actionRowAddPrefix

Arguments

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

=> a

self: a AdwActionRow

-> b

widget: a widget

-> m ()

Adds a prefix widget to self.

Since: 1.0

addSuffix

actionRowAddSuffix

Arguments

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

=> a

self: a AdwActionRow

-> b

widget: a widget

-> m ()

Adds a suffix widget to self.

Since: 1.0

getActivatableWidget

actionRowGetActivatableWidget

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a AdwActionRow

-> 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: a AdwActionRow

-> m (Maybe 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: a AdwActionRow

-> 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: a AdwActionRow

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

getTitleLines

actionRowGetTitleLines

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a AdwActionRow

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

new

actionRowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ActionRow

Returns: the newly created AdwActionRow

Creates a new AdwActionRow.

Since: 1.0

remove

actionRowRemove

Arguments

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

=> a

self: a AdwActionRow

-> b

widget: the child to be removed

-> m ()

Removes a child from self.

Since: 1.0

setActivatableWidget

actionRowSetActivatableWidget

Arguments

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

=> a

self: a AdwActionRow

-> 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: a AdwActionRow

-> Maybe 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: a AdwActionRow

-> Text

subtitle: the subtitle

-> m ()

Sets the subtitle for self.

Since: 1.0

setSubtitleLines

actionRowSetSubtitleLines

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a AdwActionRow

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

setTitleLines

actionRowSetTitleLines

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a AdwActionRow

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

Properties

activatableWidget

The widget to activate when the row is activated.

The row can be activated either by clicking on it, calling actionRowActivate, or via mnemonics in the title or the subtitle. See the PreferencesRow:useUnderline 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

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

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

clear #iconName

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

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

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

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 ]

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