PageRenderTime 63ms CodeModel.GetById 30ms RepoModel.GetById 0ms app.codeStats 0ms

/release/src/router/libncurses/doc/html/man/curs_get_wch.3x.html

https://gitlab.com/envieidoc/tomato
HTML | 155 lines | 97 code | 27 blank | 31 comment | 0 complexity | b448334bf7c6cc0d69f008d5b5f80cda MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
    2. 

  2. <!-- 
    3. 

  3.   ****************************************************************************
    4. 

  4.   * Copyright (c) 2002-2006,2010 Free Software Foundation, Inc.              *
    5. 

  5.   *                                                                          *
    6. 

  6.   * Permission is hereby granted, free of charge, to any person obtaining a  *
    7. 

  7.   * copy of this software and associated documentation files (the            *
    8. 

  8.   * "Software"), to deal in the Software without restriction, including      *
    9. 

  9.   * without limitation the rights to use, copy, modify, merge, publish,      *
    10. 

  10.   * distribute, distribute with modifications, sublicense, and/or sell       *
    11. 

  11.   * copies of the Software, and to permit persons to whom the Software is    *
    12. 

  12.   * furnished to do so, subject to the following conditions:                 *
    13. 

  13.   *                                                                          *
    14. 

  14.   * The above copyright notice and this permission notice shall be included  *
    15. 

  15.   * in all copies or substantial portions of the Software.                   *
    16. 

  16.   *                                                                          *
    17. 

  17.   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
    18. 

  18.   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
    19. 

  19.   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
    20. 

  20.   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
    21. 

  21.   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
    22. 

  22.   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
    23. 

  23.   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
    24. 

  24.   *                                                                          *
    25. 

  25.   * Except as contained in this notice, the name(s) of the above copyright   *
    26. 

  26.   * holders shall not be used in advertising or otherwise to promote the     *
    27. 

  27.   * sale, use or other dealings in this Software without prior written       *
    28. 

  28.   * authorization.                                                           *
    29. 

  29.   ****************************************************************************
    30. 

  30.   * @Id: curs_get_wch.3x,v 1.7 2010/08/14 23:31:42 tom Exp @
    31. 

  31. -->
    32. 

  32. <HTML>
    33. 

  33. <HEAD>
    34. 

  34. <TITLE>curs_get_wch 3x</TITLE>
    35. 

  35. <link rev=made href="mailto:bug-ncurses@gnu.org">
    36. 

  36. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    37. 

  37. </HEAD>
    38. 

  38. <BODY>
    39. 

  39. <H1>curs_get_wch 3x</H1>
    40. 

  40. <HR>
    41. 

  41. <PRE>
    42. 

  42. <!-- Manpage converted by man2html 3.0.1 -->
    43. 

  43. <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>
    44. 

  44. 

  45. 

  46. 

  47. 

  48. </PRE>
    49. 

  49. <H2>NAME</H2><PRE>
    50. 

  50.        <STRONG>get_wch</STRONG>,  <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, <STRONG>mvwget_wch</STRONG>, <STRONG>unget_wch</STRONG> - get
    51. 

  51.        (or push back) a wide character from curses terminal  key-
    52. 

  52.        board
    53. 

  53. 

  54. 

  55. </PRE>
    56. 

  56. <H2>SYNOPSIS</H2><PRE>
    57. 

  57.        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
    58. 

  58. 

  59.        <STRONG>int</STRONG> <STRONG>get_wch(wint_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
    60. 

  60.        <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>
    61. 

  61.        <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>
    62. 

  62.        <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>
    63. 

  63.        <STRONG>int</STRONG> <STRONG>unget_wch(const</STRONG> <STRONG>wchar_t</STRONG> <EM>wch</EM><STRONG>);</STRONG>
    64. 

  64. 

  65. 

  66. </PRE>
    67. 

  67. <H2>DESCRIPTION</H2><PRE>
    68. 

  68.        The <STRONG>get_wch</STRONG>, <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> functions
    69. 

  69.        read a character from the  terminal  associated  with  the
    70. 

  70.        current  or  specified  window.   In  no-delay mode, if no
    71. 

  71.        input is waiting, the value <STRONG>ERR</STRONG>  is  returned.   In  delay
    72. 

  72.        mode,  the  program  waits  until  the  system passes text
    73. 

  73.        through to the  program.   Depending  on  the  setting  of
    74. 

  74.        <STRONG>cbreak</STRONG>,  this  is  after  one  character (cbreak mode), or
    75. 

  75.        after the first newline (nocbreak  mode).   In  half-delay
    76. 

  76.        mode,  the  program waits until the user types a character
    77. 

  77.        or the specified timeout interval has elapsed.
    78. 

  78. 

  79.        Unless <STRONG>noecho</STRONG> has been set, these routines echo the  char-
    80. 

  80.        acter into the designated window.
    81. 

  81. 

  82.        If  the window is not a pad and has been moved or modified
    83. 

  83.        since the last call to <STRONG>wrefresh</STRONG>, <STRONG>wrefresh</STRONG> will  be  called
    84. 

  84.        before another character is read.
    85. 

  85. 

  86.        If  <STRONG>keypad</STRONG>  is  enabled,  these  functions  respond to the
    87. 

  87.        pressing of a function key by setting the  object  pointed
    88. 

  88.        to  by  <EM>wch</EM>  to  the  corresponding  <STRONG>KEY_</STRONG> value defined in
    89. 

  89.        <STRONG>&lt;curses.h&gt;</STRONG> and returning  <STRONG>KEY_CODE_YES</STRONG>.   If  a  character
    90. 

  90.        (such as escape) that could be the beginning of a function
    91. 

  91.        key is received, curses sets a timer.  If the remainder of
    92. 

  92.        the  sequence  does  arrive  within  the  designated time,
    93. 

  93.        curses passes through  the  character;  otherwise,  curses
    94. 

  94.        returns  the  function  key  value.  For this reason, many
    95. 

  95.        terminals experience a  delay  between  the  time  a  user
    96. 

  96.        presses the escape key and the time the escape is returned
    97. 

  97.        to the program.
    98. 

  98. 

  99.        The <STRONG>unget_wch</STRONG> function pushes the wide character <EM>wch</EM>  back
    100. 

  100.        onto the head of the input queue, so the wide character is
    101. 

  101.        returned by the next call to <STRONG>get_wch</STRONG>.  The pushback of one
    102. 

  102.        character  is  guaranteed.  If the program calls <STRONG>unget_wch</STRONG>
    103. 

  103.        too many times without an intervening call to <STRONG>get_wch</STRONG>, the
    104. 

  104.        operation may fail.
    105. 

  105. 

  106. 

  107. </PRE>
    108. 

  108. <H2>NOTES</H2><PRE>
    109. 

  109.        The  header  file  <STRONG>&lt;curses.h&gt;</STRONG>  automatically  includes the
    110. 

  110.        header file <STRONG>&lt;stdio.h&gt;</STRONG>.
    111. 

  111. 

  112.        Applications should not define the escape key by itself as
    113. 

  113.        a single-character function.
    114. 

  114. 

  115.        When  using  <STRONG>get_wch</STRONG>,  <STRONG>wget_wch</STRONG>, <STRONG>mvget_wch</STRONG>, or <STRONG>mvwget_wch</STRONG>,
    116. 

  116.        applications should not use <STRONG>nocbreak</STRONG> mode and <STRONG>echo</STRONG> mode at
    117. 

  117.        the  same  time.  Depending on the state of the tty driver
    118. 

  118.        when each character is  typed,  the  program  may  produce
    119. 

  119.        undesirable results.
    120. 

  120. 

  121.        All functions except <STRONG>wget_wch</STRONG> and <STRONG>unget_wch</STRONG> may be macros.
    122. 

  122. 

  123. 

  124. </PRE>
    125. 

  125. <H2>RETURN VALUES</H2><PRE>
    126. 

  126.        When  <STRONG>get_wch</STRONG>,  <STRONG>wget_wch</STRONG>,  <STRONG>mvget_wch</STRONG>, and <STRONG>mvwget_wch</STRONG> func-
    127. 

  127.        tions successfully report the pressing of a function  key,
    128. 

  128.        they return <STRONG>KEY_CODE_YES</STRONG>.  When they successfully report a
    129. 

  129.        wide character, they return <STRONG>OK</STRONG>.   Otherwise,  they  return
    130. 

  130.        <STRONG>ERR</STRONG>.
    131. 

  131. 

  132.        Upon  successful completion, <STRONG>unget_wch</STRONG> returns <STRONG>OK</STRONG>.  Other-
    133. 

  133.        wise, the function returns <STRONG>ERR</STRONG>.
    134. 

  134. 

  135.        Functions with a "mv" prefix first perform a cursor  move-
    136. 

  136.        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
    137. 

  137.        outside the window, or if the window pointer is null.
    138. 

  138. 

  139. 

  140. </PRE>
    141. 

  141. <H2>SEE ALSO</H2><PRE>
    142. 

  142.        <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>,
    143. 

  143.        <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>
    144. 

  144. 

  145. 

  146. 

  147.                                                        <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
    148. 

  148. </PRE>
    149. 

  149. <HR>
    150. 

  150. <ADDRESS>
    151. 

  151. Man(1) output converted with
    152. 

  152. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
    153. 

  153. </ADDRESS>
    154. 

  154. </BODY>
    155. 

  155. </HTML>
    156. 

  156.