GI.Gtk.Structs.StockItem

No description available in the introspection data.

Exported types

newtype StockItem

Memory-managed wrapper type.

Constructors

StockItem (ManagedPtr StockItem)

Instances

Eq StockItem

Defined in GI.Gtk.Structs.StockItem

Methods

(==) :: StockItem -> StockItem -> Bool

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

WrappedPtr StockItem

Defined in GI.Gtk.Structs.StockItem

Methods

wrappedPtrCalloc :: IO (Ptr StockItem)

wrappedPtrCopy :: StockItem -> IO StockItem

wrappedPtrFree :: Maybe (GDestroyNotify StockItem)

tag ~ 'AttrSet => Constructible StockItem tag

Defined in GI.Gtk.Structs.StockItem

Methods

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

newZeroStockItem :: MonadIO m => m StockItem

Construct a StockItem struct initialized to zero.

noStockItem :: Maybe StockItem

A convenience alias for Nothing :: Maybe StockItem.

Methods

Overloaded methods

free

stockItemFree

Arguments

:: (HasCallStack, MonadIO m)

=> StockItem

item: a StockItem

-> m ()

Deprecated: (Since version 3.10)

Frees a stock item allocated on the heap, such as one returned by gtk_stock_item_copy(). Also frees the fields inside the stock item, if they are not Nothing.

Properties

keyval

Keyboard accelerator

getStockItemKeyval :: MonadIO m => StockItem -> m Word32

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

get stockItem #keyval

setStockItemKeyval :: MonadIO m => StockItem -> Word32 -> m ()

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

set stockItem [ #keyval := value ]

label

User visible label.

clearStockItemLabel :: MonadIO m => StockItem -> m ()

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

clear #label

getStockItemLabel :: MonadIO m => StockItem -> m (Maybe Text)

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

get stockItem #label

setStockItemLabel :: MonadIO m => StockItem -> CString -> m ()

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

set stockItem [ #label := value ]

modifier

Modifier type for keyboard accelerator

getStockItemModifier :: MonadIO m => StockItem -> m [ModifierType]

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

get stockItem #modifier

setStockItemModifier :: MonadIO m => StockItem -> [ModifierType] -> m ()

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

set stockItem [ #modifier := value ]

stockId

Identifier.

clearStockItemStockId :: MonadIO m => StockItem -> m ()

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

clear #stockId

getStockItemStockId :: MonadIO m => StockItem -> m (Maybe Text)

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

get stockItem #stockId

setStockItemStockId :: MonadIO m => StockItem -> CString -> m ()

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

set stockItem [ #stockId := value ]

translationDomain

Translation domain of the menu or toolbar item

clearStockItemTranslationDomain :: MonadIO m => StockItem -> m ()

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

clear #translationDomain

getStockItemTranslationDomain :: MonadIO m => StockItem -> m (Maybe Text)

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

get stockItem #translationDomain

setStockItemTranslationDomain :: MonadIO m => StockItem -> CString -> m ()

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

set stockItem [ #translationDomain := value ]