2 ****************************************************************************
3 * Copyright 2018-2019,2020 Thomas E. Dickey *
4 * Copyright 2002-2016,2017 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_get_wch.3x,v 1.13 2020/02/02 23:34:34 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_get_wch 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_get_wch 3x</H1>
44 <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG> <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, <STRONG>mvwget_wch</STRONG>, <STRONG>unget_wch</STRONG> - get (or push
51 back) a wide character from curses terminal keyboard
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
57 <STRONG>int</STRONG> <STRONG>get_wch(wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>wget_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>mvget_wch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>mvwget_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
61 <STRONG>int</STRONG> <STRONG>unget_wch(const</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG>
64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65 The <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions read a char-
66 acter from the terminal associated with the current or specified win-
67 dow. In no-delay mode, if no input is waiting, the value <STRONG>ERR</STRONG> is re-
68 turned. In delay mode, the program waits until the system passes text
69 through to the program. Depending on the setting of <STRONG>cbreak</STRONG>, this is
70 after one character (cbreak mode), or after the first newline (nocbreak
71 mode). In half-delay mode, the program waits until the user types a
72 character or the specified timeout interval has elapsed.
74 Unless <STRONG>noecho</STRONG> has been set, these routines echo the character into the
77 If the window is not a pad and has been moved or modified since the
78 last call to <STRONG>wrefresh</STRONG>, <STRONG>wrefresh</STRONG> will be called before another character
81 If <STRONG>keypad</STRONG> is enabled, these functions respond to the pressing of a
82 function key by setting the object pointed to by <EM>wch</EM> to the keycode as-
83 signed to the function key, and returning <STRONG>KEY_CODE_YES</STRONG>. If a character
84 (such as escape) that could be the beginning of a function key is re-
85 ceived, curses sets a timer. If the remainder of the sequence does ar-
86 rive within the designated time, curses passes through the character;
87 otherwise, curses returns the function key value. For this reason,
88 many terminals experience a delay between the time a user presses the
89 escape key and the time the escape is returned to the program.
91 The keycodes returned by these functions are the same as those returned
92 by <STRONG>wgetch</STRONG>:
94 <STRONG>o</STRONG> The predefined function keys are listed in <STRONG><curses.h></STRONG> as macros
95 with values outside the range of 8-bit characters. Their names be-
96 gin with <STRONG>KEY_</STRONG>.
98 <STRONG>o</STRONG> Other (user-defined) function keys which may be defined using <STRONG>de-</STRONG>
99 <STRONG><A HREF="define_key.3x.html">fine_key(3x)</A></STRONG> have no names, but also are expected to have values
100 outside the range of 8-bit characters.
102 The <STRONG>unget_wch</STRONG> function pushes the wide character <EM>wch</EM> back onto the head
103 of the input queue, so the wide character is returned by the next call
104 to <STRONG>get_wch</STRONG>. The pushback of one character is guaranteed. If the pro-
105 gram calls <STRONG>unget_wch</STRONG> too many times without an intervening call to
106 <STRONG>get_wch</STRONG>, the operation may fail.
109 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
110 The header file <STRONG><curses.h></STRONG> automatically includes the header file
111 <STRONG><stdio.h></STRONG>.
113 Applications should not define the escape key by itself as a single-
116 When using <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, or <STRONG>mvwget_wch</STRONG>, applications
117 should not use <STRONG>nocbreak</STRONG> mode and <STRONG>echo</STRONG> mode at the same time. Depending
118 on the state of the tty driver when each character is typed, the pro-
119 gram may produce undesirable results.
121 All functions except <STRONG>wget_wch</STRONG> and <STRONG>unget_wch</STRONG> may be macros.
124 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
125 When <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions successful-
126 ly report the pressing of a function key, they return <STRONG>KEY_CODE_YES</STRONG>.
127 When they successfully report a wide character, they return <STRONG>OK</STRONG>. Other-
128 wise, they return <STRONG>ERR</STRONG>.
130 Upon successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>. Otherwise, the func-
131 tion returns <STRONG>ERR</STRONG>.
133 Functions with a "mv" prefix first perform a cursor movement using
134 <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
135 the window pointer is null.
138 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
139 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>,
140 <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
144 <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
148 <li><a href="#h2-NAME">NAME</a></li>
149 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
150 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
151 <li><a href="#h2-NOTES">NOTES</a></li>
152 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
153 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>