Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Handy.Objects.ActionRow

Contents

Exported types
Methods
Properties

Description

No description available in the introspection data.

Synopsis

newtype ActionRow = ActionRow (ManagedPtr ActionRow)
class (GObject o, IsDescendantOf ActionRow o) => IsActionRow o
toActionRow :: (MonadIO m, IsActionRow o) => o -> m ActionRow
noActionRow :: Maybe 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, IsWidget a) => a -> IO (GValueConstruct o)
getActionRowActivatableWidget :: (MonadIO m, IsActionRow o) => o -> m (Maybe Widget)
setActionRowActivatableWidget :: (MonadIO m, IsActionRow o, IsWidget a) => o -> a -> m ()
constructActionRowIconName :: IsActionRow o => Text -> IO (GValueConstruct o)
getActionRowIconName :: (MonadIO m, IsActionRow o) => o -> m Text
setActionRowIconName :: (MonadIO m, IsActionRow o) => o -> Text -> m ()
constructActionRowSubtitle :: IsActionRow o => Text -> IO (GValueConstruct o)
getActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> m Text
setActionRowSubtitle :: (MonadIO m, IsActionRow o) => o -> Text -> m ()
constructActionRowTitle :: IsActionRow o => Text -> IO (GValueConstruct o)
getActionRowTitle :: (MonadIO m, IsActionRow o) => o -> m Text
setActionRowTitle :: (MonadIO m, IsActionRow o) => o -> Text -> m ()
constructActionRowUseUnderline :: IsActionRow o => Bool -> IO (GValueConstruct o)
getActionRowUseUnderline :: (MonadIO m, IsActionRow o) => o -> m Bool
setActionRowUseUnderline :: (MonadIO m, IsActionRow o) => o -> Bool -> m ()

Exported types

newtype ActionRow Source #

Memory-managed wrapper type.

Constructors

ActionRow (ManagedPtr ActionRow)

Instances

GObject ActionRow Source #
Instance details Defined in GI.Handy.Objects.ActionRow Methods gobjectType :: IO GType #
HasParentTypes ActionRow Source #
Instance details Defined in GI.Handy.Objects.ActionRow
type ParentTypes ActionRow Source #
Instance details 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 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 #
Instance details Defined in GI.Handy.Objects.ActionRow

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

Cast to ActionRow, for types for which this is known to be safe. For general casts, use castTo.

noActionRow :: Maybe ActionRow Source #

A convenience alias for Nothing :: Maybe ActionRow.

Methods

activate

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

No description available in the introspection data.

addAction

actionRowAddAction Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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

setActivatableWidget

actionRowSetActivatableWidget Source #

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 Source #

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 Source #

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 Source #

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 Source #

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

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

:: (HasCallStack, MonadIO m)
=> m ActionRow	Returns: a new `ActionRow`