'\" te .\" Copyright 1989 AT&T .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] .TH curs_getch 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions" .SH NAME curs_getch, getch, wgetch, mvgetch, mvwgetch, ungetch \- get (or push back) characters from curses terminal keyboard .SH SYNOPSIS .LP .nf \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ] #include \fBint\fR \fBgetch\fR(\fBvoid\fR); .fi .LP .nf \fBint\fR \fBwgetch\fR(\fBWINDOW *\fR\fIwin\fR); .fi .LP .nf \fBint\fR \fBmvgetch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR); .fi .LP .nf \fBint\fR \fBmvwgetch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); .fi .LP .nf \fBint\fR \fBungetch\fR(\fBint\fR \fIch\fR); .fi .SH DESCRIPTION .sp .LP With the \fBgetch()\fR, \fBwgetch()\fR, \fBmvgetch()\fR, and \fBmvwgetch()\fR routines a character is read from the terminal associated with the window. In no-delay mode, if no input is waiting, the value \fBERR\fR is returned. In delay mode, the program waits until the system passes text through to the program. Depending on the setting of \fBcbreak()\fR, 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 \fBnoecho()\fR has been set, the character will also be echoed into the designated window. .sp .LP If the window is not a pad, and it has been moved or modified since the last call to \fBwrefresh()\fR, \fBwrefresh()\fR will be called before another character is read. .sp .LP If \fBkeypad()\fR is \fBTRUE\fR, 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 \fB\fR with integers beginning with \fB0401\fR, whose names begin with \fBKEY_\fR. If a character that could be the beginning of a function key (such as escape) is received, \fBcurses\fR 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. Since tokens returned by these routines are outside the \fBASCII\fR range, they are not printable. .sp .LP The \fBungetch()\fR routine places \fIch\fR back onto the input queue to be returned by the next call to \fBwgetch()\fR. .SS "Function Keys" .sp .LP The following function keys, defined in \fB\fR, might be returned by \fBgetch()\fR if \fBkeypad()\fR 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 \fIterminfo\fR database. .sp .sp .TS tab(); cw(2.75i) cw(2.75i) lw(2.75i) lw(2.75i) . \fBName\fR\fBKey name\fR _ KEY_BREAKBreak key KEY_DOWNThe four arrow keys \|.\|.\|. KEY_UP KEY_LEFT KEY_RIGHT KEY_HOMEHome key (upward+left arrow) KEY_BACKSPACEBackspace KEY_F0T{ Function keys; space for 64 keys is reserved. T} KEY_F(\fBn\fR)For 0 \(<= \fBn\fR \(<= 63 KEY_DLDelete line KEY_ILInsert line KEY_DCDelete character KEY_ICInsert char or enter insert mode KEY_EICExit insert char mode KEY_CLEARClear screen KEY_EOSClear to end of screen KEY_EOLClear to end of line KEY_SFScroll 1 line forward KEY_SRScroll 1 line backward (reverse) KEY_NPAGENext page KEY_PPAGEPrevious page KEY_STABSet tab KEY_CTABClear tab KEY_CATABClear all tabs KEY_ENTEREnter or send KEY_SRESETSoft (partial) reset KEY_RESETReset or hard reset KEY_PRINTPrint or copy KEY_LLT{ Home down or bottom (lower left). Keypad is arranged like this: (Row 1) A1 up A3 (Row 2) left B2 right (Row 3) C1 down C3 T} KEY_A1Upper left of keypad KEY_A3Upper right of keypad KEY_B2Center of keypad KEY_C1Lower left of keypad KEY_C3Lower right of keypad KEY_BTABBack tab key KEY_BEGBeg(inning) key KEY_CANCELCancel key KEY_CLOSEClose key KEY_COMMANDCmd (command) key KEY_COPYCopy key KEY_CREATECreate key KEY_ENDEnd key KEY_EXITExit key KEY_FINDFind key KEY_HELPHelp key KEY_MARKMark key KEY_MESSAGEMessage key KEY_MOVEMove key KEY_NEXTNext object key KEY_OPENOpen key KEY_OPTIONSOptions key KEY_PREVIOUSPrevious object key KEY_REDORedo key KEY_REFERENCEReference key KEY_REFRESH Refresh key KEY_REPLACEReplace key KEY_RESTARTRestart key KEY_RESUMEResume key KEY_SAVESave key KEY_SBEGShifted beginning key KEY_SCANCELShifted cancel key KEY_SCOMMANDShifted command key KEY_SCOPYShifted copy key KEY_SCREATEShifted create key KEY_SDCShifted delete char key KEY_SDLShifted delete line key KEY_SELECTSelect key KEY_SENDShifted end key KEY_SEOLShifted clear line key KEY_SEXITShifted exit key KEY_SFINDShifted find key KEY_SHELPShifted help key KEY_SHOMEShifted home key KEY_SICShifted input key KEY_SLEFTShifted left arrow key KEY_SMESSAGEShifted message key KEY_SMOVEShifted move key KEY_SNEXTShifted next key KEY_SOPTIONSShifted options key KEY_SPREVIOUSShifted prev key KEY_SPRINTShifted print key KEY_SREDOShifted redo key KEY_SREPLACEShifted replace key KEY_SRIGHTShifted right arrow KEY_SRSUMEShifted resume key KEY_SSAVEShifted save key KEY_SSUSPENDShifted suspend key KEY_SUNDOShifted undo key KEY_SUSPENDSuspend key KEY_UNDOUndo key .TE .SH RETURN VALUES .sp .LP All routines return the integer \fBERR\fR upon failure. The \fBungetch()\fR routine returns an integer value other than \fBERR\fR upon successful completion. The other routines return the next input character or function key code upon successful completion. .SH ATTRIBUTES .sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp .sp .TS tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) . ATTRIBUTE TYPEATTRIBUTE VALUE _ MT-LevelUnsafe .TE .SH SEE ALSO .sp .LP \fBcurs_inopts\fR(3CURSES), \fBcurs_move\fR(3CURSES), \fBcurs_refresh\fR(3CURSES), \fBcurses\fR(3CURSES), \fBattributes\fR(5) .SH NOTES .sp .LP The header <\fBcurses.h\fR> automatically includes the headers <\fBstdio.h\fR> and <\fBunctrl.h\fR>. .sp .LP Use of the escape key for a single character function is discouraged. .sp .LP When using \fBgetch()\fR, \fBwgetch()\fR, \fBmvgetch()\fR, or \fBmvwgetch()\fR, \fBnocbreak\fR mode (\fBnocbreak()\fR) and \fBecho\fR mode (\fBecho()\fR) 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. .sp .LP Note that \fBgetch()\fR, \fBmvgetch()\fR, and \fBmvwgetch()\fR may be macros.