-<!--
+<!--
****************************************************************************
- * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 2018-2020,2021 Thomas E. Dickey *
* Copyright 2002-2016,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_get_wch.3x,v 1.13 2020/02/02 23:34:34 tom Exp @
+ * @Id: curs_get_wch.3x,v 1.15 2021/05/22 22:33:19 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_get_wch 3x</TITLE>
+<TITLE>curs_get_wch 3X</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1 class="no-header">curs_get_wch 3x</H1>
+<H1 class="no-header">curs_get_wch 3X</H1>
<PRE>
-<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>
+<B><A HREF="curs_get_wch.3X.html">curs_get_wch(3X)</A></B> <B><A HREF="curs_get_wch.3X.html">curs_get_wch(3X)</A></B>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, <STRONG>mvwget_wch</STRONG>, <STRONG>unget_wch</STRONG> - get (or push
+ <B>get_wch</B>, <B>wget_wch</B>, <B>mvget_wch</B>, <B>mvwget_wch</B>, <B>unget_wch</B> - get (or push
back) a wide character from curses terminal keyboard
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
+ <B>#include</B> <B><curses.h></B>
- <STRONG>int</STRONG> <STRONG>get_wch(wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
- <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>
- <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>
- <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>
- <STRONG>int</STRONG> <STRONG>unget_wch(const</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG>
+ <B>int</B> <B>get_wch(wint_t</B> <B>*</B><I>wch</I><B>);</B>
+ <B>int</B> <B>wget_wch(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>wint_t</B> <B>*</B><I>wch</I><B>);</B>
+ <B>int</B> <B>mvget_wch(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>wint_t</B> <B>*</B><I>wch</I><B>);</B>
+ <B>int</B> <B>mvwget_wch(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>wint_t</B> <B>*</B><I>wch</I><B>);</B>
+
+ <B>int</B> <B>unget_wch(const</B> <B>wchar_t</B> <I>wch</I><B>);</B>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions read a char-
+
+</PRE><H3><a name="h3-wget_wch">wget_wch</a></H3><PRE>
+ The <B>get_wch</B>, <B>wget_wch</B>, <B>mvget_wch</B>, and <B>mvwget_wch</B> functions read a char-
acter from the terminal associated with the current or specified win-
- dow. In no-delay mode, if no input is waiting, the value <STRONG>ERR</STRONG> is re-
+ dow. In no-delay mode, if no input is waiting, the value <B>ERR</B> is re-
turned. In delay mode, the program waits until the system passes text
- through to the program. Depending on the setting of <STRONG>cbreak</STRONG>, this is
+ through to the program. Depending on the setting of <B>cbreak</B>, this is
after one character (cbreak mode), or after the first newline (nocbreak
mode). In half-delay mode, the program waits until the user types a
character or the specified timeout interval has elapsed.
- Unless <STRONG>noecho</STRONG> has been set, these routines echo the character into the
+ Unless <B>noecho</B> 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 <STRONG>wrefresh</STRONG>, <STRONG>wrefresh</STRONG> will be called before another character
+ last call to <B>wrefresh</B>, <B>wrefresh</B> will be called before another character
is read.
- If <STRONG>keypad</STRONG> is enabled, these functions respond to the pressing of a
- function key by setting the object pointed to by <EM>wch</EM> to the keycode as-
- signed to the function key, and returning <STRONG>KEY_CODE_YES</STRONG>. If a character
+ If <B>keypad</B> is enabled, these functions respond to the pressing of a
+ function key by setting the object pointed to by <I>wch</I> to the keycode as-
+ signed to the function key, and returning <B>KEY_CODE_YES</B>. If a character
(such as escape) that could be the beginning of a function key is re-
ceived, curses sets a timer. If the remainder of the sequence does ar-
rive within the designated time, curses passes through the character;
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 <STRONG>wgetch</STRONG>:
+ by <B>wgetch</B>:
- <STRONG>o</STRONG> The predefined function keys are listed in <STRONG><curses.h></STRONG> as macros
+ <B>o</B> The predefined function keys are listed in <B><curses.h></B> as macros
with values outside the range of 8-bit characters. Their names be-
- gin with <STRONG>KEY_</STRONG>.
+ gin with <B>KEY_</B>.
- <STRONG>o</STRONG> Other (user-defined) function keys which may be defined using <STRONG>de-</STRONG>
- <STRONG><A HREF="define_key.3x.html">fine_key(3x)</A></STRONG> have no names, but also are expected to have values
+ <B>o</B> Other (user-defined) function keys which may be defined using <B>de-</B>
+ <B><A HREF="define_key.3X.html">fine_key(3X)</A></B> have no names, but also are expected to have values
outside the range of 8-bit characters.
- The <STRONG>unget_wch</STRONG> function pushes the wide character <EM>wch</EM> back onto the head
+
+</PRE><H3><a name="h3-unget_wch">unget_wch</a></H3><PRE>
+ The <B>unget_wch</B> function pushes the wide character <I>wch</I> back onto the head
of the input queue, so the wide character is returned by the next call
- to <STRONG>get_wch</STRONG>. The pushback of one character is guaranteed. If the pro-
- gram calls <STRONG>unget_wch</STRONG> too many times without an intervening call to
- <STRONG>get_wch</STRONG>, the operation may fail.
+ to <B>get_wch</B>. The pushback of one character is guaranteed. If the pro-
+ gram calls <B>unget_wch</B> too many times without an intervening call to
+ <B>get_wch</B>, the operation may fail.
+
+ Unlike <B>ungetch</B> and <B>wgetch</B>, <B>unget_wch</B> cannot distinguish special charac-
+ ters returned by <B>wget_wch</B> from ordinary characters. An application can
+ push special keys which it may read via <B>wget_wch</B> by checking for the
+ <B>KEY_CODE_YES</B> result, and using <B>ungetch</B> for those special keys.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- The header file <STRONG><curses.h></STRONG> automatically includes the header file
- <STRONG><stdio.h></STRONG>.
+ The header file <B><curses.h></B> automatically includes the header file
+ <B><stdio.h></B>.
- Applications should not define the escape key by itself as a single-
+ Applications should not define the escape key by itself as a single-
character function.
- When using <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, or <STRONG>mvwget_wch</STRONG>, applications
- should not use <STRONG>nocbreak</STRONG> mode and <STRONG>echo</STRONG> mode at the same time. Depending
- on the state of the tty driver when each character is typed, the pro-
+ When using <B>get_wch</B>, <B>wget_wch</B>, <B>mvget_wch</B>, or <B>mvwget_wch</B>, applications
+ should not use <B>nocbreak</B> mode and <B>echo</B> mode at the same time. Depending
+ on the state of the tty driver when each character is typed, the pro-
gram may produce undesirable results.
- All functions except <STRONG>wget_wch</STRONG> and <STRONG>unget_wch</STRONG> may be macros.
+ All functions except <B>wget_wch</B> and <B>unget_wch</B> may be macros.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- When <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions successful-
- ly report the pressing of a function key, they return <STRONG>KEY_CODE_YES</STRONG>.
- When they successfully report a wide character, they return <STRONG>OK</STRONG>. Other-
- wise, they return <STRONG>ERR</STRONG>.
+ When <B>get_wch</B>, <B>wget_wch</B>, <B>mvget_wch</B>, and <B>mvwget_wch</B> functions successful-
+ ly report the pressing of a function key, they return <B>KEY_CODE_YES</B>.
+ When they successfully report a wide character, they return <B>OK</B>. Other-
+ wise, they return <B>ERR</B>.
- Upon successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>. Otherwise, the func-
- tion returns <STRONG>ERR</STRONG>.
+ Upon successful completion, <B>unget_wch</B> returns <B>OK</B>. Otherwise, the func-
+ tion returns <B>ERR</B>.
- Functions with a "mv" prefix first perform a cursor movement using
- <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
+ Functions with a "mv" prefix first perform a cursor movement using
+ <B>wmove</B>, and return an error if the position is outside the window, or if
the window pointer is null.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <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>,
- <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_getch.3X.html">curs_getch(3X)</A></B>, <B><A HREF="curs_ins_wch.3X.html">curs_ins_wch(3X)</A></B>, <B><A HREF="curs_inopts.3X.html">curs_inopts(3X)</A></B>,
+ <B><A HREF="curs_move.3X.html">curs_move(3X)</A></B>, <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>
- <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
+ <B><A HREF="curs_get_wch.3X.html">curs_get_wch(3X)</A></B>
</PRE>
<div class="nav">
<ul>
<li><a href="#h2-NAME">NAME</a></li>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-wget_wch">wget_wch</a></li>
+<li><a href="#h3-unget_wch">unget_wch</a></li>
+</ul>
+</li>
<li><a href="#h2-NOTES">NOTES</a></li>
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
projects / ncurses.git / blobdiff