HTk.Menuitems.MenuCommand

HTk's menu command. A simple command inside a menu.

Documentation

data MenuCommand

The MenuCommand datatype.

Instances

Eq MenuCommand

Internal.

Methods

(==) :: MenuCommand -> MenuCommand -> Bool

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

Synchronized MenuCommand

You can synchronize on a menu command.

Methods

synchronize :: MenuCommand -> IO b -> IO b

GUIObject MenuCommand

Internal.

Methods

toGUIObject :: MenuCommand -> GUIOBJECT

cname :: MenuCommand -> String

cset :: GUIValue a => MenuCommand -> ConfigID -> a -> IO MenuCommand

cget :: GUIValue a => MenuCommand -> ConfigID -> IO a

HasEnable MenuCommand

A menu command is a stateful object, it can be enabled or disabled.

Methods

state :: State -> Config MenuCommand

getState :: MenuCommand -> IO State

disable :: Config MenuCommand

enable :: Config MenuCommand

isEnabled :: MenuCommand -> IO Bool

HasJustify MenuCommand

A menu command has a configureable text justification.

Methods

justify :: Justify -> Config MenuCommand

getJustify :: MenuCommand -> IO Justify

HasUnderline MenuCommand

You can set the index of a text character to underline.

Methods

underline :: Int -> Config MenuCommand

getUnderline :: MenuCommand -> IO Int

wraplength :: Int -> Config MenuCommand

getWraplength :: MenuCommand -> IO Int

HasFont MenuCommand

You can specify the font of a menu command.

Methods

font :: FontDesignator f => f -> Config MenuCommand

getFont :: MenuCommand -> IO Font

HasBorder MenuCommand

A menu command has a configureable border.

Methods

borderwidth :: Distance -> Config MenuCommand

getBorderwidth :: MenuCommand -> IO Distance

relief :: Relief -> Config MenuCommand

getRelief :: MenuCommand -> IO Relief

HasSize MenuCommand

You can specify the size of a menu command.

Methods

width :: Distance -> Config MenuCommand

getWidth :: MenuCommand -> IO Distance

height :: Distance -> Config MenuCommand

getHeight :: MenuCommand -> IO Distance

size :: Size -> Config MenuCommand

getSize :: MenuCommand -> IO Size

HasColour MenuCommand

A menu command has a normal foreground and background colour and an active/disabled foreground and background colour.

Methods

legalColourID :: MenuCommand -> ConfigID -> Bool

setColour :: MenuCommand -> ConfigID -> Colour -> IO MenuCommand

getColour :: MenuCommand -> ConfigID -> IO Colour

HasCommand MenuCommand

When a menu command is clicked, a corresponding event is invoked.

Methods

clicked :: MenuCommand -> IO (Event ())

HasPhoto MenuCommand

A menu command can contain an image (instead of text or a bitmap).

Methods

photo :: Image -> Config MenuCommand

getPhoto :: MenuCommand -> IO (Maybe Image)

HasAccelerator MenuCommand

A menu command has an optional text to display as a reminder about a keystroke binding.

Methods

accelerator :: String -> Config MenuCommand

getAccelerator :: MenuCommand -> IO String

MenuItem MenuCommand

A menu command is a menu item (any menu item instantiates the abstract class MenuItem).

HasIndicator MenuCommand

You can display an indicator with a menu command.

Methods

indicator :: Toggle -> Config MenuCommand

getIndicator :: MenuCommand -> IO Toggle

HasBitMap MenuCommand

A menu command can contain a bitmap (instead of text or an image).

Methods

bitmap :: BitMapDesignator d => d -> Config MenuCommand

getBitMap :: MenuCommand -> IO BitMapHandle

GUIValue v => HasText MenuCommand v

A menu command can contain text (instead of an image or bitmap).

Methods

text :: v -> Config MenuCommand

getText :: MenuCommand -> IO v

createMenuCommand

Arguments

:: Menu

the parent menu.

-> [Config MenuCommand]

the list of configuration options for this menu command.

-> IO MenuCommand

A menu command.

Constructs a new menu command and returns a handler.