HTk.Toolkit.GenGUI

A generic graphical user interface.

Documentation

data GenGUI c

The GenGUI datatye.

Instances

CItem c => Eq (GenGUI c)

Internal.

Methods

(==) :: GenGUI c -> GenGUI c -> Bool

(/=) :: GenGUI c -> GenGUI c -> Bool

CItem c => Destroyable (GenGUI c)

A GenGUI object can be destroyed.

Methods

destroy :: GenGUI c -> IO ()

CItem c => Synchronized (GenGUI c)

You can synchronize on a gengui object.

Methods

synchronize :: GenGUI c -> IO b -> IO b

CItem c => GUIObject (GenGUI c)

Internal.

Methods

toGUIObject :: GenGUI c -> GUIOBJECT

cname :: GenGUI c -> String

cset :: GUIValue a => GenGUI c -> ConfigID -> a -> IO (GenGUI c)

cget :: GUIValue a => GenGUI c -> ConfigID -> IO a

CItem c => Window (GenGUI c)

A GenGUI object is a window.

Methods

iconify :: GenGUI c -> IO ()

deiconify :: GenGUI c -> IO ()

withdraw :: GenGUI c -> IO ()

putWinOnTop :: GenGUI c -> IO ()

putWinAtBottom :: GenGUI c -> IO ()

screen :: Display -> Config (GenGUI c)

getScreen :: GenGUI c -> IO Display

getClassName :: GenGUI c -> IO String

getWindowState :: GenGUI c -> IO WindowState

aspectRatio :: AspectRatio -> Config (GenGUI c)

getAspectRatio :: GenGUI c -> IO AspectRatio

positionFrom :: Whom -> Config (GenGUI c)

getPositionFrom :: GenGUI c -> IO Whom

sizeFrom :: Whom -> Config (GenGUI c)

getSizeFrom :: GenGUI c -> IO Whom

newGenGUI

Arguments

:: CItem c

=> Maybe (GenGUIState c)

an optional GenGUI state to recover.

-> Bool

True if lleaves should be displayed in the tree list.

-> IO (GenGUI c)

A gui.

Constructs a new gui and returns a handler.

setStatus :: CItem c => GenGUI c -> String -> IO ()

Sets the status label's text.

clearStatus :: CItem c => GenGUI c -> IO ()

Clears the status label.

updateTextArea :: CItem c => GenGUI c -> [MarkupText] -> IO ()

Displays the given markup text on the editor pane.

clearTextArea :: CItem c => GenGUI c -> IO ()

Clears the editor pane.

genGUIMainMenu :: CItem c => GenGUI c -> Menu

Gets the gui's menu container.

data NewItem c

External representation of gengui objects.

Constructors

LeafItem c (Maybe (Position, Bool))

FolderItem c [NewItem c] (Maybe (Bool, Bool))

data Item c

internal object representation

Instances

CItem c => Eq (Item c)

Internal.

Methods

(==) :: Item c -> Item c -> Bool

(/=) :: Item c -> Item c -> Bool

CItem c => CItem (Item c)

Objects must have a name and an icon.

Methods

getName :: Item c -> IO Name

getIcon :: Item c -> IO Image

data Name

The Name datatype.

Constructors

Name

Fields

• short :: Int -> String
• full :: String

class Eq c => CItem c where

Objects with a name and an icon.

Minimal complete definition

getName, getIcon

Methods

getName :: c -> IO Name

getIcon :: c -> IO Image

Instances

CItem c => CItem (Item c)

Objects must have a name and an icon.

Methods

getName :: Item c -> IO Name

getIcon :: Item c -> IO Image

root :: CItem c => GenGUI c -> IO (Item c)

GenGUI's root object.

openedFolder :: CItem c => GenGUI c -> IO (Maybe (Item c))

Gets the item that is currently open (displayed on notepad).

addItem

Arguments

:: CItem c

=> GenGUI c

the concerned gui.

-> Item c

the parent (folder) object.

-> NewItem c

the external representation of the new object.

-> IO (Item c)

the internal representation of the new object.

Adds a gengui object.

children :: CItem c => Item c -> IO [Item c]

Gets the children from a folder item.

content :: CItem c => Item c -> c

Returns the CItem content of an item.

data GenGUIEvent c

The GenGUIEvent datatype.

Constructors

FocusTreeList (Maybe (Item c))

SelectTreeList (Maybe (Item c))

FocusNotepad (Item c, Bool)

Dropped (Item c, [Item c])

Doubleclick (Item c)

Rightclick [Item c]

Addition (Item c)

DroppedOnTextArea [Item c]

bindGenGUIEv

Arguments

:: CItem c

=> GenGUI c

the concerned gui.

-> IO (Event (GenGUIEvent c), IO ())

A pair of (event, unbind action).

Binds a listener for gengui events to the gengui and returns a corresponding event and an unbind action.

type GenGUIState c = [NewItem c]

The gui's state.

exportGenGUIState

Arguments

:: CItem c

=> GenGUI c

the concerned GenGUI.

-> IO (GenGUIState c)

the gui's state.

Exports the gui's state.