gi-gtk3-3.0.44: Gtk 3.x 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.ToggleActionEntry

Contents

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

Description

`ToggleActionEntry` structs are used with `gtk_action_group_add_toggle_actions()` to construct toggle actions.

Synopsis

- newtype ToggleActionEntry = ToggleActionEntry (ManagedPtr ToggleActionEntry)
- newZeroToggleActionEntry :: MonadIO m => m ToggleActionEntry
- clearToggleActionEntryAccelerator :: MonadIO m => ToggleActionEntry -> m ()
- getToggleActionEntryAccelerator :: MonadIO m => ToggleActionEntry -> m (Maybe Text)
- setToggleActionEntryAccelerator :: MonadIO m => ToggleActionEntry -> CString -> m ()
- clearToggleActionEntryCallback :: MonadIO m => ToggleActionEntry -> m ()
- getToggleActionEntryCallback :: MonadIO m => ToggleActionEntry -> m (Maybe Callback)
- setToggleActionEntryCallback :: MonadIO m => ToggleActionEntry -> FunPtr C_Callback -> m ()
- getToggleActionEntryIsActive :: MonadIO m => ToggleActionEntry -> m Bool
- setToggleActionEntryIsActive :: MonadIO m => ToggleActionEntry -> Bool -> m ()
- clearToggleActionEntryLabel :: MonadIO m => ToggleActionEntry -> m ()
- getToggleActionEntryLabel :: MonadIO m => ToggleActionEntry -> m (Maybe Text)
- setToggleActionEntryLabel :: MonadIO m => ToggleActionEntry -> CString -> m ()
- clearToggleActionEntryName :: MonadIO m => ToggleActionEntry -> m ()
- getToggleActionEntryName :: MonadIO m => ToggleActionEntry -> m (Maybe Text)
- setToggleActionEntryName :: MonadIO m => ToggleActionEntry -> CString -> m ()
- clearToggleActionEntryStockId :: MonadIO m => ToggleActionEntry -> m ()
- getToggleActionEntryStockId :: MonadIO m => ToggleActionEntry -> m (Maybe Text)
- setToggleActionEntryStockId :: MonadIO m => ToggleActionEntry -> CString -> m ()
- clearToggleActionEntryTooltip :: MonadIO m => ToggleActionEntry -> m ()
- getToggleActionEntryTooltip :: MonadIO m => ToggleActionEntry -> m (Maybe Text)
- setToggleActionEntryTooltip :: MonadIO m => ToggleActionEntry -> CString -> m ()

# Exported types

newtype ToggleActionEntry Source #

Memory-managed wrapper type.

Constructors

ToggleActionEntry (ManagedPtr ToggleActionEntry) |

#### Instances

Instances details

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

newZeroToggleActionEntry :: MonadIO m => m ToggleActionEntry Source #

Construct a `ToggleActionEntry` struct initialized to zero.

# Methods

# Properties

## accelerator

The accelerator for the action, in the format understood by `acceleratorParse`.

clearToggleActionEntryAccelerator :: MonadIO m => ToggleActionEntry -> m () Source #

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

    clear #accelerator

getToggleActionEntryAccelerator :: MonadIO m => ToggleActionEntry -> m (Maybe Text) Source #

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

    get toggleActionEntry #accelerator

setToggleActionEntryAccelerator :: MonadIO m => ToggleActionEntry -> CString -> m () Source #

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

    set toggleActionEntry [ #accelerator := value ]

## callback

The function to call when the action is activated.

clearToggleActionEntryCallback :: MonadIO m => ToggleActionEntry -> m () Source #

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

    clear #callback

getToggleActionEntryCallback :: MonadIO m => ToggleActionEntry -> m (Maybe Callback) Source #

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

    get toggleActionEntry #callback

setToggleActionEntryCallback :: MonadIO m => ToggleActionEntry -> FunPtr C_Callback -> m () Source #

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

    set toggleActionEntry [ #callback := value ]

## isActive

The initial state of the toggle action.

getToggleActionEntryIsActive :: MonadIO m => ToggleActionEntry -> m Bool Source #

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

    get toggleActionEntry #isActive

setToggleActionEntryIsActive :: MonadIO m => ToggleActionEntry -> Bool -> m () Source #

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

    set toggleActionEntry [ #isActive := value ]

## label

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

clearToggleActionEntryLabel :: MonadIO m => ToggleActionEntry -> m () Source #

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

    clear #label

getToggleActionEntryLabel :: MonadIO m => ToggleActionEntry -> m (Maybe Text) Source #

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

    get toggleActionEntry #label

setToggleActionEntryLabel :: MonadIO m => ToggleActionEntry -> CString -> m () Source #

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

    set toggleActionEntry [ #label := value ]

## name

The name of the action.

clearToggleActionEntryName :: MonadIO m => ToggleActionEntry -> m () Source #

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

    clear #name

getToggleActionEntryName :: MonadIO m => ToggleActionEntry -> m (Maybe Text) Source #

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

    get toggleActionEntry #name

setToggleActionEntryName :: MonadIO m => ToggleActionEntry -> CString -> m () Source #

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

    set toggleActionEntry [ #name := value ]

## stockId

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

clearToggleActionEntryStockId :: MonadIO m => ToggleActionEntry -> m () Source #

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

    clear #stockId

getToggleActionEntryStockId :: MonadIO m => ToggleActionEntry -> m (Maybe Text) Source #

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

    get toggleActionEntry #stockId

setToggleActionEntryStockId :: MonadIO m => ToggleActionEntry -> CString -> m () Source #

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

    set toggleActionEntry [ #stockId := value ]

## tooltip

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

clearToggleActionEntryTooltip :: MonadIO m => ToggleActionEntry -> m () Source #

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

    clear #tooltip

getToggleActionEntryTooltip :: MonadIO m => ToggleActionEntry -> m (Maybe Text) Source #

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

    get toggleActionEntry #tooltip

setToggleActionEntryTooltip :: MonadIO m => ToggleActionEntry -> CString -> m () Source #

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

    set toggleActionEntry [ #tooltip := value ]