Graphics.UI.Gtk.General.StockItems

Gtk2Hs

Contents

Index

Description

A StockItem is a resource that is know throughout Gtk.

Defining you own IconSets as StockItems will make it possible for Gtk to choose the most appropriate sizes and enables themes to override your built in icons. A couple of constants are defined here as well. They are useful in accessing Gtk's predefined items.
The StockItem structure is completely marshaled to haskell. It is possible to marshal all strings lazily because the string pointers are valid throughout the lifetime of the application. The only drawback it that a stock item that is replaced by the another item with the same name will never be freed. This deficiency is built into Gtk however.

Synopsis

data StockItem = StockItem {

siStockId :: StockId

siLabel :: String

siModifier :: Modifier

siKeyval :: Integer

siTransDom :: String

}

type StockId = String

siStockId :: StockItem -> StockId

siLabel :: StockItem -> String

siModifier :: StockItem -> Modifier

siKeyval :: StockItem -> Integer

siTransDom :: StockItem -> String

stockAddItem :: [StockItem] -> IO ()

stockLookupItem :: StockId -> IO (Maybe StockItem)

stockListIds :: IO [StockId]

stockAdd :: StockId

stockApply :: StockId

stockBold :: StockId

stockCancel :: StockId

stockCDROM :: StockId

stockClear :: StockId

stockClose :: StockId

stockColorPicker :: StockId

stockConvert :: StockId

stockCopy :: StockId

stockCut :: StockId

stockDelete :: StockId

stockDialogError :: StockId

stockDialogInfo :: StockId

stockDialogQuestion :: StockId

stockDialogWarning :: StockId

stockDnd :: StockId

stockDndMultiple :: StockId

stockExecute :: StockId

stockFind :: StockId

stockFindAndRelpace :: StockId

stockFloppy :: StockId

stockGotoBottom :: StockId

stockGotoFirst :: StockId

stockGotoLast :: StockId

stockGotoTop :: StockId

stockGoBack :: StockId

stockGoDown :: StockId

stockGoForward :: StockId

stockGoUp :: StockId

stockHelp :: StockId

stockHome :: StockId

stockIndex :: StockId

stockItalic :: StockId

stockJumpTo :: StockId

stockJustifyCenter :: StockId

stockJustifyFill :: StockId

stockJustifyLeft :: StockId

stockJustifyRight :: StockId

stockMissingImage :: StockId

stockNew :: StockId

stockNo :: StockId

stockOk :: StockId

stockOpen :: StockId

stockPaste :: StockId

stockPreferences :: StockId

stockPrint :: StockId

stockPrintPreview :: StockId

stockProperties :: StockId

stockQuit :: StockId

stockRedo :: StockId

stockRefresh :: StockId

stockRemove :: StockId

stockRevertToSaved :: StockId

stockSave :: StockId

stockSaveAs :: StockId

stockSelectColor :: StockId

stockSelectFont :: StockId

stockSortAscending :: StockId

stockSortDescending :: StockId

stockSpellCheck :: StockId

stockStop :: StockId

stockStrikethrough :: StockId

stockUndelete :: StockId

stockUnderline :: StockId

stockUndo :: StockId

stockYes :: StockId

stockZoom100 :: StockId

stockZoomFit :: StockId

stockZoomIn :: StockId

stockZoomOut :: StockId

Documentation

data StockItem

Constructors

StockItem

siStockId :: StockId
siLabel :: String
siModifier :: Modifier
siKeyval :: Integer
siTransDom :: String

Instances

Storable StockItem

type StockId = String

A synonym for a standard button or icon.

siStockId :: StockItem -> StockId

siLabel :: StockItem -> String

siModifier :: StockItem -> Modifier

siKeyval :: StockItem -> Integer

siTransDom :: StockItem -> String

stockAddItem :: [StockItem] -> IO ()

Add new stock items to Gtk.

stockLookupItem :: StockId -> IO (Maybe StockItem)

Lookup an item in stock.

stockListIds :: IO [StockId]

Produce a list of all known stock identifiers.

Retrieve a list of all known stock identifiers. These can either be added by stockAddItem or by adding items to a IconFactory.
The list is sorted alphabetically (sorting is not Unicode aware).

stockAdd :: StockId

Standard icon and menu entry.

This icon is only available in Gtk 2.2 or higher.

stockApply :: StockId

stockBold :: StockId

stockCancel :: StockId

stockCDROM :: StockId

stockClear :: StockId

stockClose :: StockId

stockColorPicker :: StockId

stockConvert :: StockId

stockCopy :: StockId

stockCut :: StockId

stockDelete :: StockId

stockDialogError :: StockId

stockDialogInfo :: StockId

stockDialogQuestion :: StockId

stockDialogWarning :: StockId

stockDnd :: StockId

stockDndMultiple :: StockId

stockExecute :: StockId

stockFind :: StockId

stockFindAndRelpace :: StockId

stockFloppy :: StockId

stockGotoBottom :: StockId

stockGotoFirst :: StockId

stockGotoLast :: StockId

stockGotoTop :: StockId

stockGoBack :: StockId

stockGoDown :: StockId

stockGoForward :: StockId

stockGoUp :: StockId

stockHelp :: StockId

stockHome :: StockId

stockIndex :: StockId

stockItalic :: StockId

stockJumpTo :: StockId

stockJustifyCenter :: StockId

stockJustifyFill :: StockId

stockJustifyLeft :: StockId

stockJustifyRight :: StockId

stockMissingImage :: StockId

stockNew :: StockId

stockNo :: StockId

stockOk :: StockId

stockOpen :: StockId

stockPaste :: StockId

stockPreferences :: StockId

stockPrint :: StockId

stockPrintPreview :: StockId

stockProperties :: StockId

stockQuit :: StockId

stockRedo :: StockId

stockRefresh :: StockId

stockRemove :: StockId

stockRevertToSaved :: StockId

stockSave :: StockId

stockSaveAs :: StockId

stockSelectColor :: StockId

stockSelectFont :: StockId

stockSortAscending :: StockId

stockSortDescending :: StockId

stockSpellCheck :: StockId

stockStop :: StockId

stockStrikethrough :: StockId

stockUndelete :: StockId

stockUnderline :: StockId

stockUndo :: StockId

stockYes :: StockId

stockZoom100 :: StockId

stockZoomFit :: StockId

stockZoomIn :: StockId

stockZoomOut :: StockId

Produced by Haddock version 0.6