GI.Handy.Objects.ActionRow

No description available in the introspection data.

Exported types

newtype ActionRow

Memory-managed wrapper type.

Constructors

ActionRow (ManagedPtr ActionRow)

Instances

GObject ActionRow

Defined in GI.Handy.Objects.ActionRow

Methods

gobjectType :: IO GType

HasParentTypes ActionRow

Defined in GI.Handy.Objects.ActionRow

type ParentTypes ActionRow

Defined in GI.Handy.Objects.ActionRow

type ParentTypes ActionRow = ListBoxRow ': (Bin ': (Container ': (Widget ': (Object ': (ImplementorIface ': (Actionable ': (Buildable ': ([] :: [Type]))))))))

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.

noActionRow :: Maybe ActionRow

A convenience alias for Nothing :: Maybe ActionRow.

Methods

activate

actionRowActivate :: (HasCallStack, MonadIO m, IsActionRow a) => a -> m ()

No description available in the introspection data.

addAction

actionRowAddAction

Arguments

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

=> a

self: a ActionRow

-> Maybe b

widget: the action widget

-> m ()

Adds an action widget to self.

Since: 0.0.6

addPrefix

actionRowAddPrefix

Arguments

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

=> a

self: a ActionRow

-> Maybe b

widget: the prefix widget

-> m ()

Adds a prefix widget to self.

Since: 0.0.6

getActivatableWidget

actionRowGetActivatableWidget

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> m (Maybe Widget)

Returns: the widget activated when self is activated, or Nothing if none has been set.

Gets the widget activated when self is activated.

Since: 0.0.7

getIconName

actionRowGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> m Text

Returns: the icon name for self.

Gets the icon name for self.

Since: 0.0.6

getSubtitle

actionRowGetSubtitle

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> m Text

Returns: the subtitle for self.

Gets the subtitle for self.

Since: 0.0.6

getTitle

actionRowGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> m Text

Returns: the title for self.

Gets the title for self.

Since: 0.0.6

getUseUnderline

actionRowGetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> m Bool

Returns: True if an embedded underline in the title and subtitle labels indicates the mnemonic accelerator keys.

Gets whether an embedded underline in the text of the title and subtitle labels indicates a mnemonic. See actionRowSetUseUnderline.

Since: 0.0.6

new

actionRowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ActionRow

Returns: a new ActionRow

Creates a new ActionRow.

Since: 0.0.6

setActivatableWidget

actionRowSetActivatableWidget

Arguments

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

=> a

self: a ActionRow

-> Maybe b

widget: the target Widget, or Nothing to unset

-> 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::mnemonic-activate signal on it.

Since: 0.0.7

setIconName

actionRowSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> Text

iconName: the icon name

-> m ()

Sets the icon name for self.

Since: 0.0.6

setSubtitle

actionRowSetSubtitle

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> Text

subtitle: the subtitle

-> m ()

Sets the subtitle for self.

Since: 0.0.6

setTitle

actionRowSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> Text

title: the title

-> m ()

Sets the title for self.

Since: 0.0.6

setUseUnderline

actionRowSetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsActionRow a)

=> a

self: a ActionRow

-> Bool

useUnderline: True if underlines in the text indicate mnemonics

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

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

clear #activatableWidget

constructActionRowActivatableWidget :: (IsActionRow o, IsWidget a) => a -> IO (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: 0.0.6

constructActionRowIconName :: IsActionRow o => Text -> IO (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: 0.0.6

constructActionRowSubtitle :: IsActionRow o => Text -> IO (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 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 ]

title

The title for this row.

Since: 0.0.6

constructActionRowTitle :: IsActionRow o => Text -> IO (GValueConstruct o)

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

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

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 => Bool -> IO (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 ]