Curses Library Functions cursgetwch(3CURSES)
NAME
cursgetwch, getwch, wgetwch, mvgetwch, mvwgetwch, ungetwch
- get (or push back) wchart characters from curses terminal
keyboard
SYNOPSIS
cc [ flag ... ] file ... -lcurses [ library .. ]
#include
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() rou-
tines read an EUC character from the terminal associated
with the window, transform it into a wchart character, and
return a wchart character. In no-delay mode, if no input is
waiting, the value ER is returned. In delay mode, the pro-
gram waits until the system passes text through to the pro-
gram. Depending on the setting of cbreak, this is after one
character ( cbreak mode ), or after the first newline (noc-
break 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 modi-
fied since the last call to wrefresh(3CURSES), 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 charac-
ters. Possible function keys are defined in with
integers beginning with 0401, whose names begin with KEY.
If a character that could be the beginning of a function key
(such as escape) is received, curses(3CURSES) sets a timer.
If the remainder of the sequence does not come in within the
designated time, the character is passed through; otherwise,
SunOS 5.11 Last change: 31 Dec 1996 1
Curses Library Functions cursgetwch(3CURSES)
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 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 , might
be returned by getwch() if keypad has been enabled. Note
that not all of these may be supported on a particular ter-
minal 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(4) database.
SunOS 5.11 Last change: 31 Dec 1996 2
Curses Library Functions cursgetwch(3CURSES)
SunOS 5.11 Last change: 31 Dec 1996 3
Curses Library Functions cursgetwch(3CURSES)
Name Key name
KEYBREAK Break key
KEYDOWN The four arrow keys ...
KEYUP
KEYLEFT
KEYRIGHT
KEYHOME Home key (upward]left arrow)
KEYBACKSPACE Backspace
KEYF0 Function keys; space for 64 keys
is reserved.
KEYF(n) For 0 < n < 63
KEYDL Delete line
KEYIL Insert line
KEYDC Delete character
KEYIC Insert char or enter insert mode
KEYEIC Exit insert char mode
KEYCLEAR Clear screen
KEYEOS Clear to end of screen
KEYEOL Clear to end of line
KEYSF Scroll 1 line forward
KEYSR Scroll 1 line backward (reverse)
KEYNPAGE Next page
KEYPAGE Previous page
KEYSTAB Set tab
KEYCTAB Clear tab
KEYCATAB Clear all tabs
KEYENTER Enter or send
KEYSRESET Soft (partial) reset
KEYRESET Reset or hard reset
KEYPRINT Print or copy
KEYL Home down or bottom (lower
left). Keypad is arranged like
this: A1 up A3 left
B2 right C1 down C3
KEYA1 Upper left of keypad
KEYA3 Upper right of keypad
KEYB2 Center of keypad
KEYC1 Lower left of keypad
KEYC3 Lower right of keypad
KEYBTAB Back tab key
KEYBEG Beg(inning) key
KEYCANCEL Cancel key
KEYCLOSE Close key
KEYCOMAND Cmd (command) key
KEYCOPY Copy key
KEYCREATE Create key
KEYEND End key
KEYEXIT Exit key
KEYFIND Find key
KEYHELP Help key
SunOS 5.11 Last change: 31 Dec 1996 4
Curses Library Functions cursgetwch(3CURSES)
KEYMARK Mark key
KEYMESAGE Message key
KEYMOVE Move key
KEYNEXT Next object key
KEYOPEN Open key
KEYOPTIONS Options key
KEYPREVIOUS Previous object key
KEYREDO Redo key
KEYREFERENCE Reference key
KEYREFRESH Refresh key
KEYREPLACE Replace key
KEYRESTART Restart key
KEYRESUME Resume key
KEYSAVE Save key
KEYSBEG Shifted beginning key
KEYSCANCEL Shifted cancel key
KEYSCOMAND Shifted command key
KEYSCOPY Shifted copy key
KEYSCREATE Shifted create key
KEYSDC Shifted delete char key
KEYSDL Shifted delete line key
KEYSELECT Select key
KEYSEND Shifted end key
KEYSEOL Shifted clear line key
KEYSEXIT Shifted exit key
KEYSFIND Shifted find key
KEYSHELP Shifted help key
KEYSHOME Shifted home key
KEYSIC Shifted input key
KEYSLEFT Shifted left arrow key
KEYSMESAGE Shifted message key
KEYSMOVE Shifted move key
KEYSNEXT Shifted next key
KEYSOPTIONS Shifted options key
KEYSPREVIOUS Shifted prev key
KEYSPRINT Shifted print key
KEYSREDO Shifted redo key
KEYSREPLACE Shifted replace key
KEYSRIGHT Shifted right arrow
KEYSRSUME Shifted resume key
KEYSAVE Shifted save key
KEYSUSPEND Shifted suspend key
KEYSUNDO Shifted undo key
KEYSUSPEND Suspend key
KEYUNDO Undo key
RETURN VALUE
All routines return the integer ER upon failure and an
integer value other than ER upon successful completion.
SunOS 5.11 Last change: 31 Dec 1996 5
Curses Library Functions cursgetwch(3CURSES)
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
MT-Level Unsafe
SEE ALSO
curses(3CURSES), cursinopts(3CURSES), cursmove(3CURSES),
wrefresh(3CURSES), terminfo(4), attributes(5)
NOTES
The header file automatically includes the header
files , and .
Use of the escape key by a programmer for a single character
function is discouraged.
When using getwch(), wgetwch(), mvgetwch(), or
mvwgetwch(), nocbreak mode and echo mode 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 mac-
ros.
SunOS 5.11 Last change: 31 Dec 1996 6
|
