| License | BSD-style |
|---|---|
| Maintainer | Vincent Hanquez <vincent@snarc.org> |
| Stability | experimental |
| Portability | Good |
| Safe Haskell | Safe |
| Language | Haskell2010 |
Console.Display
Description
Displaying utilities
- data TerminalDisplay
- displayInit :: IO TerminalDisplay
- display :: TerminalDisplay -> [OutputElem] -> IO ()
- displayTextColor :: TerminalDisplay -> Color -> String -> IO ()
- displayLn :: TerminalDisplay -> Color -> String -> IO ()
- data ProgressBar
- progress :: TerminalDisplay -> Int -> (ProgressBar -> IO a) -> IO a
- progressTick :: ProgressBar -> IO ()
- data Summary
- summary :: TerminalDisplay -> IO Summary
- summarySet :: Summary -> [OutputElem] -> IO ()
- data Color :: *
- data OutputElem
- termText :: String -> TermOutput
- justify :: Justify -> Int -> String -> String
- data Justify
- data Table
- data Column
- columnNew :: Int -> String -> Column
- tableCreate :: [Column] -> Table
- tableHeaders :: TerminalDisplay -> Table -> IO ()
- tableAppend :: TerminalDisplay -> Table -> [String] -> IO ()
Documentation
data TerminalDisplay #
Terminal display state
Basic
displayInit :: IO TerminalDisplay #
Create a new display
display :: TerminalDisplay -> [OutputElem] -> IO () #
Display
displayTextColor :: TerminalDisplay -> Color -> String -> IO () #
A simple utility that display a msg in color
displayLn :: TerminalDisplay -> Color -> String -> IO () #
A simple utility that display a msg in color and newline at the end.
Progress Bar
data ProgressBar #
Progress bar widget
progress :: TerminalDisplay -> Int -> (ProgressBar -> IO a) -> IO a #
Create a new progress bar context
progressTick :: ProgressBar -> IO () #
Tick an element on the progress bar
Summary line
summary :: TerminalDisplay -> IO Summary #
Create a summary
summarySet :: Summary -> [OutputElem] -> IO () #
Set the summary
Attributes
termText :: String -> TermOutput #
justify :: Justify -> Int -> String -> String #
box a string to a specific size, choosing the justification
Table
tableCreate :: [Column] -> Table #
Create a new table
tableHeaders :: TerminalDisplay -> Table -> IO () #
Show the table headers
tableAppend :: TerminalDisplay -> Table -> [String] -> IO () #
Append a row to the table.
if the number of elements is greater than the amount of column the table has been configured with, the extra elements are dropped.