curs_getwch(3X) 27 Jan 1992 curs_getwch(3X)
NAME
cursgetwch: getwch, wgetwch, mvgetwch, mvwgetwch, ungetwch - get (or
push back) wchart characters from curses terminal keyboard
SYNOPSIS
#include <curses.h>
int getwch(void);
int wgetwch(WINDOW *win);
int mvgetwch(int y, int x);
int mvwgetwch(WINDOW *win, int y, int x);
int ungetwch(int wch);
DESCRIPTION
The getwch, wgetwch, mvgetwch and mvwgetwch routines read an EUC char-
acter from the terminal associated with the window, transform it into
a wchart character, and return it. In no-delay mode the value ERR is
returned if no input is waiting. In delay mode, the function waits
until the system passes text through to the program. Depending on the
setting of cbreak, this is after one character (cbreak mode), or after
the first newline (nocbreak mode). In half-delay mode, the program
waits until a character is typed or the specified timeout has been
reached. Unless noecho has been set, the character will also be echoed
into the designated window.
If the window is not a pad, and it has been moved or modified since
the last call to wrefresh, wrefresh will be called before another
character is read.
If keypad is TRUE, and a function key is pressed, the token for that
function key is returned instead of the raw characters. Possible func-
tion keys are defined in <curses.h> as integers, beginning with 0401,
whose names begin with KEY. If a character that could be the begin-
ning of a function key (such as escape) is received, curses sets a
timer. If the remainder of the sequence does not come in within the
designated time, the character is passed through; otherwise, the func-
tion key value is returned. For this reason, many terminals experience
a delay between the time a user presses the escape key and the escape
is returned to the program.
The ungetwch routine places wch back onto the input queue to be
returned by the next call to wgetwch.
Function Keys
The following function keys, defined in <curses.h>, might be returned
by getwch if keypad has been enabled. Note that not all of these may
be supported on a particular terminal if the terminal does not
transmit a unique code when the key is pressed or if the definition
for the key is not present in the terminfo database.
Page 1 Reliant UNIX 5.44 1, 1927
curs_getwch(3X) 27 Jan 1992 curs_getwch(3X)
__________________________________________________________________
Name Key name
__________________________________________________________________
KEY_BREAK Break key
KEY_DOWN The four arrow keys ...
KEY_UP
KEY_LEFT
KEY_RIGHT
KEY_HOME Home key (upward+left arrow)
KEY_BACKSPACE Backspace
KEY_F0 Function keys; space for 64 keys is reserved.
KEY_F(n) For 0 < n < 63
KEY_DL Delete line
KEY_IL Insert line
KEY_DC Delete character
KEY_IC Insert char or enter insert mode
KEY_EIC Exit insert char mode
KEY_CLEAR Clear screen
KEY_EOS Clear to end of screen
KEY_EOL Clear to end of line
KEY_SF Scroll 1 line forward
KEY_SR Scroll 1 line backward (reverse)
KEY_NPAGE Next page
KEY_PPAGE Previous page
KEY_STAB Set tab
KEY_CTAB Clear tab
KEY_CATAB Clear all tabs
KEY_ENTER Enter or send
KEY_SRESET Soft (partial) reset
KEY_RESET Reset or hard reset
KEY_PRINT Print or copy
KEY_LL Home down or bottom (lower left). Keypad is
arranged like this:
A1 up A3
left B2 right
C1 down C3
KEY_A1 Upper left of keypad
KEY_A3 Upper right of keypad
KEY_B2 Center of keypad
KEY_C1 Lower left of keypad
KEY_C3 Lower right of keypad
KEY_BTAB Back tab key
KEY_BEG Beg(inning) key
KEY_CANCEL Cancel key
KEY_CLOSE Close key
KEY_COMMAND Cmd (command) key
KEY_COPY Copy key
KEY_CREATE Create key
KEY_END End key
KEY_EXIT Exit key
Page 2 Reliant UNIX 5.44 1, 1927
curs_getwch(3X) 27 Jan 1992 curs_getwch(3X)
__________________________________________________________________
Name Key name
__________________________________________________________________
KEY_FIND Find key
KEY_HELP Help key
KEY_MARK Mark key
KEY_MESSAGE Message key
KEY_MOVE Move key
KEY_NEXT Next object key
KEY_OPEN Open key
KEY_OPTIONS Options key
KEY_PREVIOUS Previous object key
KEY_REDO Redo key
KEY_REFERENCE Ref(erence) key
KEY_REFRESH Refresh key
KEY_REPLACE Replace key
KEY_RESTART Restart key
KEY_RESUME Resume key
KEY_SAVE Save key
KEY_SBEG Shifted beginning key
KEY_SCANCEL Shifted cancel key
KEY_SCOMMAND Shifted command key
KEY_SCOPY Shifted copy key
KEY_SCREATE Shifted create key
KEY_SDC Shifted delete char key
KEY_SDL Shifted delete line key
KEY_SELECT Select key
KEY_SEND Shifted end key
KEY_SEOL Shifted clear line key
KEY_SEXIT Shifted exit key
KEY_SFIND Shifted find key
KEY_SHELP Shifted help key
KEY_SHOME Shifted home key
KEY_SIC Shifted input key
KEY_SLEFT Shifted left arrow key
KEY_SMESSAGE Shifted message key
KEY_SMOVE Shifted move key
KEY_SNEXT Shifted next key
KEY_SOPTIONS Shifted options key
KEY_SPREVIOUS Shifted prev key
KEY_SPRINT Shifted print key
KEY_SREDO Shifted redo key
KEY_SREPLACE Shifted replace key
KEY_SRIGHT Shifted right arrow
KEY_SRSUME Shifted resume key
KEY_SSAVE Shifted save key
KEY_SSUSPEND Shifted suspend key
KEY_SUNDO Shifted undo key
KEY_SUSPEND Suspend key
KEY_UNDO Undo key
Page 3 Reliant UNIX 5.44 1, 1927
curs_getwch(3X) 27 Jan 1992 curs_getwch(3X)
__________________________________________________________________
Name Key name
__________________________________________________________________
RETURN VALUE
All routines return the integer ERR upon failure and an integer value
other than ERR upon successful completion.
NOTES
The header file <curses.h> automatically includes the header files
<stdio.h> and <unctrl.h>.
Use of the escape key by a programmer for a single character function
is discouraged.
When using getwch, wgetwch, mvgetwch, or mvwgetwch, nocbreak mode
(nocbreak) and echo mode (echo) should not be used at the same time.
Depending on the state of the tty driver when each character is typed,
the program may produce undesirable results.
Note that getwch, mvgetwch, and mvwgetwch may be macros.
WARNING
Be careful that the function key codes which may be returned when
keypad is enabled do not conflict with the EUC process code values of
supplementary characters which may be read by the program (see
<wctype.h>).
When using 16 bit wchart process codes (typeset unsigned short),
function key codes can appear to be characters from code sets 0 or 2.
For example, KEY_MIN (0x101) through KEY_SDC (0x17f) have the
H_EUCMASK bits set to H_P00 like characters from code set 0, though
their values are greater than any valid code set 0 character. Simi-
larly, KEY_SDL (0x180) through KEY_MOUSE (0x199) and KEY_MAX (0x1ff)
have the H_EUCMASK bits set to H_P01, so they may be identical to
characters from code set 2. This will depend on the ranges of code set
2 character values, according to the character type table for the
LC_CTYPE category of the current locale, see wchrtbl(1M).
With 32 bit wchart process codes (typeset long) all function key
codes appear to be from code set 0, as the function key codes do not
overlap the EUCMASK bits. However as function key codes are all
KEY_MIN or greater they can be distinguished from valid code set 0
characters (which are less than 0x7f), and control1 characters (0x80-
0x9f).
SEE ALSO
curses(3X), cursinopts(3X), cursmove(3X), cursrefresh(3X).
Page 4 Reliant UNIX 5.44 1, 1927