X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wch.3x.html;h=232e8a26deec6830b9b270c369ddb6866205c28b;hp=91c303eeb06ddae7e24646d9ddb283a973d7a29b;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=cb4427a16794d98049b4d790b810d62217501f9f diff --git a/doc/html/man/curs_get_wch.3x.html b/doc/html/man/curs_get_wch.3x.html index 91c303ee..232e8a26 100644 --- a/doc/html/man/curs_get_wch.3x.html +++ b/doc/html/man/curs_get_wch.3x.html @@ -1,6 +1,7 @@ - @@ -57,10 +58,13 @@ int wget_wch(WINDOW *win, wint_t *wch); int mvget_wch(int y, int x, wint_t *wch); int mvwget_wch(WINDOW *win, int y, int x, wint_t *wch); + int unget_wch(const wchar_t wch);

DESCRIPTION

+
+

wget_wch

        The get_wch, wget_wch, mvget_wch, and mvwget_wch 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  ERR  is  re-
@@ -98,23 +102,30 @@
            fine_key(3x) have no names, but also are expected  to  have  values
            outside the range of 8-bit characters.
 
+
+

unget_wch

        The unget_wch function pushes the wide character wch back onto the head
        of the input queue, so the wide character is returned by the next  call
        to  get_wch.  The pushback of one character is guaranteed.  If the pro-
        gram calls unget_wch too many times  without  an  intervening  call  to
        get_wch, the operation may fail.
 
+       Unlike ungetch and wgetch, unget_wch cannot distinguish special charac-
+       ters returned by wget_wch from ordinary characters.  An application can
+       push  special  keys  which it may read via wget_wch by checking for the
+       KEY_CODE_YES result, and using ungetch for those special keys.
+

NOTES

-       The  header  file  <curses.h>  automatically  includes  the header file
+       The header file  <curses.h>  automatically  includes  the  header  file
        <stdio.h>.
 
-       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  get_wch,  wget_wch, mvget_wch, or mvwget_wch, applications
+       When using get_wch, wget_wch, mvget_wch,  or  mvwget_wch,  applications
        should not use nocbreak mode and echo mode at the same time.  Depending
-       on  the  state of the tty driver when each character is typed, the pro-
+       on the state of the tty driver when each character is typed,  the  pro-
        gram may produce undesirable results.
 
        All functions except wget_wch and unget_wch may be macros.
@@ -122,14 +133,14 @@

RETURN VALUE

        When get_wch, wget_wch, mvget_wch, and mvwget_wch functions successful-
-       ly  report  the  pressing  of a function key, they return KEY_CODE_YES.
+       ly report the pressing of a function  key,  they  return  KEY_CODE_YES.
        When they successfully report a wide character, they return OK.  Other-
        wise, they return ERR.
 
        Upon successful completion, unget_wch returns OK.  Otherwise, the func-
        tion returns ERR.
 
-       Functions with a "mv" prefix first  perform  a  cursor  movement  using
+       Functions  with  a  "mv"  prefix  first perform a cursor movement using
        wmove, and return an error if the position is outside the window, or if
        the window pointer is null.
 
@@ -146,7 +157,12 @@