|curs_get_wch(3X)||Miscellaneous Library Functions||curs_get_wch(3X)|
int get_wch(wint_t *wch);
int wget_wch(WINDOW *win, wint_t *wch);
int mvget_wch(int y, int x, wint_t *wch );
int mvwget_wch(WINDOW *win, int y, int x , wint_t *wch);
int unget_wch(const wchar_t wch);
Unless noecho has been set, these routines echo the character into the designated window.
If the window is not a pad and has been moved or modified since the last call to wrefresh, wrefresh will be called before another character is read.
If keypad is enabled, these functions respond to the pressing of a function key by setting the object pointed to by wch to the keycode assigned to the function key, and returning KEY_CODE_YES. If a character (such as escape) that could be the beginning of a function key is received, curses sets a timer. If the remainder of the sequence does arrive within the designated time, curses passes through the character; otherwise, curses returns the function key value. For this reason, many terminals experience a delay between the time a user presses the escape key and the time the escape is returned to the program.
The keycodes returned by these functions are the same as those returned by wgetch:
Unlike ungetch and wgetch, unget_wch cannot distinguish special characters returned by wget_wch from ordinary characters. An application can push special keys which it may read via wget_wch by checking for the KEY_CODE_YES result, and using ungetch for those special keys.
Applications should not define the escape key by itself as a single-character function.
When using get_wch, wget_wch, mvget_wch, or mvwget_wch, applications should not use nocbreak mode and echo mode at the same time. Depending on the state of the tty driver when each character is typed, the program may produce undesirable results.
All functions except wget_wch and unget_wch may be macros.
Upon successful completion, unget_wch returns OK. Otherwise, the function returns ERR.
Functions with a “mv” prefix first perform a cursor movement using wmove, and return an error if the position is outside the window, or if the window pointer is null.