GI.Gtk.Interfaces.Actionable

This interface provides a convenient way of associating widgets with actions on a ApplicationWindow or Application.

It primarily consists of two properties: Actionable:action-name and Actionable:action-target. There are also some convenience APIs for setting these properties.

The action will be looked up in action groups that are found among the widgets ancestors. Most commonly, these will be the actions with the “win.” or “app.” prefix that are associated with the ApplicationWindow or Application, but other action groups that are added with widgetInsertActionGroup will be consulted as well.

Since: 3.4

Exported types

newtype Actionable

Memory-managed wrapper type.

Constructors

Actionable (ManagedPtr Actionable)

Instances

GObject Actionable

Defined in GI.Gtk.Interfaces.Actionable

Methods

gobjectType :: IO GType

HasParentTypes Actionable

Defined in GI.Gtk.Interfaces.Actionable

type ParentTypes Actionable

Defined in GI.Gtk.Interfaces.Actionable

type ParentTypes Actionable = Object ': (Widget ': ([] :: [Type]))

noActionable :: Maybe Actionable

A convenience alias for Nothing :: Maybe Actionable.

class (GObject o, IsDescendantOf Actionable o) => IsActionable o

Type class for types which can be safely cast to Actionable, for instance with toActionable.

Instances

(GObject o, IsDescendantOf Actionable o) => IsActionable o

Defined in GI.Gtk.Interfaces.Actionable

toActionable :: (MonadIO m, IsActionable o) => o -> m Actionable

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

Methods

getActionName

actionableGetActionName

Arguments

:: (HasCallStack, MonadIO m, IsActionable a)

=> a

actionable: a Actionable widget

-> m (Maybe Text)

Returns: the action name, or Nothing if none is set

Gets the action name for actionable.

See actionableSetActionName for more information.

Since: 3.4

getActionTargetValue

actionableGetActionTargetValue

Arguments

:: (HasCallStack, MonadIO m, IsActionable a)

=> a

actionable: a Actionable widget

-> m GVariant

Returns: the current target value

Gets the current target value of actionable.

See actionableSetActionTargetValue for more information.

Since: 3.4

setActionName

actionableSetActionName

Arguments

:: (HasCallStack, MonadIO m, IsActionable a)

=> a

actionable: a Actionable widget

-> Maybe Text

actionName: an action name, or Nothing

-> m ()

Specifies the name of the action with which this widget should be associated. If actionName is Nothing then the widget will be unassociated from any previous action.

Usually this function is used when the widget is located (or will be located) within the hierarchy of a ApplicationWindow.

Names are of the form “win.save” or “app.quit” for actions on the containing ApplicationWindow or its associated Application, respectively. This is the same form used for actions in the Menu associated with the window.

Since: 3.4

setActionTargetValue

actionableSetActionTargetValue

Arguments

:: (HasCallStack, MonadIO m, IsActionable a)

=> a

actionable: a Actionable widget

-> Maybe GVariant

targetValue: a GVariant to set as the target value, or Nothing

-> m ()

Sets the target value of an actionable widget.

If targetValue is Nothing then the target value is unset.

The target value has two purposes. First, it is used as the parameter to activation of the action associated with the Actionable widget. Second, it is used to determine if the widget should be rendered as “active” — the widget is active if the state is equal to the given target.

Consider the example of associating a set of buttons with a Action with string state in a typical “radio button” situation. Each button will be associated with the same action, but with a different target value for that action. Clicking on a particular button will activate the action with the target of that button, which will typically cause the action’s state to change to that value. Since the action’s state is now equal to the target value of the button, the button will now be rendered as active (and the other buttons, with different targets, rendered inactive).

Since: 3.4

setDetailedActionName

actionableSetDetailedActionName

Arguments

:: (HasCallStack, MonadIO m, IsActionable a)

=> a

actionable: a Actionable widget

-> Text

detailedActionName: the detailed action name

-> m ()

Sets the action-name and associated string target value of an actionable widget.

detailedActionName is a string in the format accepted by actionParseDetailedName.

(Note that prior to version 3.22.25, this function is only usable for actions with a simple "s" target, and detailedActionName must be of the form "action::target" where action is the action name and target is the string to use as the target.)

Since: 3.4

Properties

actionName

No description available in the introspection data.

clearActionableActionName :: (MonadIO m, IsActionable o) => o -> m ()

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

clear #actionName

constructActionableActionName :: IsActionable o => Text -> IO (GValueConstruct o)

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

getActionableActionName :: (MonadIO m, IsActionable o) => o -> m (Maybe Text)

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

get actionable #actionName

setActionableActionName :: (MonadIO m, IsActionable o) => o -> Text -> m ()

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

set actionable [ #actionName := value ]

actionTarget

No description available in the introspection data.

clearActionableActionTarget :: (MonadIO m, IsActionable o) => o -> m ()

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

clear #actionTarget

constructActionableActionTarget :: IsActionable o => GVariant -> IO (GValueConstruct o)

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

getActionableActionTarget :: (MonadIO m, IsActionable o) => o -> m (Maybe GVariant)

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

get actionable #actionTarget

setActionableActionTarget :: (MonadIO m, IsActionable o) => o -> GVariant -> m ()

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

set actionable [ #actionTarget := value ]