| 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.Structs.ActionEntry
Description
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.
Synopsis
- newtype ActionEntry = ActionEntry (ManagedPtr ActionEntry)
- newZeroActionEntry :: MonadIO m => m ActionEntry
- noActionEntry :: Maybe ActionEntry
- clearActionEntryActivate :: MonadIO m => ActionEntry -> m ()
- getActionEntryActivate :: MonadIO m => ActionEntry -> m (Maybe ActionEntryActivateFieldCallback_WithClosures)
- setActionEntryActivate :: MonadIO m => ActionEntry -> FunPtr C_ActionEntryActivateFieldCallback -> m ()
- clearActionEntryChangeState :: MonadIO m => ActionEntry -> m ()
- getActionEntryChangeState :: MonadIO m => ActionEntry -> m (Maybe ActionEntryChangeStateFieldCallback_WithClosures)
- setActionEntryChangeState :: MonadIO m => ActionEntry -> FunPtr C_ActionEntryChangeStateFieldCallback -> m ()
- clearActionEntryName :: MonadIO m => ActionEntry -> m ()
- getActionEntryName :: MonadIO m => ActionEntry -> m (Maybe Text)
- setActionEntryName :: MonadIO m => ActionEntry -> CString -> m ()
- clearActionEntryParameterType :: MonadIO m => ActionEntry -> m ()
- getActionEntryParameterType :: MonadIO m => ActionEntry -> m (Maybe Text)
- setActionEntryParameterType :: MonadIO m => ActionEntry -> CString -> m ()
- clearActionEntryState :: MonadIO m => ActionEntry -> m ()
- getActionEntryState :: MonadIO m => ActionEntry -> m (Maybe Text)
- setActionEntryState :: MonadIO m => ActionEntry -> CString -> m ()
Exported types
newtype ActionEntry Source #
Memory-managed wrapper type.
Constructors
| ActionEntry (ManagedPtr ActionEntry) |
Instances
| WrappedPtr ActionEntry Source # | |
Defined in GI.Gio.Structs.ActionEntry Methods wrappedPtrCalloc :: IO (Ptr ActionEntry) # wrappedPtrCopy :: ActionEntry -> IO ActionEntry # wrappedPtrFree :: Maybe (FunPtr (Ptr ActionEntry -> IO ())) # | |
| tag ~ AttrSet => Constructible ActionEntry tag Source # | |
Defined in GI.Gio.Structs.ActionEntry Methods new :: MonadIO m => (ManagedPtr ActionEntry -> ActionEntry) -> [AttrOp ActionEntry tag] -> m ActionEntry # | |
newZeroActionEntry :: MonadIO m => m ActionEntry Source #
Construct a ActionEntry struct initialized to zero.
noActionEntry :: Maybe ActionEntry Source #
A convenience alias for Nothing :: Maybe ActionEntry.
Properties
activate
No description available in the introspection data.
clearActionEntryActivate :: MonadIO m => ActionEntry -> m () Source #
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) Source #
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 () Source #
Set the value of the “activate” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #activate:=value ]
changeState
No description available in the introspection data.
clearActionEntryChangeState :: MonadIO m => ActionEntry -> m () Source #
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) Source #
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 () Source #
Set the value of the “change_state” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #changeState:=value ]
name
the name of the action
clearActionEntryName :: MonadIO m => ActionEntry -> m () Source #
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) Source #
Get the value of the “name” field.
When overloading is enabled, this is equivalent to
get actionEntry #name
setActionEntryName :: MonadIO m => ActionEntry -> CString -> m () Source #
Set the value of the “name” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #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 () Source #
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) Source #
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 () Source #
Set the value of the “parameter_type” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #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 () Source #
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) Source #
Get the value of the “state” field.
When overloading is enabled, this is equivalent to
get actionEntry #state
setActionEntryState :: MonadIO m => ActionEntry -> CString -> m () Source #
Set the value of the “state” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #state:=value ]