| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Termbox.Banana
Contents
Synopsis
- type TermboxEvent = Event
- main :: (width ~ Int, height ~ Int) => InputMode -> OutputMode -> (Event TermboxEvent -> Behavior (width, height) -> MomentIO (Behavior Scene, Event a)) -> IO a
- data Scene = Scene !Cells !Cursor
- data Cells
- set :: (col ~ Int, row ~ Int) => col -> row -> Cell -> Cells
- data Cursor
- black :: Attr
- red :: Attr
- green :: Attr
- yellow :: Attr
- blue :: Attr
- magenta :: Attr
- cyan :: Attr
- white :: Attr
- bold :: Attr
- underline :: Attr
- reverse :: Attr
- data Attr
- data Cell = Cell !Char !Attr !Attr
- data Event
- = EventKey !Key !Bool
- | EventResize !Int !Int
- | EventMouse !Mouse !Int !Int
- data InitError
- data InputMode
- data Key
- = KeyChar Char
- | KeyArrowDown
- | KeyArrowLeft
- | KeyArrowRight
- | KeyArrowUp
- | KeyBackspace
- | KeyBackspace2
- | KeyCtrl2
- | KeyCtrl3
- | KeyCtrl4
- | KeyCtrl5
- | KeyCtrl6
- | KeyCtrl7
- | KeyCtrl8
- | KeyCtrlA
- | KeyCtrlB
- | KeyCtrlBackslash
- | KeyCtrlC
- | KeyCtrlD
- | KeyCtrlE
- | KeyCtrlF
- | KeyCtrlG
- | KeyCtrlH
- | KeyCtrlI
- | KeyCtrlJ
- | KeyCtrlK
- | KeyCtrlL
- | KeyCtrlLsqBracket
- | KeyCtrlM
- | KeyCtrlN
- | KeyCtrlO
- | KeyCtrlP
- | KeyCtrlQ
- | KeyCtrlR
- | KeyCtrlRsqBracket
- | KeyCtrlS
- | KeyCtrlSlash
- | KeyCtrlT
- | KeyCtrlTilde
- | KeyCtrlU
- | KeyCtrlUnderscore
- | KeyCtrlV
- | KeyCtrlW
- | KeyCtrlX
- | KeyCtrlY
- | KeyCtrlZ
- | KeyDelete
- | KeyEnd
- | KeyEnter
- | KeyEsc
- | KeyF1
- | KeyF10
- | KeyF11
- | KeyF12
- | KeyF2
- | KeyF3
- | KeyF4
- | KeyF5
- | KeyF6
- | KeyF7
- | KeyF8
- | KeyF9
- | KeyHome
- | KeyInsert
- | KeyPageDn
- | KeyPageUp
- | KeySpace
- | KeyTab
- data Mouse
- data MouseMode
- data OutputMode
Documentation
This module is intended to be imported qualified.
import qualified Termbox.Banana as Termbox
type TermboxEvent = Event Source #
A termbox event. This type alias exists only for Haddock readability;
in code, you are encouraged to use
Eventforreactive-bananaeventsTermbox.Eventfortermboxevents
Since: termbox-banana-0.1.0
Arguments
| :: (width ~ Int, height ~ Int) | |
| => InputMode | |
| -> OutputMode | |
| -> (Event TermboxEvent -> Behavior (width, height) -> MomentIO (Behavior Scene, Event a)) | |
| -> IO a |
Run a termbox program with the specified input and output modes.
Given
- the terminal event stream and
- the time-varying terminal size,
return a time-varying
- scene to render, and
- a event stream of arbitrary values, only the first of which is relevant,
which ends the
termboxprogram and returns from themainaction.
Since: termbox-banana-0.1.0
A scene to render; a grid of cells and a cursor.
Since: termbox-banana-0.1.0
A grid of cells. Create a Cells with set or mempty and combine them
with (<>).
Since: termbox-banana-0.1.0
set :: (col ~ Int, row ~ Int) => col -> row -> Cell -> Cells Source #
Set a single cell's value.
Since: termbox-banana-0.1.0
A cursor.
Since: termbox-banana-0.1.0
Re-exports
A cell attribute, which includes its color, and whether or not it is bold, underlined, and/or reversed.
A cell can only have one color, but may be (for example) bold and
underlined. The Monoid instance combines Attrs this way, with a left
bias. That is,
red <> bold <> black <> underline = red <> bold <> underline
Warning: the Num instance is very partial! It only includes an
implementation of fromInteger, for numeric literals.
A Cell contains a character, foreground attribute, and background
attribute.
A input event.
Constructors
| EventKey !Key !Bool | Key event. The bool indicates the alt modifier. |
| EventResize !Int !Int | Resize event (width, then height) |
| EventMouse !Mouse !Int !Int | Mouse event (column, then row) |
Initialization errors that can be thrown by main.
Constructors
| FailedToOpenTTY | |
| PipeTrapError | |
| UnsupportedTerminal |
Instances
| Show InitError | |
| Exception InitError | |
Defined in Termbox Methods toException :: InitError -> SomeException # fromException :: SomeException -> Maybe InitError # displayException :: InitError -> String # | |
The input modes.
- Esc. When ESC sequence is in the buffer and it doesn't match any known
sequence, ESC means
KeyEsc. - Alt. When ESC sequence is in the buffer and it doesn't match any known sequence, ESC enables the alt modifier for the next keyboard event.
Constructors
| InputModeEsc MouseMode | Default. |
| InputModeAlt MouseMode |
Instances
| Eq InputMode | |
| Ord InputMode | |
| Show InputMode | |
A key event.
Constructors
A mouse event.
Constructors
| MouseLeft | |
| MouseMiddle | |
| MouseRelease | |
| MouseRight | |
| MouseWheelDown | |
| MouseWheelUp |
The mouse mode.
- No. Don't handle mouse events.
- Yes. Handle mouse events.
Constructors
| MouseModeNo | Default. |
| MouseModeYes |
Instances
| Eq MouseMode | |
| Ord MouseMode | |
| Show MouseMode | |
data OutputMode #
The output modes.
- Normal. Supports colors 0..8, which includes all named color
attributes exported by this library, e.g.
red. - Grayscale. Supports colors 0..23.
- 216. Supports colors 0..216.
- 256. Supports colors 0..255.
Constructors
| OutputModeNormal | Default. |
| OutputModeGrayscale | |
| OutputMode216 | |
| OutputMode256 |
Instances
| Eq OutputMode | |
Defined in Termbox | |
| Ord OutputMode | |
Defined in Termbox Methods compare :: OutputMode -> OutputMode -> Ordering # (<) :: OutputMode -> OutputMode -> Bool # (<=) :: OutputMode -> OutputMode -> Bool # (>) :: OutputMode -> OutputMode -> Bool # (>=) :: OutputMode -> OutputMode -> Bool # max :: OutputMode -> OutputMode -> OutputMode # min :: OutputMode -> OutputMode -> OutputMode # | |
| Show OutputMode | |
Defined in Termbox Methods showsPrec :: Int -> OutputMode -> ShowS # show :: OutputMode -> String # showList :: [OutputMode] -> ShowS # | |