gi-gtk-3.0.26: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Structs.StockItem

Contents

Description

No description available in the introspection data.

Synopsis

Exported types

newtype StockItem Source #

Memory-managed wrapper type.

newZeroStockItem :: MonadIO m => m StockItem Source #

Construct a StockItem struct initialized to zero.

noStockItem :: Maybe StockItem Source #

A convenience alias for Nothing :: Maybe StockItem.

Methods

free

stockItemFree Source #

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

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

get stockItem #keyval

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

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

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) Source #

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

get stockItem #label

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

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] Source #

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

get stockItem #modifier

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

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

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) Source #

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

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

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) Source #

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

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

set stockItem [ #translationDomain := value ]