Graphics.UI.Grapefruit.Backend.Basic

This module declares a subclass of UIBackend with methods that every reasonable UI backend should implement.

Interface

class UIBackend uiBackend => BasicUIBackend uiBackend where

A subclass of UIBackend which declares basic bricks and boxes.

Minimal complete definition

label, pushButton, lineEditor, box, window

Methods

label :: Brick Widget uiBackend (X :& (Req Text ::: (SSignal `Of` String))) X

A widget showing one line of text.

pushButton :: Brick Widget uiBackend (X :& (Req Text ::: (SSignal `Of` String))) (X :& (Push ::: (DSignal `Of` ())))

A push button.

lineEditor :: Brick Widget uiBackend X (X :& (Content ::: (SSignal `Of` String)))

An editor for a single line of text.

box :: Orientation -> Box UICircuit Widget Widget uiBackend X X

A widget which aggregates and arbitrary number of other widgets.

window :: Box UIItem Widget Window uiBackend (X :& (Req Title ::: (SSignal `Of` String))) (X :& (Closure ::: (DSignal `Of` ())))

An ordinary window.

Utilities

data Orientation

An orientation of widgets in a box.

Constructors

Horizontal

Vertical

data Caption

A caption of a widget with an optional hotkey marker.

Currently, this type is not used.

Constructors

ColdCaption String

a caption without a hotkey

HotCaption String Char String

a caption consisting of a prefix string, a hotkey and a suffix string

Field names

data Closure

A field name.

Typical properties:

kind

output

type

DSignal `Of` ()

meaning

a “window was closed” event

Constructors

Closure

data Content

A field name.

Typical properties:

kind

output

type

SSignal `Of` val for some type val

meaning

the content of an editor widget

Constructors

Content

data Push

A field name.

Typical properties:

kind

output

type

DSignal `Of` ()

meaning

a stream of button push events

Constructors

Push

data Text

A field name.

Typical properties:

kind

input (required)

type

SSignal `Of` String

meaning

the caption of a widget

Constructors

Text

data Title

A field name.

Typical properties:

kind

input (required)

type

SSignal `Of` String

meaning

the title of a window

Constructors

Title