diff options
Diffstat (limited to 'ncurses-5.3/doc/html/man/curs_get_wch.3x.html')
| -rw-r--r-- | ncurses-5.3/doc/html/man/curs_get_wch.3x.html | 170 |
1 files changed, 170 insertions, 0 deletions
diff --git a/ncurses-5.3/doc/html/man/curs_get_wch.3x.html b/ncurses-5.3/doc/html/man/curs_get_wch.3x.html new file mode 100644 index 0000000..ddd3f4b --- /dev/null +++ b/ncurses-5.3/doc/html/man/curs_get_wch.3x.html @@ -0,0 +1,170 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2002 Free Software Foundation, Inc. * + * * + * Permission is hereby granted, free of charge, to any person obtaining a * + * copy of this software and associated documentation files (the * + * "Software"), to deal in the Software without restriction, including * + * without limitation the rights to use, copy, modify, merge, publish, * + * distribute, distribute with modifications, sublicense, and/or sell * + * copies of the Software, and to permit persons to whom the Software is * + * furnished to do so, subject to the following conditions: * + * * + * The above copyright notice and this permission notice shall be included * + * in all copies or substantial portions of the Software. * + * * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * + * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * + * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * + * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * + * * + * Except as contained in this notice, the name(s) of the above copyright * + * holders shall not be used in advertising or otherwise to promote the * + * sale, use or other dealings in this Software without prior written * + * authorization. * + **************************************************************************** + * @Id: curs_get_wch.3x,v 1.3 2002/05/18 21:48:53 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>curs_get_wch 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>curs_get_wch 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</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 back) a wide character from curses terminal key- + board + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + + <STRONG>int</STRONG> <STRONG>get_wch(win_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>win_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>win_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>win_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> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions + read a character from the terminal associated with the + current or specified window. In no-delay mode, if no + input is waiting, the value <STRONG>ERR</STRONG> is returned. 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 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 char- + acter 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 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 corresponding <STRONG>KEY_</STRONG> value defined in + <STRONG><curses.h></STRONG> and returning <STRONG>KEY_CODE_YES</STRONG>. 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 <STRONG>unget_wch</STRONG> function pushes the wide character <EM>wch</EM> 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 program calls <STRONG>unget_wch</STRONG> + too many times without an intervening call to <STRONG>get_wch</STRONG>, the + operation may fail. + + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <STRONG><curses.h></STRONG> automatically includes the + header file <STRONG><stdio.h></STRONG>. + + 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 program may produce + undesirable results. + + All functions except <STRONG>wget_wch</STRONG> and <STRONG>unget_wch</STRONG> may be macros. + + +</PRE> +<H2>RETURN VALUES</H2><PRE> + When <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> func- + tions successfully 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>. Otherwise, they return + <STRONG>ERR</STRONG>. + + Upon successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>. Other- + wise, the function returns <STRONG>ERR</STRONG>. + + +</PRE> +<H2>SEE ALSO</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> + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |