| 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.Gtk.Structs.ActionEntry
Description
ActionEntry structs are used with gtk_action_group_add_actions() to
construct actions.
Synopsis
- newtype ActionEntry = ActionEntry (ManagedPtr ActionEntry)
- newZeroActionEntry :: MonadIO m => m ActionEntry
- noActionEntry :: Maybe ActionEntry
- clearActionEntryAccelerator :: MonadIO m => ActionEntry -> m ()
- getActionEntryAccelerator :: MonadIO m => ActionEntry -> m (Maybe Text)
- setActionEntryAccelerator :: MonadIO m => ActionEntry -> CString -> m ()
- clearActionEntryCallback :: MonadIO m => ActionEntry -> m ()
- getActionEntryCallback :: MonadIO m => ActionEntry -> m (Maybe Callback)
- setActionEntryCallback :: MonadIO m => ActionEntry -> FunPtr C_Callback -> m ()
- clearActionEntryLabel :: MonadIO m => ActionEntry -> m ()
- getActionEntryLabel :: MonadIO m => ActionEntry -> m (Maybe Text)
- setActionEntryLabel :: MonadIO m => ActionEntry -> CString -> m ()
- clearActionEntryName :: MonadIO m => ActionEntry -> m ()
- getActionEntryName :: MonadIO m => ActionEntry -> m (Maybe Text)
- setActionEntryName :: MonadIO m => ActionEntry -> CString -> m ()
- clearActionEntryStockId :: MonadIO m => ActionEntry -> m ()
- getActionEntryStockId :: MonadIO m => ActionEntry -> m (Maybe Text)
- setActionEntryStockId :: MonadIO m => ActionEntry -> CString -> m ()
- clearActionEntryTooltip :: MonadIO m => ActionEntry -> m ()
- getActionEntryTooltip :: MonadIO m => ActionEntry -> m (Maybe Text)
- setActionEntryTooltip :: 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.Gtk.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.Gtk.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
accelerator
The accelerator for the action, in the format understood by
acceleratorParse.
clearActionEntryAccelerator :: MonadIO m => ActionEntry -> m () Source #
Set the value of the “accelerator” field to Nothing.
When overloading is enabled, this is equivalent to
clear #accelerator
getActionEntryAccelerator :: MonadIO m => ActionEntry -> m (Maybe Text) Source #
Get the value of the “accelerator” field.
When overloading is enabled, this is equivalent to
get actionEntry #accelerator
setActionEntryAccelerator :: MonadIO m => ActionEntry -> CString -> m () Source #
Set the value of the “accelerator” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #accelerator:=value ]
callback
The function to call when the action is activated.
clearActionEntryCallback :: MonadIO m => ActionEntry -> m () Source #
Set the value of the “callback” field to Nothing.
When overloading is enabled, this is equivalent to
clear #callback
getActionEntryCallback :: MonadIO m => ActionEntry -> m (Maybe Callback) Source #
Get the value of the “callback” field.
When overloading is enabled, this is equivalent to
get actionEntry #callback
setActionEntryCallback :: MonadIO m => ActionEntry -> FunPtr C_Callback -> m () Source #
Set the value of the “callback” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #callback:=value ]
label
The label for the action. This field should typically be marked
for translation, see actionGroupSetTranslationDomain. If
label is Nothing, the label of the stock item with id stockId is used.
clearActionEntryLabel :: MonadIO m => ActionEntry -> m () Source #
Set the value of the “label” field to Nothing.
When overloading is enabled, this is equivalent to
clear #label
getActionEntryLabel :: MonadIO m => ActionEntry -> m (Maybe Text) Source #
Get the value of the “label” field.
When overloading is enabled, this is equivalent to
get actionEntry #label
setActionEntryLabel :: MonadIO m => ActionEntry -> CString -> m () Source #
Set the value of the “label” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #label:=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 ]
stockId
The stock id for the action, or the name of an icon from the icon theme.
clearActionEntryStockId :: MonadIO m => ActionEntry -> m () Source #
Set the value of the “stock_id” field to Nothing.
When overloading is enabled, this is equivalent to
clear #stockId
getActionEntryStockId :: MonadIO m => ActionEntry -> m (Maybe Text) Source #
Get the value of the “stock_id” field.
When overloading is enabled, this is equivalent to
get actionEntry #stockId
setActionEntryStockId :: MonadIO m => ActionEntry -> CString -> m () Source #
Set the value of the “stock_id” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #stockId:=value ]
tooltip
The tooltip for the action. This field should typically be
marked for translation, see actionGroupSetTranslationDomain.
clearActionEntryTooltip :: MonadIO m => ActionEntry -> m () Source #
Set the value of the “tooltip” field to Nothing.
When overloading is enabled, this is equivalent to
clear #tooltip
getActionEntryTooltip :: MonadIO m => ActionEntry -> m (Maybe Text) Source #
Get the value of the “tooltip” field.
When overloading is enabled, this is equivalent to
get actionEntry #tooltip
setActionEntryTooltip :: MonadIO m => ActionEntry -> CString -> m () Source #
Set the value of the “tooltip” field.
When overloading is enabled, this is equivalent to
setactionEntry [ #tooltip:=value ]