int getch(void); int wgetch(WINDOW *win); int mvgetch(int y, int x); int mvwgetch(WINDOW *win, int y, int x); int ungetch(int ch);
If noecho(3) has been set, then the character will also be echoed into the designated window according to the following rules: If the character is the current erase character, left arrow, or backspace, the cursor is moved one space to the left and that screen position is erased as if delch(3) had been called. If the character value is any other KEY_ define, the user is alerted with a beep(3) call. Otherwise the character is simply output to the screen.
If the window is not a pad, and it has been moved or modified since the last call to wrefresh(3), wrefresh(3) will be called before another character is read.
If keypad(3) is TRUE, and a function key is pressed, the token for that function key is returned instead of the raw characters. Possible function keys are defined in <curses.h> as macros with values outside the range of 8-bit characters whose names begin with KEY_. Thus, a variable intended to hold the return value of a function key must be of short size or larger.
When a character that could be the beginning of a function key is received (which, on modern terminals, means an escape character), 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 function 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 ungetch(3) routine places ch back onto the input queue to be returned by the next call to wgetch(3). Note that there is, in effect, just one input queue for all windows.
|KEY_DOWN||The four arrow keys ...|
|KEY_HOME||Home key (upward+left arrow)|
|KEY_F0||Function keys; space for 64 keys is reserved.|
|KEY_F(n)||For 0 < n < 63|
|KEY_IC||Insert char or enter insert mode|
|KEY_EIC||Exit insert char mode|
|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_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_COMMAND||Cmd (command) key|
|KEY_NEXT||Next object key|
|KEY_PREVIOUS||Previous object 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_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|
When using getch(3), wgetch(3), mvgetch(3), or mvwgetch(3), nocbreak mode (nocbreak(3)) and echo mode (echo(3)) 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 getch(3), mvgetch(3), and mvwgetch(3) may be macros.
Historically, the set of keypad macros was largely defined by the extremely function-key-rich keyboard of the AT&T 7300, aka 3B1, aka Safari 4. Modern personal computers usually have only a small subset of these. IBM PC-style consoles typically support little more than KEY_UP , KEY_DOWN, KEY_LEFT, KEY_RIGHT , KEY_HOME, KEY_END, KEY_NPAGE, KEY_PPAGE, and function keys 1 through 12. The Ins key is usually mapped to KEY_IC.
The echo behavior of these functions on input of KEY_ or backspace characters was not specified. This description is adopted from the XSI Curses standard.