gi-gtk-3.0.43: Gtk bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Structs.ActionEntry

Contents

- Exported types
- Methods
- Properties
  - accelerator
  - callback
  - label
  - name
  - stockId
  - tooltip

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

Instances details

Eq ActionEntry Source # |
Instance details Defined in GI.Gtk.Structs.ActionEntry Methods (==) :: ActionEntry -> ActionEntry -> Bool Source # (/=) :: ActionEntry -> ActionEntry -> Bool Source #
BoxedPtr ActionEntry Source # |
Instance details Defined in GI.Gtk.Structs.ActionEntry Methods boxedPtrCopy :: ActionEntry -> IO ActionEntry Source # boxedPtrFree :: ActionEntry -> IO () Source #
CallocPtr ActionEntry Source # |
Instance details Defined in GI.Gtk.Structs.ActionEntry Methods boxedPtrCalloc :: IO (Ptr ActionEntry) Source #
ManagedPtrNewtype ActionEntry Source # |
Instance details Defined in GI.Gtk.Structs.ActionEntry Methods toManagedPtr :: ActionEntry -> ManagedPtr ActionEntry Source #
tag ~ 'AttrSet => Constructible ActionEntry tag Source # |
Instance details Defined in GI.Gtk.Structs.ActionEntry Methods new :: MonadIO m => (ManagedPtr ActionEntry -> ActionEntry) -> [AttrOp ActionEntry tag] -> m ActionEntry Source #

newZeroActionEntry :: MonadIO m => m ActionEntry Source #

Construct a `ActionEntry` struct initialized to zero.

# Methods

# 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

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

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

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

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

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

    set actionEntry [ #tooltip := value ]