]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_get_wch.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 6.2 - patch 20210626
[ncurses.git] / doc / html / man / curs_get_wch.3x.html
diff --git a/doc/html/man/curs_get_wch.3x.html b/doc/html/man/curs_get_wch.3x.html
index 718a9723fe467e270e8f52266832acd96dc82270..232e8a26deec6830b9b270c369ddb6866205c28b 100644 (file)
--- a/doc/html/man/curs_get_wch.3x.html
+++ b/doc/html/man/curs_get_wch.3x.html
@@ -34,56 +34,56 @@
 <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">
 <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>
 <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>
 <PRE>
-<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>
+<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>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <B>get_wch</B>, <B>wget_wch</B>, <B>mvget_wch</B>, <B>mvwget_wch</B>, <B>unget_wch</B> - get (or push
+       <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 keyboard
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
        back) a wide character from curses terminal keyboard
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</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>
+       <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>
 
 
-       <B>int</B> <B>unget_wch(const</B> <B>wchar_t</B> <I>wch</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>unget_wch(const</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
 </PRE><H3><a name="h3-wget_wch">wget_wch</a></H3><PRE>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
 </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-
+       The <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions read a char-
        acter  from  the terminal associated with the current or specified win-
        acter  from  the terminal associated with the current or specified win-
-       dow.  In no-delay mode, if no input is waiting, the value  <B>ERR</B>  is  re-
+       dow.  In no-delay mode, if no input is waiting, the value  <STRONG>ERR</STRONG>  is  re-
        turned.   In delay mode, the program waits until the system passes text
        turned.   In delay mode, the program waits until the system passes text
-       through to the program.  Depending on the setting of  <B>cbreak</B>,  this  is
+       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.
 
        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  <B>noecho</B> has been set, these routines echo the character into the
+       Unless  <STRONG>noecho</STRONG> 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
        designated window.
 
        If the window is not a pad and has been moved  or  modified  since  the
-       last call to <B>wrefresh</B>, <B>wrefresh</B> will be called before another character
+       last call to <STRONG>wrefresh</STRONG>, <STRONG>wrefresh</STRONG> will be called before another character
        is read.
 
        is read.
 
-       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
+       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
        (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;
        (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;
@@ -92,66 +92,66 @@
        escape key and the time the escape is returned to the program.
 
        The keycodes returned by these functions are the same as those returned
        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 <B>wgetch</B>:
+       by <STRONG>wgetch</STRONG>:
 
 
-       <B>o</B>   The  predefined  function  keys  are listed in <B>&lt;curses.h&gt;</B> as macros
+       <STRONG>o</STRONG>   The  predefined  function  keys  are listed in <STRONG>&lt;curses.h&gt;</STRONG> as macros
            with values outside the range of 8-bit characters.  Their names be-
            with values outside the range of 8-bit characters.  Their names be-
-           gin with <B>KEY_</B>.
+           gin with <STRONG>KEY_</STRONG>.
 
 
-       <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
+       <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
            outside the range of 8-bit characters.
 
 
 </PRE><H3><a name="h3-unget_wch">unget_wch</a></H3><PRE>
            outside the range of 8-bit characters.
 
 
 </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
+       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
        of the input queue, so the wide character is returned by the next  call
-       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.
+       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.
 
 
-       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.
+       Unlike <STRONG>ungetch</STRONG> and <STRONG>wgetch</STRONG>, <STRONG>unget_wch</STRONG> cannot distinguish special charac-
+       ters returned by <STRONG>wget_wch</STRONG> from ordinary characters.  An application can
+       push  special  keys  which it may read via <STRONG>wget_wch</STRONG> by checking for the
+       <STRONG>KEY_CODE_YES</STRONG> result, and using <STRONG>ungetch</STRONG> for those special keys.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       The header file  <B>&lt;curses.h&gt;</B>  automatically  includes  the  header  file
-       <B>&lt;stdio.h&gt;</B>.
+       The header file  <STRONG>&lt;curses.h&gt;</STRONG>  automatically  includes  the  header  file
+       <STRONG>&lt;stdio.h&gt;</STRONG>.
 
        Applications  should  not  define the escape key by itself as a single-
        character function.
 
 
        Applications  should  not  define the escape key by itself as a single-
        character function.
 
-       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
+       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-
        gram may produce undesirable results.
 
        on the state of the tty driver when each character is typed,  the  pro-
        gram may produce undesirable results.
 
-       All functions except <B>wget_wch</B> and <B>unget_wch</B> may be macros.
+       All functions except <STRONG>wget_wch</STRONG> and <STRONG>unget_wch</STRONG> may be macros.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       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>.
+       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>.
 
 
-       Upon successful completion, <B>unget_wch</B> returns <B>OK</B>.  Otherwise, the func-
-       tion returns <B>ERR</B>.
+       Upon successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>.  Otherwise, the func-
+       tion returns <STRONG>ERR</STRONG>.
 
        Functions  with  a  "mv"  prefix  first perform a cursor movement using
 
        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
+       <STRONG>wmove</STRONG>, 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>
        the window pointer is null.
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <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="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="curs_get_wch.3X.html">curs_get_wch(3X)</A></B>
+                                                              <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>
 </PRE>
 <div class="nav">
 <ul>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/