| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
UI.HSCurses.CursesHelper
- start :: IO ()
- end :: IO ()
- suspend :: IO ()
- resizeui :: IO (Int, Int)
- getKey :: MonadIO m => m () -> m Key
- drawLine :: Int -> String -> IO ()
- drawCursor :: (Int, Int) -> (Int, Int) -> IO ()
- gotoTop :: IO ()
- data ForegroundColor
- data BackgroundColor
- defaultColor :: Color
- black :: Color
- red :: Color
- green :: Color
- yellow :: Color
- blue :: Color
- magenta :: Color
- cyan :: Color
- white :: Color
- data Attribute
- convertAttributes :: [Attribute] -> Attr
- data Style
- data CursesStyle
- mkCursesStyle :: [Attribute] -> CursesStyle
- changeCursesStyle :: CursesStyle -> [Attribute] -> CursesStyle
- setStyle :: CursesStyle -> IO ()
- wSetStyle :: Window -> CursesStyle -> IO ()
- resetStyle :: IO ()
- wResetStyle :: Window -> IO ()
- convertStyles :: [Style] -> IO [CursesStyle]
- 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
- withCursor :: (MonadIO m, MonadMask m) => CursorVisibility -> m a -> m a
- withProgram :: (MonadIO m, MonadMask m) => m a -> m a
UI initialisation
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).
resizeui :: IO (Int, Int) Source
Resize the window From "Writing Programs with NCURSES", by Eric S. Raymond and Zeyd M. Ben-Halim
Input
getKey :: MonadIO m => m () -> m Key Source
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).
Drawing
Navigation
Colors
data ForegroundColor Source
Foreground colors.
Constructors
| BlackF | |
| GreyF | |
| DarkRedF | |
| RedF | |
| DarkGreenF | |
| GreenF | |
| BrownF | |
| YellowF | |
| DarkBlueF | |
| BlueF | |
| PurpleF | |
| MagentaF | |
| DarkCyanF | |
| CyanF | |
| WhiteF | |
| BrightWhiteF | |
| DefaultF |
Instances
Basic colors.
Attributes
Abstractions for some commonly used attributes.
convertAttributes :: [Attribute] -> Attr Source
Converts an abstract attribute list into its curses representation.
Style
A humand-readable style.
data CursesStyle Source
A style which uses the internal curses representations for attributes and colors.
Instances
mkCursesStyle :: [Attribute] -> CursesStyle Source
changeCursesStyle :: CursesStyle -> [Attribute] -> CursesStyle Source
Changes the attributes of the given CursesStyle.
setStyle :: CursesStyle -> IO () Source
Manipulate the current style of the standard screen
wSetStyle :: Window -> CursesStyle -> IO () Source
resetStyle :: IO () Source
Reset the screen to normal values
wResetStyle :: Window -> IO () Source
convertStyles :: [Style] -> IO [CursesStyle] Source
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.
withStyle :: (MonadIO m, MonadMask m) => CursesStyle -> m a -> m a Source
wWithStyle :: (MonadIO m, MonadMask m) => Window -> CursesStyle -> m a -> m a Source
Keys
displayKey :: Key -> String Source
Converting keys to humand-readable strings
Helpers
withCursor :: (MonadIO m, MonadMask m) => CursorVisibility -> m a -> m a Source
Other helpers
set the cursor, and do action
withProgram :: (MonadIO m, MonadMask m) => m a -> m a Source