|
|
|
|
Synopsis |
|
|
|
Documentation |
|
|
The main object. At most one should be created.
| Constructors | Vty | | update :: Picture -> IO () | Update the screen to reflect the contents of a Picture.
This is not currently threadsafe.
| getEvent :: IO Event | Get one Event object, blocking if necessary.
| getSize :: IO (Int, Int) | Get the size of the display.
| refresh :: IO () | Refresh the display. Normally the library takes care of refreshing.
Nonetheless, some other program might output to the terminal and mess the display.
In that case the user might want to force a refresh.
| shutdown :: IO () | Clean up after vty.
|
|
|
|
|
|
Make the terminal beep.
|
|
|
Set up the state object for using vty. At most one state object should be
created at a time.
|
|
|
|
|
This type represents the visible cursor state.
| Constructors | NoCursor | Hide the cursor.
| Cursor Int Int | Display the cursor at the given XY position.
|
|
|
|
|
An object representing the current state of the terminal.
| Constructors | |
|
|
|
Opaque data type representing character attributes.
| Constructors | |
|
|
|
Set the foreground color of an Attr.
|
|
|
Set the background color of an Attr.
|
|
|
Set the foreground color of an Attr.
|
|
|
Set the background color of an Attr.
|
|
|
Set bold attribute of an Attr.
|
|
|
Set blink attribute of an Attr.
|
|
|
Set reverse-video attribute of an Attr.
|
|
|
Set half-bright attribute of an Attr.
|
|
|
Set underline attribute of an Attr.
|
|
|
Attr with all default values.
|
|
|
Abstract data type representing a color.
| Constructors | |
|
|
|
Basic color definitions.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A two-dimensional array of (Char,Attr) pairs.
| Constructors | |
|
|
|
Access the width of an Image.
|
|
|
Access the height of an Image.
|
|
|
The empty image.
|
|
|
Compose two images side by side. The images must of the same height,
or one must be empty.
|
|
|
Compose two images vertically. The images must of the same width,
or one must be empty.
|
|
|
Helper - fill a buffer segment with a char/attr.
|
|
|
Compose any number of images horizontally.
|
|
|
Compose any number of images vertically.
|
|
|
Create an Image from a ByteString with a single uniform Attr.
|
|
|
Create a 1x1 image. Warning, this is likely to be inefficient.
|
|
|
Create an image by repeating a single character and attribute horizontally.
|
|
|
Create an image by repeating a single character and attribute.
|
|
|
The type of images to be displayed using update. You probably shouldn't
create this directly if you care about compatibility with future versions of
vty; instead use pic and record update syntax.
| Constructors | Pic | | pCursor :: Cursor | The position and visibility status of the virtual
cursor.
| pImage :: Image | A 2d array of (character,attribute) pairs, representing
the screen image.
|
|
|
|
|
|
Create a Picture object with all default values. By using this and record
update, rather than directly using the Pic constructor, your code will be
compatible with additions to the Picture object. You must specify at least
pImage.
|
|
|
Representations of non-modifier keys.
| Constructors | KEsc | | KFun Int | | KBackTab | | KPrtScr | | KPause | | KASCII Char | | KBS | | KIns | | KHome | | KPageUp | | KDel | | KEnd | | KPageDown | | KNP5 | | KUp | | KMenu | | KLeft | | KDown | | KRight | | KEnter | |
|
|
|
|
Modifier keys. Key codes are interpreted such that users are more likely to
have Meta than Alt; for instance on the PC Linux console, MMeta will
generally correspond to the physical Alt key.
| Constructors | |
|
|
|
Mouse buttons. Not yet used.
| Constructors | |
|
|
|
Generic events.
| Constructors | |
|
|
Produced by Haddock version 2.6.0 |