doc/html/man/curs_get_wch.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 2002-2010,2012 Free Software Foundation, Inc.              *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * @Id: curs_get_wch.3x,v 1.8 2012/11/03 23:03:59 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  36 <TITLE>curs_get_wch 3x</TITLE>
  37 <link rev=made href="mailto:bug-ncurses@gnu.org">
  38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  39 </HEAD>
  40 <BODY>
  41 <H1>curs_get_wch 3x</H1>
  42 <HR>
  43 <PRE>
  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>
  45
  46
  47
  48
  49 </PRE>
  50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>get_wch</STRONG>,  <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, <STRONG>mvwget_wch</STRONG>, <STRONG>unget_wch</STRONG> - get
  52        (or push back) a wide character from curses terminal  key-
  53        board
  54
  55
  56 </PRE>
  57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  58        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  59
  60        <STRONG>int</STRONG> <STRONG>get_wch(wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
  61        <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>
  62        <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>
  63        <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>
  64        <STRONG>int</STRONG> <STRONG>unget_wch(const</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG>
  65
  66
  67 </PRE>
  68 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        The <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions
  70        read a character from the  terminal  associated  with  the
  71        current  or  specified  window.   In  no-delay mode, if no
  72        input is waiting, the value <STRONG>ERR</STRONG>  is  returned.   In  delay
  73        mode,  the  program  waits  until  the  system passes text
  74        through to the  program.   Depending  on  the  setting  of
  75        <STRONG>cbreak</STRONG>,  this  is  after  one  character (cbreak mode), or
  76        after the first newline (nocbreak  mode).   In  half-delay
  77        mode,  the  program waits until the user types a character
  78        or the specified timeout interval has elapsed.
  79
  80        Unless <STRONG>noecho</STRONG> has been set, these routines echo the  char-
  81        acter into the designated window.
  82
  83        If  the window is not a pad and has been moved or modified
  84        since the last call to <STRONG>wrefresh</STRONG>, <STRONG>wrefresh</STRONG> will  be  called
  85        before another character is read.
  86
  87        If  <STRONG>keypad</STRONG>  is  enabled,  these  functions  respond to the
  88        pressing of a function key by setting the  object  pointed
  89        to  by  <EM>wch</EM>  to  the  corresponding  <STRONG>KEY_</STRONG> value defined in
  90        <STRONG>&lt;curses.h&gt;</STRONG> and returning  <STRONG>KEY_CODE_YES</STRONG>.   If  a  character
  91        (such as escape) that could be the beginning of a function
  92        key is received, curses sets a timer.  If the remainder of
  93        the  sequence  does  arrive  within  the  designated time,
  94        curses passes through  the  character;  otherwise,  curses
  95        returns  the  function  key  value.  For this reason, many
  96        terminals experience a  delay  between  the  time  a  user
  97        presses the escape key and the time the escape is returned
  98        to the program.
  99
 100        The <STRONG>unget_wch</STRONG> function pushes the wide character <EM>wch</EM>  back
 101        onto the head of the input queue, so the wide character is
 102        returned by the next call to <STRONG>get_wch</STRONG>.  The pushback of one
 103        character  is  guaranteed.  If the program calls <STRONG>unget_wch</STRONG>
 104        too many times without an intervening call to <STRONG>get_wch</STRONG>, the
 105        operation may fail.
 106
 107
 108 </PRE>
 109 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 110        The  header  file  <STRONG>&lt;curses.h&gt;</STRONG>  automatically  includes the
 111        header file <STRONG>&lt;stdio.h&gt;</STRONG>.
 112
 113        Applications should not define the escape key by itself as
 114        a single-character function.
 115
 116        When  using  <STRONG>get_wch</STRONG>,  <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, or <STRONG>mvwget_wch</STRONG>,
 117        applications should not use <STRONG>nocbreak</STRONG> mode and <STRONG>echo</STRONG> mode at
 118        the  same  time.  Depending on the state of the tty driver
 119        when each character is  typed,  the  program  may  produce
 120        undesirable results.
 121
 122        All functions except <STRONG>wget_wch</STRONG> and <STRONG>unget_wch</STRONG> may be macros.
 123
 124
 125 </PRE>
 126 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 127        When  <STRONG>get_wch</STRONG>,  <STRONG>wget_wch</STRONG>,  <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> func-
 128        tions successfully report the pressing of a function  key,
 129        they return <STRONG>KEY_CODE_YES</STRONG>.  When they successfully report a
 130        wide character, they return <STRONG>OK</STRONG>.   Otherwise,  they  return
 131        <STRONG>ERR</STRONG>.
 132
 133        Upon  successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>.  Other-
 134        wise, the function returns <STRONG>ERR</STRONG>.
 135
 136        Functions with a "mv" prefix first perform a cursor  move-
 137        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
 138        outside the window, or if the window pointer is null.
 139
 140
 141 </PRE>
 142 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 143        <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>,
 144        <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>
 145
 146
 147
 148                                                        <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
 149 </PRE>
 150 <div class="nav">
 151 <ul>
 152 <li><a href="#h2-NAME">NAME</a></li>
 153 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 154 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 155 <li><a href="#h2-NOTES">NOTES</a></li>
 156 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 157 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 158 </ul>
 159 </div>
 160 </BODY>
 161 </HTML>