gi-gio-2.0.19: Gio bindings

Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell | None
Language | Haskell2010

GI.Gio.Interfaces.ActionGroup

Contents

- Exported types
- Methods
  - actionAdded
  - actionEnabledChanged
  - actionRemoved
  - actionStateChanged
  - activateAction
  - changeActionState
  - getActionEnabled
  - getActionParameterType
  - getActionState
  - getActionStateHint
  - getActionStateType
  - hasAction
  - listActions
  - queryAction
- Signals
  - actionAdded
  - actionEnabledChanged
  - actionRemoved
  - actionStateChanged

Description

`ActionGroup` represents a group of actions. Actions can be used to expose functionality in a structured way, either from one part of a program to another, or to the outside world. Action groups are often used together with a `MenuModel` that provides additional representation data for displaying the actions to the user, e.g. in a menu.

The main way to interact with the actions in a GActionGroup is to activate them with `actionGroupActivateAction`. Activating an action may require a `GVariant` parameter. The required type of the parameter can be inquired with `actionGroupGetActionParameterType`. Actions may be disabled, see `actionGroupGetActionEnabled`. Activating a disabled action has no effect.

Actions may optionally have a state in the form of a `GVariant`. The current state of an action can be inquired with `actionGroupGetActionState`. Activating a stateful action may change its state, but it is also possible to set the state by calling `actionGroupChangeActionState`.

As typical example, consider a text editing application which has an option to change the current font to 'bold'. A good way to represent this would be a stateful action, with a boolean state. Activating the action would toggle the state.

Each action in the group has a unique name (which is a string). All method calls, except `actionGroupListActions` take the name of an action as an argument.

The `ActionGroup` API is meant to be the 'public' API to the action group. The calls here are exactly the interaction that 'external forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have with actions. 'Internal' APIs (ie: ones meant only to be accessed by the action group implementation) are found on subclasses. This is why you will find - for example - `actionGroupGetActionEnabled` but not an equivalent `set()` call.

Signals are emitted on the action group in response to state changes on individual actions.

Implementations of `ActionGroup` should provide implementations for the virtual functions `actionGroupListActions` and `actionGroupQueryAction`. The other virtual functions should not be implemented - their "wrappers" are actually implemented with calls to `actionGroupQueryAction`.

Synopsis

- newtype ActionGroup = ActionGroup (ManagedPtr ActionGroup)
- noActionGroup :: Maybe ActionGroup
- class GObject o => IsActionGroup o
- toActionGroup :: (MonadIO m, IsActionGroup o) => o -> m ActionGroup
- actionGroupActionAdded :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m ()
- actionGroupActionEnabledChanged :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> Bool -> m ()
- actionGroupActionRemoved :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m ()
- actionGroupActionStateChanged :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> GVariant -> m ()
- actionGroupActivateAction :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> Maybe GVariant -> m ()
- actionGroupChangeActionState :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> GVariant -> m ()
- actionGroupGetActionEnabled :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m Bool
- actionGroupGetActionParameterType :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m (Maybe VariantType)
- actionGroupGetActionState :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m (Maybe GVariant)
- actionGroupGetActionStateHint :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m (Maybe GVariant)
- actionGroupGetActionStateType :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m (Maybe VariantType)
- actionGroupHasAction :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m Bool
- actionGroupListActions :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> m [Text]
- actionGroupQueryAction :: (HasCallStack, MonadIO m, IsActionGroup a) => a -> Text -> m (Bool, Bool, VariantType, VariantType, GVariant, GVariant)
- type ActionGroupActionAddedCallback = Text -> IO ()
- type C_ActionGroupActionAddedCallback = Ptr () -> CString -> Ptr () -> IO ()
- afterActionGroupActionAdded :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionAddedCallback -> m SignalHandlerId
- genClosure_ActionGroupActionAdded :: ActionGroupActionAddedCallback -> IO Closure
- mk_ActionGroupActionAddedCallback :: C_ActionGroupActionAddedCallback -> IO (FunPtr C_ActionGroupActionAddedCallback)
- noActionGroupActionAddedCallback :: Maybe ActionGroupActionAddedCallback
- onActionGroupActionAdded :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionAddedCallback -> m SignalHandlerId
- wrap_ActionGroupActionAddedCallback :: ActionGroupActionAddedCallback -> C_ActionGroupActionAddedCallback
- type ActionGroupActionEnabledChangedCallback = Text -> Bool -> IO ()
- type C_ActionGroupActionEnabledChangedCallback = Ptr () -> CString -> CInt -> Ptr () -> IO ()
- afterActionGroupActionEnabledChanged :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionEnabledChangedCallback -> m SignalHandlerId
- genClosure_ActionGroupActionEnabledChanged :: ActionGroupActionEnabledChangedCallback -> IO Closure
- mk_ActionGroupActionEnabledChangedCallback :: C_ActionGroupActionEnabledChangedCallback -> IO (FunPtr C_ActionGroupActionEnabledChangedCallback)
- noActionGroupActionEnabledChangedCallback :: Maybe ActionGroupActionEnabledChangedCallback
- onActionGroupActionEnabledChanged :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionEnabledChangedCallback -> m SignalHandlerId
- wrap_ActionGroupActionEnabledChangedCallback :: ActionGroupActionEnabledChangedCallback -> C_ActionGroupActionEnabledChangedCallback
- type ActionGroupActionRemovedCallback = Text -> IO ()
- type C_ActionGroupActionRemovedCallback = Ptr () -> CString -> Ptr () -> IO ()
- afterActionGroupActionRemoved :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionRemovedCallback -> m SignalHandlerId
- genClosure_ActionGroupActionRemoved :: ActionGroupActionRemovedCallback -> IO Closure
- mk_ActionGroupActionRemovedCallback :: C_ActionGroupActionRemovedCallback -> IO (FunPtr C_ActionGroupActionRemovedCallback)
- noActionGroupActionRemovedCallback :: Maybe ActionGroupActionRemovedCallback
- onActionGroupActionRemoved :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionRemovedCallback -> m SignalHandlerId
- wrap_ActionGroupActionRemovedCallback :: ActionGroupActionRemovedCallback -> C_ActionGroupActionRemovedCallback
- type ActionGroupActionStateChangedCallback = Text -> GVariant -> IO ()
- type C_ActionGroupActionStateChangedCallback = Ptr () -> CString -> Ptr GVariant -> Ptr () -> IO ()
- afterActionGroupActionStateChanged :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionStateChangedCallback -> m SignalHandlerId
- genClosure_ActionGroupActionStateChanged :: ActionGroupActionStateChangedCallback -> IO Closure
- mk_ActionGroupActionStateChangedCallback :: C_ActionGroupActionStateChangedCallback -> IO (FunPtr C_ActionGroupActionStateChangedCallback)
- noActionGroupActionStateChangedCallback :: Maybe ActionGroupActionStateChangedCallback
- onActionGroupActionStateChanged :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionStateChangedCallback -> m SignalHandlerId
- wrap_ActionGroupActionStateChangedCallback :: ActionGroupActionStateChangedCallback -> C_ActionGroupActionStateChangedCallback

# Exported types

newtype ActionGroup Source #

Memory-managed wrapper type.

Constructors

ActionGroup (ManagedPtr ActionGroup) |

Instances

GObject ActionGroup Source # |
Instance details Defined in GI.Gio.Interfaces.ActionGroup Methods gobjectType :: ActionGroup -> IO GType Source #
IsObject ActionGroup Source # |
Instance details Defined in GI.Gio.Interfaces.ActionGroup
IsActionGroup ActionGroup Source # |
Instance details Defined in GI.Gio.Interfaces.ActionGroup

noActionGroup :: Maybe ActionGroup Source #

A convenience alias for `Nothing` :: `Maybe` `ActionGroup`.

class GObject o => IsActionGroup o Source #

Type class for types which can be safely cast to `ActionGroup`, for instance with `toActionGroup`.

Instances

(GObject a, (UnknownAncestorError ActionGroup a :: Constraint)) => IsActionGroup a Source # |
Instance details Defined in GI.Gio.Interfaces.ActionGroup
IsActionGroup ActionGroup Source # |
Instance details Defined in GI.Gio.Interfaces.ActionGroup
IsActionGroup RemoteActionGroup Source # |
Instance details Defined in GI.Gio.Interfaces.RemoteActionGroup
IsActionGroup DBusActionGroup Source # |
Instance details Defined in GI.Gio.Objects.DBusActionGroup
IsActionGroup Application Source # |
Instance details Defined in GI.Gio.Objects.Application
IsActionGroup SimpleActionGroup Source # |
Instance details Defined in GI.Gio.Objects.SimpleActionGroup

toActionGroup :: (MonadIO m, IsActionGroup o) => o -> m ActionGroup Source #

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

# Methods

## actionAdded

actionGroupActionAdded Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of an action in the group
-> m () |

Emits the `ActionGroup`::`action-added` signal on `actionGroup`.

This function should only be called by `ActionGroup` implementations.

Since: 2.28

## actionEnabledChanged

actionGroupActionEnabledChanged Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of an action in the group
-> Bool | `enabled`: whether or not the action is now enabled
-> m () |

Emits the `ActionGroup`::`action-enabled-changed` signal on `actionGroup`.

This function should only be called by `ActionGroup` implementations.

Since: 2.28

## actionRemoved

actionGroupActionRemoved Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of an action in the group
-> m () |

Emits the `ActionGroup`::`action-removed` signal on `actionGroup`.

This function should only be called by `ActionGroup` implementations.

Since: 2.28

## actionStateChanged

actionGroupActionStateChanged Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of an action in the group
-> GVariant | `state`: the new state of the named action
-> m () |

Emits the `ActionGroup`::`action-state-changed` signal on `actionGroup`.

This function should only be called by `ActionGroup` implementations.

Since: 2.28

## activateAction

actionGroupActivateAction Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of the action to activate
-> Maybe GVariant | `parameter`: parameters to the activation
-> m () |

Activate the named action within `actionGroup`.

If the action is expecting a parameter, then the correct type of parameter must be given as `parameter`. If the action is expecting no parameters then `parameter` must be `Nothing`. See `actionGroupGetActionParameterType`.

Since: 2.28

## changeActionState

actionGroupChangeActionState Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of the action to request the change on
-> GVariant | `value`: the new state
-> m () |

Request for the state of the named action within `actionGroup` to be changed to `value`.

The action must be stateful and `value` must be of the correct type. See `actionGroupGetActionStateType`.

This call merely requests a change. The action may refuse to change its state or may change its state to something other than `value`. See `actionGroupGetActionStateHint`.

If the `value` GVariant is floating, it is consumed.

Since: 2.28

## getActionEnabled

actionGroupGetActionEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of the action to query
-> m Bool | Returns: whether or not the action is currently enabled

Checks if the named action within `actionGroup` is currently enabled.

An action must be enabled in order to be activated or in order to have its state changed from outside callers.

Since: 2.28

## getActionParameterType

actionGroupGetActionParameterType Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of the action to query
-> m (Maybe VariantType) | Returns: the parameter type

Queries the type of the parameter that must be given when activating the named action within `actionGroup`.

When activating the action using `actionGroupActivateAction`, the `GVariant` given to that function must be of the type returned by this function.

In the case that this function returns `Nothing`, you must not give any `GVariant`, but `Nothing` instead.

The parameter type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different parameter type.

Since: 2.28

## getActionState

actionGroupGetActionState Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of the action to query
-> m (Maybe GVariant) | Returns: the current state of the action

Queries the current state of the named action within `actionGroup`.

If the action is not stateful then `Nothing` will be returned. If the action is stateful then the type of the return value is the type given by `actionGroupGetActionStateType`.

The return value (if non-`Nothing`) should be freed with `variantUnref` when it is no longer required.

Since: 2.28

## getActionStateHint

actionGroupGetActionStateHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of the action to query
-> m (Maybe GVariant) | Returns: the state range hint

Requests a hint about the valid range of values for the state of the named action within `actionGroup`.

If `Nothing` is returned it either means that the action is not stateful or that there is no hint about the valid range of values for the state of the action.

If a `GVariant` array is returned then each item in the array is a possible value for the state. If a `GVariant` pair (ie: two-tuple) is returned then the tuple specifies the inclusive lower and upper bound of valid values for the state.

In any case, the information is merely a hint. It may be possible to have a state value outside of the hinted range and setting a value within the range may fail.

The return value (if non-`Nothing`) should be freed with `variantUnref` when it is no longer required.

Since: 2.28

## getActionStateType

actionGroupGetActionStateType Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of the action to query
-> m (Maybe VariantType) | Returns: the state type, if the action is stateful

Queries the type of the state of the named action within `actionGroup`.

If the action is stateful then this function returns the `VariantType` of the state. All calls to `actionGroupChangeActionState` must give a `GVariant` of this type and `actionGroupGetActionState` will return a `GVariant` of the same type.

If the action is not stateful then this function will return `Nothing`. In that case, `actionGroupGetActionState` will return `Nothing` and you must not call `actionGroupChangeActionState`.

The state type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different state type.

Since: 2.28

## hasAction

actionGroupHasAction Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of the action to check for
-> m Bool | Returns: whether the named action exists

Checks if the named action exists within `actionGroup`.

Since: 2.28

## listActions

actionGroupListActions Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> m [Text] | Returns: a `Nothing`-terminated array of the names of the actions in the group

Lists the actions contained within `actionGroup`.

The caller is responsible for freeing the list with `strfreev` when it is no longer required.

Since: 2.28

## queryAction

actionGroupQueryAction Source #

Arguments

:: (HasCallStack, MonadIO m, IsActionGroup a) |
=> a | `actionGroup`: a `ActionGroup`
-> Text | `actionName`: the name of an action in the group
-> m (Bool, Bool, VariantType, VariantType, GVariant, GVariant) | Returns: `True` if the action exists, else `False`

Queries all aspects of the named action within an `actionGroup`.

This function acquires the information available from `actionGroupHasAction`, `actionGroupGetActionEnabled`, `actionGroupGetActionParameterType`, `actionGroupGetActionStateType`, `actionGroupGetActionStateHint` and `actionGroupGetActionState` with a single function call.

This provides two main benefits.

The first is the improvement in efficiency that comes with not having to perform repeated lookups of the action in order to discover different things about it. The second is that implementing `ActionGroup` can now be done by only overriding this one virtual function.

The interface provides a default implementation of this function that calls the individual functions, as required, to fetch the information. The interface also provides default implementations of those functions that call this function. All implementations, therefore, must override either this function or all of the others.

If the action exists, `True` is returned and any of the requested fields (as indicated by having a non-`Nothing` reference passed in) are filled. If the action doesn't exist, `False` is returned and the fields may or may not have been modified.

Since: 2.32

# Signals

## actionAdded

type ActionGroupActionAddedCallback Source #

Arguments

= Text | `actionName`: the name of the action in `actionGroup`
-> IO () |

Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.

Since: 2.28

type C_ActionGroupActionAddedCallback = Ptr () -> CString -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterActionGroupActionAdded :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionAddedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`action-added`” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after actionGroup #actionAdded callback

genClosure_ActionGroupActionAdded :: ActionGroupActionAddedCallback -> IO Closure Source #

Wrap the callback into a `Closure`.

mk_ActionGroupActionAddedCallback :: C_ActionGroupActionAddedCallback -> IO (FunPtr C_ActionGroupActionAddedCallback) Source #

Generate a function pointer callable from C code, from a `C_ActionGroupActionAddedCallback`.

noActionGroupActionAddedCallback :: Maybe ActionGroupActionAddedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `ActionGroupActionAddedCallback``.

onActionGroupActionAdded :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionAddedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`action-added`” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on actionGroup #actionAdded callback

wrap_ActionGroupActionAddedCallback :: ActionGroupActionAddedCallback -> C_ActionGroupActionAddedCallback Source #

Wrap a `ActionGroupActionAddedCallback` into a `C_ActionGroupActionAddedCallback`.

## actionEnabledChanged

type ActionGroupActionEnabledChangedCallback Source #

Arguments

= Text | `actionName`: the name of the action in `actionGroup`
-> Bool | `enabled`: whether the action is enabled or not
-> IO () |

Signals that the enabled status of the named action has changed.

Since: 2.28

type C_ActionGroupActionEnabledChangedCallback = Ptr () -> CString -> CInt -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterActionGroupActionEnabledChanged :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionEnabledChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`action-enabled-changed`” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after actionGroup #actionEnabledChanged callback

genClosure_ActionGroupActionEnabledChanged :: ActionGroupActionEnabledChangedCallback -> IO Closure Source #

Wrap the callback into a `Closure`.

mk_ActionGroupActionEnabledChangedCallback :: C_ActionGroupActionEnabledChangedCallback -> IO (FunPtr C_ActionGroupActionEnabledChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_ActionGroupActionEnabledChangedCallback`.

noActionGroupActionEnabledChangedCallback :: Maybe ActionGroupActionEnabledChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `ActionGroupActionEnabledChangedCallback``.

onActionGroupActionEnabledChanged :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionEnabledChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`action-enabled-changed`” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on actionGroup #actionEnabledChanged callback

wrap_ActionGroupActionEnabledChangedCallback :: ActionGroupActionEnabledChangedCallback -> C_ActionGroupActionEnabledChangedCallback Source #

Wrap a `ActionGroupActionEnabledChangedCallback` into a `C_ActionGroupActionEnabledChangedCallback`.

## actionRemoved

type ActionGroupActionRemovedCallback Source #

Arguments

= Text | `actionName`: the name of the action in `actionGroup`
-> IO () |

Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

Since: 2.28

type C_ActionGroupActionRemovedCallback = Ptr () -> CString -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterActionGroupActionRemoved :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionRemovedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`action-removed`” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after actionGroup #actionRemoved callback

genClosure_ActionGroupActionRemoved :: ActionGroupActionRemovedCallback -> IO Closure Source #

Wrap the callback into a `Closure`.

mk_ActionGroupActionRemovedCallback :: C_ActionGroupActionRemovedCallback -> IO (FunPtr C_ActionGroupActionRemovedCallback) Source #

Generate a function pointer callable from C code, from a `C_ActionGroupActionRemovedCallback`.

noActionGroupActionRemovedCallback :: Maybe ActionGroupActionRemovedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `ActionGroupActionRemovedCallback``.

onActionGroupActionRemoved :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionRemovedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`action-removed`” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on actionGroup #actionRemoved callback

wrap_ActionGroupActionRemovedCallback :: ActionGroupActionRemovedCallback -> C_ActionGroupActionRemovedCallback Source #

Wrap a `ActionGroupActionRemovedCallback` into a `C_ActionGroupActionRemovedCallback`.

## actionStateChanged

type ActionGroupActionStateChangedCallback Source #

Arguments

= Text | `actionName`: the name of the action in `actionGroup`
-> GVariant | `value`: the new value of the state
-> IO () |

Signals that the state of the named action has changed.

Since: 2.28

type C_ActionGroupActionStateChangedCallback = Ptr () -> CString -> Ptr GVariant -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

afterActionGroupActionStateChanged :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionStateChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`action-state-changed`” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

    after actionGroup #actionStateChanged callback

genClosure_ActionGroupActionStateChanged :: ActionGroupActionStateChangedCallback -> IO Closure Source #

Wrap the callback into a `Closure`.

mk_ActionGroupActionStateChangedCallback :: C_ActionGroupActionStateChangedCallback -> IO (FunPtr C_ActionGroupActionStateChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_ActionGroupActionStateChangedCallback`.

noActionGroupActionStateChangedCallback :: Maybe ActionGroupActionStateChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `ActionGroupActionStateChangedCallback``.

onActionGroupActionStateChanged :: (IsActionGroup a, MonadIO m) => a -> ActionGroupActionStateChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “`action-state-changed`” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

    on actionGroup #actionStateChanged callback

wrap_ActionGroupActionStateChangedCallback :: ActionGroupActionStateChangedCallback -> C_ActionGroupActionStateChangedCallback Source #

Wrap a `ActionGroupActionStateChangedCallback` into a `C_ActionGroupActionStateChangedCallback`.