Source code Contents Index

Indicator

Description

HTk's menuitem indicators. Indicators are displayed with menu checkbuttons, menu buttons and menu radiobuttons.

Synopsis

data Indicator a = Indicator a class (GUIObject w) => HasColour w where legalColourID :: w -> ConfigID -> Bool setColour :: w -> ConfigID -> Colour -> IO w getColour :: w -> ConfigID -> IO Colour class (GUIObject w) => HasPhoto w where photo :: Image -> Config w getPhoto :: w -> IO (Maybe Image) class (ButtonWidget w) => SelectButton w where selectionState :: Toggle -> Config w getSelectionState :: w -> IO Toggle selectionStateSet :: w -> Event Toggle class (GUIObject w) => HasIndicator w where indicator :: Toggle -> Config w getIndicator :: w -> IO Toggle

Documentation

data Indicator a

The Indicator datatype. Constructors Indicator a Instances (HasIndicator w) => GUIObject (Indicator w) (HasIndicator w, SelectButton w) => HasColour (Indicator w) (HasIndicator w, SelectButton w) => HasPhoto (Indicator w)

class (GUIObject w) => HasColour w where

Coloured objects instantiate the class HasColour. Methods legalColourID :: w -> ConfigID -> Bool Internal. setColour :: w -> ConfigID -> Colour -> IO w Internal. getColour :: w -> ConfigID -> IO Colour Internal. Instances HasColour BitMap HasColour Box HasColour Button HasColour Canvas HasColour (CheckButton a) HasColour (ComboBox a) HasColour Editor HasColour (Entry a) HasColour Frame (HasInsertionCursor w, Widget w) => HasColour (ICursor w) HasColour IconBar HasColour Image (HasIndicator w, SelectButton w) => HasColour (Indicator w) HasColour (InputForm a) HasColour (EntryField a b) HasColour (TextField a b) HasColour (EnumField a b) HasColour (RecordField a b) HasColour Label HasColour LabelFrame HasColour (ListBox a) HasColour Menu HasColour MenuButton HasColour MenuCascade HasColour MenuCheckButton HasColour MenuCommand HasColour MenuRadioButton HasColour Message HasColour NoteBookPage HasColour (Notepad a) HasColour (OptionMenu a) HasColour Pane HasColour (Prompt a) HasColour (RadioButton a) HasColour (Scale a) HasColour ScrollBar (HasColour a, HasScroller a) => HasColour (ScrollBox a) HasColour SelectBox (HasSelection w, Widget w) => HasColour (Selection w) (HasSlider w, GUIObject w) => HasColour (Slider w) HasColour Space HasColour SpinButton HasColour TextTag (CItem c) => HasColour (TreeList c)

class (GUIObject w) => HasPhoto w where

Image containers instantiate the class HasPhoto. Methods photo :: Image -> Config w Associates an image container (e.g. a label) with the given image. getPhoto :: w -> IO (Maybe Image) Gets the image associated with the given image container. Instances HasPhoto Button HasPhoto (CheckButton a) HasPhoto (Dialog a) HasPhoto ImageItem (HasIndicator w, SelectButton w) => HasPhoto (Indicator w) HasPhoto Label HasPhoto MenuButton HasPhoto MenuCascade HasPhoto MenuCheckButton HasPhoto MenuCommand HasPhoto MenuRadioButton HasPhoto (RadioButton a) (CItem a) => HasPhoto (TREELISTOBJECT a)

class (ButtonWidget w) => SelectButton w where

A select button can be selected or not selected. Methods selectionState :: Toggle -> Config w Sets the selection state of the select button. getSelectionState :: w -> IO Toggle Gets the selection state of the select button selectionStateSet :: w -> Event Toggle Returns an event for selection actions.

class (GUIObject w) => HasIndicator w where

Menu items that can have an indicator instantiate the class HasIndicator. Methods indicator :: Toggle -> Config w Displays/unmaps the items indicator. getIndicator :: w -> IO Toggle On if an indicator is displayed with the item, otherwise Off. Instances HasIndicator GUIOBJECT HasIndicator MenuCascade HasIndicator MenuCheckButton HasIndicator MenuCommand HasIndicator MenuRadioButton

Produced by Haddock version 0.3