GI.Gio.Structs.ActionEntry

This struct defines a single action. It is for use with actionMapAddActionEntries.

The order of the items in the structure are intended to reflect frequency of use. It is permissible to use an incomplete initialiser in order to leave some of the later values as Nothing. All values after name are optional. Additional optional fields may be added in the future.

See actionMapAddActionEntries for an example.

Exported types

newtype ActionEntry

Memory-managed wrapper type.

Constructors

ActionEntry (ManagedPtr ActionEntry)

Instances

Eq ActionEntry

Defined in GI.Gio.Structs.ActionEntry

Methods

(==) :: ActionEntry -> ActionEntry -> Bool

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

BoxedPtr ActionEntry

Defined in GI.Gio.Structs.ActionEntry

Methods

boxedPtrCopy :: ActionEntry -> IO ActionEntry

boxedPtrFree :: ActionEntry -> IO ()

CallocPtr ActionEntry

Defined in GI.Gio.Structs.ActionEntry

Methods

boxedPtrCalloc :: IO (Ptr ActionEntry)

ManagedPtrNewtype ActionEntry

Defined in GI.Gio.Structs.ActionEntry

Methods

toManagedPtr :: ActionEntry -> ManagedPtr ActionEntry

tag ~ 'AttrSet => Constructible ActionEntry tag

Defined in GI.Gio.Structs.ActionEntry

Methods

new :: MonadIO m => (ManagedPtr ActionEntry -> ActionEntry) -> [AttrOp ActionEntry tag] -> m ActionEntry

newZeroActionEntry :: MonadIO m => m ActionEntry

Construct a ActionEntry struct initialized to zero.

Methods

Properties

activate

the callback to connect to the "activate" signal of the action. Since GLib 2.40, this can be Nothing for stateful actions, in which case the default handler is used. For boolean-stated actions with no parameter, this is a toggle. For other state types (and parameter type equal to the state type) this will be a function that just calls changeState (which you should provide).

clearActionEntryActivate :: MonadIO m => ActionEntry -> m ()

Set the value of the “activate” field to Nothing. When overloading is enabled, this is equivalent to

clear #activate

getActionEntryActivate :: MonadIO m => ActionEntry -> m (Maybe ActionEntryActivateFieldCallback_WithClosures)

Get the value of the “activate” field. When overloading is enabled, this is equivalent to

get actionEntry #activate

setActionEntryActivate :: MonadIO m => ActionEntry -> FunPtr C_ActionEntryActivateFieldCallback -> m ()

Set the value of the “activate” field. When overloading is enabled, this is equivalent to

set actionEntry [ #activate := value ]

changeState

the callback to connect to the "change-state" signal of the action. All stateful actions should provide a handler here; stateless actions should not.

clearActionEntryChangeState :: MonadIO m => ActionEntry -> m ()

Set the value of the “change_state” field to Nothing. When overloading is enabled, this is equivalent to

clear #changeState

getActionEntryChangeState :: MonadIO m => ActionEntry -> m (Maybe ActionEntryChangeStateFieldCallback_WithClosures)

Get the value of the “change_state” field. When overloading is enabled, this is equivalent to

get actionEntry #changeState

setActionEntryChangeState :: MonadIO m => ActionEntry -> FunPtr C_ActionEntryChangeStateFieldCallback -> m ()

Set the value of the “change_state” field. When overloading is enabled, this is equivalent to

set actionEntry [ #changeState := value ]

name

the name of the action

clearActionEntryName :: MonadIO m => ActionEntry -> m ()

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

clear #name

getActionEntryName :: MonadIO m => ActionEntry -> m (Maybe Text)

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

get actionEntry #name

setActionEntryName :: MonadIO m => ActionEntry -> CString -> m ()

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

set actionEntry [ #name := value ]

parameterType

the type of the parameter that must be passed to the activate function for this action, given as a single GVariant type string (or Nothing for no parameter)

clearActionEntryParameterType :: MonadIO m => ActionEntry -> m ()

Set the value of the “parameter_type” field to Nothing. When overloading is enabled, this is equivalent to

clear #parameterType

getActionEntryParameterType :: MonadIO m => ActionEntry -> m (Maybe Text)

Get the value of the “parameter_type” field. When overloading is enabled, this is equivalent to

get actionEntry #parameterType

setActionEntryParameterType :: MonadIO m => ActionEntry -> CString -> m ()

Set the value of the “parameter_type” field. When overloading is enabled, this is equivalent to

set actionEntry [ #parameterType := value ]

state

the initial state for this action, given in [GVariant text format][gvariant-text]. The state is parsed with no extra type information, so type tags must be added to the string if they are necessary. Stateless actions should give Nothing here.

clearActionEntryState :: MonadIO m => ActionEntry -> m ()

Set the value of the “state” field to Nothing. When overloading is enabled, this is equivalent to

clear #state

getActionEntryState :: MonadIO m => ActionEntry -> m (Maybe Text)

Get the value of the “state” field. When overloading is enabled, this is equivalent to

get actionEntry #state

setActionEntryState :: MonadIO m => ActionEntry -> CString -> m ()

Set the value of the “state” field. When overloading is enabled, this is equivalent to

set actionEntry [ #state := value ]