gtk-0.12.2: Binding to the Gtk+ graphical user interface library.

Portability | portable (depends on GHC)
Stability | provisional
Maintainer | gtk2hs-users@lists.sourceforge.net

Graphics.UI.Gtk.General.StockItems

Description

A StockItem is a resource that is know throughout Gtk.

- Defining you own `Graphics.UI.Gtk.General.IconFactory.IconSet`s as `StockItem`s 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.

Synopsis

- data StockItem = StockItem {
  - siStockId :: StockId
  - siLabel :: String
  - siModifier :: [Modifier]
  - siKeyval :: KeyVal
  - siTransDom :: String
  }
- type StockId = String
- stockAddItem :: [StockItem] -> IO ()
- stockLookupItem :: StockId -> IO (Maybe StockItem)
- stockListIds :: IO [StockId]
- stockAbout :: StockId
- stockAdd :: StockId
- stockApply :: StockId
- stockBold :: StockId
- stockCancel :: StockId
- stockCapsLockWarning :: StockId
- stockCDROM :: StockId
- stockClear :: StockId
- stockClose :: StockId
- stockColorPicker :: StockId
- stockConvert :: StockId
- stockConnect :: StockId
- stockCopy :: StockId
- stockCut :: StockId
- stockDelete :: StockId
- stockDialogAuthentication :: StockId
- stockDialogError :: StockId
- stockDialogInfo :: StockId
- stockDialogQuestion :: StockId
- stockDialogWarning :: StockId
- stockDirectory :: StockId
- stockDiscard :: StockId
- stockDisconnect :: StockId
- stockDnd :: StockId
- stockDndMultiple :: StockId
- stockEdit :: StockId
- stockExecute :: StockId
- stockFile :: StockId
- stockFind :: StockId
- stockFindAndRelpace :: StockId
- stockFloppy :: StockId
- stockFullscreen :: StockId
- stockGotoBottom :: StockId
- stockGotoFirst :: StockId
- stockGotoLast :: StockId
- stockGotoTop :: StockId
- stockGoBack :: StockId
- stockGoDown :: StockId
- stockGoForward :: StockId
- stockGoUp :: StockId
- stockHarddisk :: StockId
- stockHelp :: StockId
- stockHome :: StockId
- stockIndent :: StockId
- stockIndex :: StockId
- stockInfo :: StockId
- stockItalic :: StockId
- stockJumpTo :: StockId
- stockJustifyCenter :: StockId
- stockJustifyFill :: StockId
- stockJustifyLeft :: StockId
- stockJustifyRight :: StockId
- stockLeaveFullscreen :: StockId
- stockMediaForward :: StockId
- stockMediaNext :: StockId
- stockMediaPause :: StockId
- stockMediaPlay :: StockId
- stockMediaPrevious :: StockId
- stockMediaRecord :: StockId
- stockMediaRewind :: StockId
- stockMediaStop :: StockId
- stockMissingImage :: StockId
- stockNetwork :: StockId
- stockNew :: StockId
- stockNo :: StockId
- stockOk :: StockId
- stockOpen :: StockId
- stockOrientationLandscape :: StockId
- stockOrientationReverseLandscape :: StockId
- stockOrientationPortrait :: StockId
- stockOrientationReversePortrait :: StockId
- stockPageSetup :: StockId
- stockPaste :: StockId
- stockPreferences :: StockId
- stockPrint :: StockId
- stockPrintError :: StockId
- stockPrintPaused :: StockId
- stockPrintReport :: StockId
- stockPrintWarning :: StockId
- stockPrintPreview :: StockId
- stockProperties :: StockId
- stockQuit :: StockId
- stockRedo :: StockId
- stockRefresh :: StockId
- stockRemove :: StockId
- stockRevertToSaved :: StockId
- stockSave :: StockId
- stockSaveAs :: StockId
- stockSelectAll :: StockId
- stockSelectColor :: StockId
- stockSelectFont :: StockId
- stockSortAscending :: StockId
- stockSortDescending :: StockId
- stockSpellCheck :: StockId
- stockStop :: StockId
- stockStrikethrough :: StockId
- stockUndelete :: StockId
- stockUnderline :: StockId
- stockUndo :: StockId
- stockUnindent :: StockId
- stockYes :: StockId
- stockZoom100 :: StockId
- stockZoomFit :: StockId
- stockZoomIn :: StockId
- stockZoomOut :: StockId

# Documentation

data StockItem

The description of a stock item.

Constructors

StockItem |

Fields

siStockId :: StockId
siLabel :: String
siModifier :: [Modifier]
siKeyval :: KeyVal
siTransDom :: String

Instances

Storable StockItem |

type StockId = String

A synonym for a standard button or icon.

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 `Graphics.UI.Gtk.General.IconFactory.IconFactory`.
- The list is sorted alphabetically (sorting is not Unicode aware).

stockAbout :: StockId

stockAdd :: StockId

stockApply :: StockId

stockBold :: StockId

stockCancel :: StockId

stockCapsLockWarning :: StockId

stockCDROM :: StockId

stockClear :: StockId

stockClose :: StockId

stockColorPicker :: StockId

stockConvert :: StockId

stockConnect :: StockId

stockCopy :: StockId

stockCut :: StockId

stockDelete :: StockId

stockDialogAuthentication :: StockId

stockDialogError :: StockId

stockDialogInfo :: StockId

stockDialogQuestion :: StockId

stockDialogWarning :: StockId

stockDirectory :: StockId

stockDiscard :: StockId

stockDisconnect :: StockId

stockDnd :: StockId

stockDndMultiple :: StockId

stockEdit :: StockId

stockExecute :: StockId

stockFile :: StockId

stockFind :: StockId

stockFindAndRelpace :: StockId

stockFloppy :: StockId

stockFullscreen :: StockId

stockGotoBottom :: StockId

stockGotoFirst :: StockId

stockGotoLast :: StockId

stockGotoTop :: StockId

stockGoBack :: StockId

stockGoDown :: StockId

stockGoForward :: StockId

stockGoUp :: StockId

stockHarddisk :: StockId

stockHelp :: StockId

stockHome :: StockId

stockIndent :: StockId

stockIndex :: StockId

stockInfo :: StockId

stockItalic :: StockId

stockJumpTo :: StockId

stockJustifyCenter :: StockId

stockJustifyFill :: StockId

stockJustifyLeft :: StockId

stockJustifyRight :: StockId

stockLeaveFullscreen :: StockId

stockMediaForward :: StockId

stockMediaNext :: StockId

stockMediaPause :: StockId

stockMediaPlay :: StockId

stockMediaPrevious :: StockId

stockMediaRecord :: StockId

stockMediaRewind :: StockId

stockMediaStop :: StockId

stockMissingImage :: StockId

stockNetwork :: StockId

stockNew :: StockId

stockNo :: StockId

stockOk :: StockId

stockOpen :: StockId

stockOrientationLandscape :: StockId

stockOrientationReverseLandscape :: StockId

stockOrientationPortrait :: StockId

stockOrientationReversePortrait :: StockId

stockPageSetup :: StockId

stockPaste :: StockId

stockPreferences :: StockId

stockPrint :: StockId

stockPrintError :: StockId

stockPrintPaused :: StockId

stockPrintReport :: StockId

stockPrintWarning :: StockId

stockPrintPreview :: StockId

stockProperties :: StockId

stockQuit :: StockId

stockRedo :: StockId

stockRefresh :: StockId

stockRemove :: StockId

stockRevertToSaved :: StockId

stockSave :: StockId

stockSaveAs :: StockId

stockSelectAll :: StockId

stockSelectColor :: StockId

stockSelectFont :: StockId

stockSortAscending :: StockId

stockSortDescending :: StockId

stockSpellCheck :: StockId

stockStop :: StockId

stockStrikethrough :: StockId

stockUndelete :: StockId

stockUnderline :: StockId

stockUndo :: StockId

stockUnindent :: StockId

stockYes :: StockId

stockZoom100 :: StockId

stockZoomFit :: StockId

stockZoomIn :: StockId

stockZoomOut :: StockId