curses.5 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

curses(5) curses(5)

(CURSES)

NAME

curses: curses.h - deﬁnitions for screen handling and optimization functions

SYNOPSIS

#include <curses.h>

DESCRIPTION

Objects

The <curses.h> header provides a declaration for COLOR_PAIRS, COLORS, COLS, curscr , LINES

and stdscr .

Constants

The following constants are deﬁned:

EOF Function return value for end-of-ﬁle

ERR Function return value for failure

FALSE Boolean false value

OK Function return value for success

TRUE Boolean true value

WEOF Wide-character function return value for end-of-ﬁle, as deﬁned in

<wchar.h>.

Data Types

The following data types are deﬁned through typedef:

attr_t An OR-ed set of attributes

bool Boolean data type

chtype A character, attributes and a colour-pair

SCREEN An opaque terminal representation

wchar_t As described in <stddef.h>

wint_t As described in <wchar.h>

cchar_t References a string of wide characters

WINDOW An opaque window representation

These data types are described in more detail in Data Types in curses_intro (3X).

The inclusion of

<curses.h> may make visible all symbols from the headers <stdio.h>, <term.h>,

<termios.h> and <wchar.h>.

Attribute Bits

The following symbolic constants are used to manipulate objects of type

attr_t:

WA_ALTCHARSET Alternate character set

WA_BLINK Blinking

WA_BOLD Extra bright or bold

WA_DIM Half bright

WA_HORIZONTAL Horizontal highlight

WA_INVIS Invisible

WA_LEFT Left highlight

WA_LOW Low highlight

WA_PROTECT Protected

WA_REVERSE Reverse video

WA_RIGHT Right highlight

WA_STANDOUT Best highlighting mode of the terminal

WA_TOP Top highlight

WA_UNDERLINE Underlining

HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (12 pages)

PAGE 1
curses(5) curses(5) (CURSES) NAME curses: curses.h - definitions for screen handling and optimization functions SYNOPSIS #include DESCRIPTION Objects The header provides a declaration for COLOR_PAIRS, COLORS, COLS, curscr , LINES and stdscr .
PAGE 2
curses(5) curses(5) (CURSES) WA_VERTICAL Vertical highlight These attribute flags shall be distinct.
PAGE 3
curses(5) curses(5) (CURSES) ACS_DARROW ACS_UARROW ACS_BOARD ACS_LANTERN ACS_BLOCK WACS_DARROW WACS_UARROW WACS_BOARD WACS_LANTERN WACS_BLOCK v ^ # # # arrow pointing down arrow pointing up board of squares lantern symbol solid square block Colour-related Macros The following colour-related macros are defined: COLOR_BLACK COLOR_BLUE COLOR_GREEN COLOR_CYAN COLOR_RED COLOR_MAGENTA COLOR_YELLOW COLOR_WHITE A Coordinate-related Macros The following coordinate-related macros are defined: void void void v
PAGE 4
curses(5) curses(5) (CURSES) KEY_LL KEY_A1 KEY_A3 KEY_B2 KEY_C1 KEY_C3 Home down or bottom Upper left of keypad Upper right of keypad Center of keypad Lower left of keypad Lower right of keypad The virtual keypad is a 3-by-3 keypad arranged as follows: A1 LEFT C1 A UP B2 DOWN A3 RIGHT C3 Each legend, such as A1, corresponds to a symbolic constant for a key code from the preceding table, such as KEY_A1.
PAGE 5
curses(5) curses(5) (CURSES) KEY_SMOVE KEY_SNEXT KEY_SOPTIONS KEY_SPREVIOUS KEY_SPRINT KEY_SREDO KEY_SREPLACE KEY_SRIGHT KEY_SRSUME KEY_SSAVE KEY_SSUSPEND KEY_SUNDO KEY_SUSPEND KEY_UNDO Shifted move key Shifted next key Shifted options key Shifted prev key Shifted print key Shifted redo key Shifted replace key Shifted right arrow Shifted resume key Shifted save key Shifted suspend key Shifted undo key Suspend key Undo key A Function Prototypes The following are declared as functions, and may also be de
PAGE 6
curses(5) curses(5) (CURSES) int int int int int void int int WINDOW A int WINDOW int int int int int char int void int int chtype int int cA int int int int int WINDOW int int bool bool bool int int void int void chtype int int WINDOW int int int int int int int int int int int int int int int int 6 curs_set(int visibility ); def_prog_mode(void); def_shell_mode(void); delay_output(int ms); delch(void); delscreen(SCREEN *sp); delwin(WINDOW *win); deleteln(void); *derwin(WINDOW *orig, int nlines, int
PAGE 7
curses(5) curses(5) (CURSES) in_wchnstr(cchar_t *wchstr, int n); inwstr(wchar_t *wstr); isendwin(void); is_linetouched(WINDOW *win, int line); is_wintouched(WINDOW *win); *keyname(int c); *key_name(wchar_t c); keypad(WINDOW *win, bool bf); killchar(void); killwchar(wchar_t *ch); leaveok(WINDOW *win, bool bf); *longname(void); meta(WINDOW *win, bool bf); move(int y, int x); mvaddch(int y, int x, const chtype ch); mvaddchnstr(int y, int x, const chtype *chstr, int n); mvaddchstr(int y, int x, const chtype *
PAGE 8
curses(5) curses(5) (CURSES) int int int int int int int A int int int int int int int int int cA int chtype int int int int int int int int int int int int int int int int int int int int WINDOW SCREEN WINDOW int int int int int void int int int int int int int int 8 mvwaddnwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n); mvwaddstr(WINDOW *win, int y, int x, const char *str); mvwaddwstr(WINDOW *win, int y, int x, const wchar_t *wstr); mvwadd_wch(WINDOW *win, int y, int x, const cchar_t *
PAGE 9
curses(5) curses(5) (CURSES) pnoutrefresh(WINDOW *pad, int pminrow, int pmincol, int sminrow, int smincol, int smaxrow, int smaxcol); int prefresh(WINDOW *pad, int pminrow, int pmincol, int sminrow, int smincol, int smaxrow, int smaxcol); int printw(char *fmt, ...
PAGE 10
curses(5) curses(5) (CURSES) char int int int int void int int int int A int int int int int int int int int int int int int int int int int int int int int int int int void int void int cA int int int int int void int int int int int int 10 *tparm(char *cap, long p1, long p2, long p3, long p4, long p5, long p6, long p7, long p8, long p9); typeahead(int fildes); ungetch(int ch); unget_wch(const wchar_t wch); untouchwin(WINDOW *win); use_env(bool boolvalue); vidattr(chtype attr); vid_attr(attr_t att
PAGE 11
curses(5) curses(5) (CURSES) int wgetch(WINDOW *win); int wgetnstr(WINDOW *win, char *str, int n); int wgetn_wstr(WINDOW *win, wint_t *wstr, int n); int wgetstr(WINDOW *win, char *str); int wget_wch(WINDOW *win, wint_t *ch); int wget_wstr(WINDOW *win, wint_t *wstr); int whline(WINDOW *win, chtype ch, int n); int whline_set(WINDOW *win, const cchar_t *wch, int n); chtype winch(WINDOW *win); int winchnstr(WINDOW *win, chtype *chstr, int n); int winchstr(WINDOW *win, chtype *chstr); int winnstr(WINDOW *win,
PAGE 12
(Notes) A (Notes) cA 12 Hewlett-Packard Company −1− HP-UX 11i Version 3: September 2010