GI.Gtk.Structs.ActionEntry

ActionEntry structs are used with gtk_action_group_add_actions() to construct actions.

Exported types

newtype ActionEntry

Memory-managed wrapper type.

Constructors

ActionEntry (ManagedPtr ActionEntry)

Instances

WrappedPtr ActionEntry

Defined in GI.Gtk.Structs.ActionEntry

Methods

wrappedPtrCalloc :: IO (Ptr ActionEntry)

wrappedPtrCopy :: ActionEntry -> IO ActionEntry

wrappedPtrFree :: Maybe (GDestroyNotify ActionEntry)

tag ~ AttrSet => Constructible ActionEntry tag

Defined in GI.Gtk.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.

noActionEntry :: Maybe ActionEntry

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 ()

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)

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

get actionEntry #accelerator

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

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

set actionEntry [ #accelerator := value ]

callback

The function to call when the action is activated.

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

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)

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 ()

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

set actionEntry [ #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 ()

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)

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

get actionEntry #label

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

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

set actionEntry [ #label := 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 ]

stockId

The stock id for the action, or the name of an icon from the icon theme.

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

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)

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 ()

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

set actionEntry [ #stockId := value ]

tooltip

The tooltip for the action. This field should typically be marked for translation, see actionGroupSetTranslationDomain.

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

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)

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

get actionEntry #tooltip

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

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

set actionEntry [ #tooltip := value ]