HsCharm

HsCharm wraps charm, a minimal ncurses-like terminal UI library

Documentation

charmVersion :: String

charmVersion is semver.

getWidth :: IO Int

getWidth queries terminal width.

getHeight :: IO Int

getHeight queries terminal height

cursorOff :: IO ()

cursorOff hides the cursor.

cursorOn :: IO ()

cursorOn shows the cursor.

echoOff :: IO ()

echoOff disables key echoing.

echoOn :: IO ()

echoOn enables key echoing.

rawOn :: IO ()

rawOn enables raw manipulation.

rawOff :: IO ()

rawOff disables raw manipulation.

getCursor :: IO (Int, Int)

getCursor queries the cursor position.

moveCursor :: Int -> Int -> IO ()

moveCursor repositions the cursor.

blotChar :: Char -> IO ()

blotChar renders a chacter.

blotString :: String -> IO ()

blotString renders a string message.

hCenterString :: String -> IO ()

hCenterString displays a string centered horizontally on screen.

vCenterString :: String -> IO ()

vCenterString displays a string centered vertically on screen.

clearScreen :: IO ()

clearScreen wipes the terminal display.

handleSignal :: Int -> IO ()

handleSignal dispatches events.

startCharm :: IO ()

startCharm prepares the charm session.

endCharm :: IO ()

endCharm tears down charm session resources.

getKey :: IO Key

getKey queries key presses.

data Key

Key models keybard input.

Constructors

KeyBackspace

KeyTab

KeyNewline

KeySpace

KeyExclamation

KeyDoubleQuote

KeyHash

KeyDollar

KeyPercent

KeyAmpersand

KeySingleQuote

KeyLeftParen

KeyRightParen

KeyAsterisk

KeyPlus

KeyComma

KeyMinus

KeyPeriod

KeySlash

KeyZero

KeyOne

KeyTwo

KeyThree

KeyFour

KeyFive

KeySix

KeySeven

KeyEight

KeyNine

KeyColon

KeySemicolon

KeyLessThan

KeyEquals

KeyGreaterThan

KeyQuestion

KeyAt

KeyCapitalA

KeyCapitalB

KeyCapitalC

KeyCapitalD

KeyCapitalE

KeyCapitalF

KeyCapitalG

KeyCapitalH

KeyCapitalI

KeyCapitalJ

KeyCapitalK

KeyCapitalL

KeyCapitalM

KeyCapitalN

KeyCapitalO

KeyCapitalP

KeyCapitalQ

KeyCapitalR

KeyCapitalS

KeyCapitalT

KeyCapitalU

KeyCapitalV

KeyCapitalW

KeyCapitalX

KeyCapitalY

KeyCapitalZ

KeyLeftBracket

KeyBackslash

KeyRightBracket

KeyCaret

KeyUnderscore

KeyBacktick

KeyA

KeyB

KeyC

KeyD

KeyE

KeyF

KeyG

KeyH

KeyI

KeyJ

KeyK

KeyL

KeyM

KeyN

KeyO

KeyP

KeyQ

KeyR

KeyS

KeyT

KeyU

KeyV

KeyW

KeyX

KeyY

KeyZ

KeyLeftBrace

KeyPipe

KeyRightBrace

KeyTilde

KeyUp

KeyDown

KeyRight

KeyLeft

KeyEscape

KeyUnknown

Instances

Enum Key

Methods

succ :: Key -> Key

pred :: Key -> Key

toEnum :: Int -> Key

fromEnum :: Key -> Int

enumFrom :: Key -> [Key]

enumFromThen :: Key -> Key -> [Key]

enumFromTo :: Key -> Key -> [Key]

enumFromThenTo :: Key -> Key -> Key -> [Key]

Eq Key

Methods

(==) :: Key -> Key -> Bool

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

Ord Key

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

(<=) :: Key -> Key -> Bool

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Show Key

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS