GI.Gtk.Structs.ToggleActionEntry

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

Exported types

newtype ToggleActionEntry

Memory-managed wrapper type.

Constructors

ToggleActionEntry (ManagedPtr ToggleActionEntry)

Instances

Eq ToggleActionEntry

Defined in GI.Gtk.Structs.ToggleActionEntry

Methods

(==) :: ToggleActionEntry -> ToggleActionEntry -> Bool

(/=) :: ToggleActionEntry -> ToggleActionEntry -> Bool

BoxedPtr ToggleActionEntry

Defined in GI.Gtk.Structs.ToggleActionEntry

Methods

boxedPtrCopy :: ToggleActionEntry -> IO ToggleActionEntry

boxedPtrFree :: ToggleActionEntry -> IO ()

CallocPtr ToggleActionEntry

Defined in GI.Gtk.Structs.ToggleActionEntry

Methods

boxedPtrCalloc :: IO (Ptr ToggleActionEntry)

ManagedPtrNewtype ToggleActionEntry

Defined in GI.Gtk.Structs.ToggleActionEntry

Methods

toManagedPtr :: ToggleActionEntry -> ManagedPtr ToggleActionEntry

tag ~ 'AttrSet => Constructible ToggleActionEntry tag

Defined in GI.Gtk.Structs.ToggleActionEntry

Methods

new :: MonadIO m => (ManagedPtr ToggleActionEntry -> ToggleActionEntry) -> [AttrOp ToggleActionEntry tag] -> m ToggleActionEntry

newZeroToggleActionEntry :: MonadIO m => m ToggleActionEntry

Construct a ToggleActionEntry struct initialized to zero.

Methods

Overloaded methods

Properties

accelerator

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

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

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)

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

get toggleActionEntry #accelerator

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

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

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)

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

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

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

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

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)

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

get toggleActionEntry #label

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

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

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)

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

get toggleActionEntry #name

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

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

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)

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

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

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)

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

get toggleActionEntry #tooltip

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

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

set toggleActionEntry [ #tooltip := value ]