Curses module
This module provides an interface to the ncurses (on Linux) or pdcurses (on Windows) terminal control library. An alternate interfaces is provided by CursesW (which should be used if multi-byte characters - i.e. characters Char(128) and above - are needed)
The initscr must be called before most of the functions in this module will work, and endwin must be called before program exit.
The Kayurses module provides a higher-level interface to the curses functions.
Data types
- Curses::Attr - Text attributes
- Curses::Screen - Curses screen structure
- Curses::Visibility - Cursor visibility
- Curses::Window - Curses window structure
Exceptions
- CantCreateWindow - Can't create Window
- CursesError - Curses Error
Functions
- Int Black() - Black colour
- Int Blue() - Blue colour
- Int ColourPairs() - Number of supported colour pairs
- Int Colours() - Number of supported colours
- Int Cyan() - Cyan colour
- Int Green() - Green colour
- Char KeyA1() - A1 key
- Char KeyA3() - A3 key
- Char KeyB2() - B2 key
- Char KeyBackspace() - Backspace key
- Char KeyC1() - C1 key
- Char KeyC3() - C3 key
- Char KeyDown() - Down arrow key
- Char KeyEnd() - End key
- Char KeyF1() - Function key 1
- Char KeyF10() - Function key 10
- Char KeyF11() - Function key 11
- Char KeyF12() - Function key 12
- Char KeyF2() - Function key 2
- Char KeyF3() - Function key 3
- Char KeyF4() - Function key 4
- Char KeyF5() - Function key 5
- Char KeyF6() - Function key 6
- Char KeyF7() - Function key 7
- Char KeyF8() - Function key 8
- Char KeyF9() - Function key 9
- Char KeyHome() - Home key
- Char KeyLeft() - Left arrow key
- Char KeyNPage() - Page down key
- Char KeyPPage() - Page up key
- Char KeyRight() - Right arrow key
- Char KeyUp() - Up arrow key
- Int Magenta() - Magenta colour
- Int Red() - Red colour
- Int White() - White colour
- Int Yellow() - Yellow colour
- Void addStr(String s) - Print a string
- Void attributes([Attr] attribs,Bool enable) - Enable or disable text attributes
- Void beep() - Beep to alert the user
- Void box(Window w,Char v='\0',Char h='\0') - Draw a box border on a window
- Void cbreakMode(Bool enable) - Enable or disable cbreak mode
- Void clear() - Clear screen
- Void clearDown() - Clear to bottom of screen
- Void clearRight() - Clear to end of line
- Void delwin(Window w) - Delete a window
- Void echoMode(Bool enable) - Enable or disable echo
- Void endWin() - End curses windowing
- Void erase() - Erase screen
- Void flash() - Flash the screen to alert the user
- Char getChar() - Get a character
- String getStr() - Get an input string up to newline
- Void halfDelay(Int tenths) - Enable half-delay mode
- Bool hasColours() - Check for support for colours
- Void initColour(Int col,Int r,Int g,Int b) - Initialise a new colour
- Void initPair(Int pair,Int f,Int b) - Define a colour pair
- Void initScreen() - Initialise curses
- Void intrFlush(Window win,Bool bf) - Enable or disable interrupt flushing
- Bool isEndWin() - Check for end of windowing mode
- Void keypad(Window win,Bool bf) - Enable or disable the keypad
- Void meta(Window win,Bool bf) - Enable or disable 8 bit input
- Void move(Int y,Int x) - Move the cursor
- Void mvWin(Window w,Int y,Int x) - Move a window
- Char mvgetChar(Int y,Int x) - Move and get a character
- Window newWin(Int lines,Int cols,Int beginy,Int beginx) - Create a new window
- Void newlineMode(Bool enable) - Enable or disable return key to newline translation
- Void noDelay(Window win,Bool bf) - Enable non-blocking input
- Void noTimeout(Window win,Bool bf) - Disable escape sequence timeout
- Void rawMode(Bool enable) - Enable or disable raw mode
- Void refresh() - Refresh the screen
- Void setCursor(Visibility mode) - Set cursor visibility
- Void startColour() - Enable colours
- Window stdscr() - Return the standard screen
- Void ungetChar(Char c) - Unget a character
- Void wAttributes(Window w,[Attr] attribs,Bool enable) - Enable or disable text attributes in a window
- Void wClear(Window w) - Clear window
- Void wClearDown(Window w) - Clear to bottom of window
- Void wClearRight(Window w) - Clear to end of line in a window
- Void wErase(Window w) - Erase window
- Void wMove(Window w,Int y,Int x) - Move the cursor within a window
- Void wRefresh(Window w) - Refresh a window
- Void waddStr(Window win,String s) - Print a string in a window
- Char wgetChar(Window w) - Get a character in a window
- String wgetStr(Window w) - Get an input string up to newline from a window
- Char wmvgetChar(Window w,Int y,Int x) - Move and get a character in a window
