UI.HSCurses.CursesHelper

Documentation

start :: IO ()

start initializes the UI and grabs the keyboard.

This function installs a handler for the SIGWINCH signal which writes the KEY_RESIZE key to the input queue (if KEY_RESIZE and and SIGWINCH are both available).

end :: IO ()

Clean up and go home.

suspend :: IO ()

Suspend the program.

resizeui :: IO (Int, Int)

Resize the window From "Writing Programs with NCURSES", by Eric S. Raymond and Zeyd M. Ben-Halim

getKey :: MonadIO m => m () -> m Key

getKey refresh reads a key.

The refresh function is used to redraw the screen when the terminal size changes (see the documentatio of start for a discussion of the problem).

drawLine :: Int -> String -> IO ()

drawLine n s draws n characters of string s.

drawCursor :: (Int, Int) -> (Int, Int) -> IO ()

Draw the cursor at the given position.

gotoTop :: IO ()

Move cursor to origin of stdScr.

data ForegroundColor

Foreground colors.

Constructors

BlackF

GreyF

DarkRedF

RedF

DarkGreenF

GreenF

BrownF

YellowF

DarkBlueF

BlueF

PurpleF

MagentaF

DarkCyanF

CyanF

WhiteF

BrightWhiteF

DefaultF

Instances

Show ForegroundColor

Defined in UI.HSCurses.CursesHelper

Methods

showsPrec :: Int -> ForegroundColor -> ShowS

show :: ForegroundColor -> String

showList :: [ForegroundColor] -> ShowS

Eq ForegroundColor

Defined in UI.HSCurses.CursesHelper

Methods

(==) :: ForegroundColor -> ForegroundColor -> Bool

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

data BackgroundColor

Background colors.

Constructors

BlackB

DarkRedB

DarkGreenB

BrownB

DarkBlueB

PurpleB

DarkCyanB

WhiteB

DefaultB

Instances

Show BackgroundColor

Defined in UI.HSCurses.CursesHelper

Methods

showsPrec :: Int -> BackgroundColor -> ShowS

show :: BackgroundColor -> String

showList :: [BackgroundColor] -> ShowS

Eq BackgroundColor

Defined in UI.HSCurses.CursesHelper

Methods

(==) :: BackgroundColor -> BackgroundColor -> Bool

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

defaultColor :: Color

Basic colors.

black :: Color

red :: Color

green :: Color

yellow :: Color

blue :: Color

magenta :: Color

cyan :: Color

white :: Color

data Attribute

Abstractions for some commonly used attributes.

Constructors

Bold

Underline

Dim

Reverse

Blink

Instances

Show Attribute

Defined in UI.HSCurses.CursesHelper

Methods

showsPrec :: Int -> Attribute -> ShowS

show :: Attribute -> String

showList :: [Attribute] -> ShowS

Eq Attribute

Defined in UI.HSCurses.CursesHelper

Methods

(==) :: Attribute -> Attribute -> Bool

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

convertAttributes :: [Attribute] -> Attr

Converts an abstract attribute list into its curses representation.

data Style

A human-readable style.

Constructors

Style ForegroundColor BackgroundColor

AttributeStyle [Attribute] ForegroundColor BackgroundColor

ColorlessStyle [Attribute]

Instances

Show Style

Defined in UI.HSCurses.CursesHelper

Methods

showsPrec :: Int -> Style -> ShowS

show :: Style -> String

showList :: [Style] -> ShowS

Eq Style

Defined in UI.HSCurses.CursesHelper

Methods

(==) :: Style -> Style -> Bool

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

data CursesStyle

A style which uses the internal curses representations for attributes and colors.

Instances

Show CursesStyle

Defined in UI.HSCurses.CursesHelper

Methods

showsPrec :: Int -> CursesStyle -> ShowS

show :: CursesStyle -> String

showList :: [CursesStyle] -> ShowS

Eq CursesStyle

Defined in UI.HSCurses.CursesHelper

Methods

(==) :: CursesStyle -> CursesStyle -> Bool

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

mkCursesStyle :: [Attribute] -> CursesStyle

changeCursesStyle :: CursesStyle -> [Attribute] -> CursesStyle

Changes the attributes of the given CursesStyle.

setStyle :: CursesStyle -> IO ()

Manipulate the current style of the standard screen

wSetStyle :: Window -> CursesStyle -> IO ()

resetStyle :: IO ()

Reset the screen to normal values

wResetStyle :: Window -> IO ()

convertStyles :: [Style] -> IO [CursesStyle]

Converts a list of human-readable styles into the corresponding curses representation.

This function should be called exactly once at application startup for all styles of the application.

defaultStyle :: Style

defaultCursesStyle :: CursesStyle

withStyle :: (MonadIO m, MonadMask m) => CursesStyle -> m a -> m a

wWithStyle :: (MonadIO m, MonadMask m) => Window -> CursesStyle -> m a -> m a

displayKey :: Key -> String

Converting keys to human-readable strings

withCursor :: (MonadIO m, MonadMask m) => CursorVisibility -> m a -> m a

Set the cursor, and do action

withProgram :: (MonadIO m, MonadMask m) => m a -> m a