doc/html/man/curs_inch.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   5   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   6   *                                                                          *
   7   * Permission is hereby granted, free of charge, to any person obtaining a  *
   8   * copy of this software and associated documentation files (the            *
   9   * "Software"), to deal in the Software without restriction, including      *
  10   * without limitation the rights to use, copy, modify, merge, publish,      *
  11   * distribute, distribute with modifications, sublicense, and/or sell       *
  12   * copies of the Software, and to permit persons to whom the Software is    *
  13   * furnished to do so, subject to the following conditions:                 *
  14   *                                                                          *
  15   * The above copyright notice and this permission notice shall be included  *
  16   * in all copies or substantial portions of the Software.                   *
  17   *                                                                          *
  18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  25   *                                                                          *
  26   * Except as contained in this notice, the name(s) of the above copyright   *
  27   * holders shall not be used in advertising or otherwise to promote the     *
  28   * sale, use or other dealings in this Software without prior written       *
  29   * authorization.                                                           *
  30   ****************************************************************************
  31   * @Id: curs_inch.3x,v 1.54 2024/05/18 20:07:52 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>curs_inch 3x 2024-05-18 ncurses 6.5 Library calls</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">curs_inch 3x 2024-05-18 ncurses 6.5 Library calls</H1>
  44 <PRE>
  45 <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>                    Library calls                   <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>inch</STRONG>, <STRONG>winch</STRONG>, <STRONG>mvinch</STRONG>, <STRONG>mvwinch</STRONG> - get a <EM>curses</EM> character from a window
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  56
  57        <STRONG>chtype</STRONG> <STRONG>inch(void);</STRONG>
  58        <STRONG>chtype</STRONG> <STRONG>winch(WINDOW</STRONG> <STRONG>*</STRONG> <EM>win</EM><STRONG>);</STRONG>
  59        <STRONG>chtype</STRONG> <STRONG>mvinch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
  60        <STRONG>chtype</STRONG> <STRONG>mvwinch(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>
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64        <STRONG>winch</STRONG>  returns the <EM>curses</EM> character, including its attributes and color
  65        pair identifier, at the cursor position in the window <EM>win</EM>.   Subsection
  66        "Video  Attributes"  of  <STRONG><A HREF="curs_attr.3x.html">attron(3x)</A></STRONG>  explains how to extract these data
  67        from a <EM>chtype</EM>.  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> describes the variants of this function.
  68
  69
  70 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  71        These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
  72
  73        In <EM>ncurses</EM>, <STRONG>winch</STRONG> returns <STRONG>ERR</STRONG> if <EM>win</EM> is <STRONG>NULL</STRONG>.
  74
  75        Functions prefixed with "mv" first perform cursor movement and fail  if
  76        the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
  77
  78
  79 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  80        <STRONG>inch</STRONG>, <STRONG>mvinch</STRONG>, and <STRONG>mvwinch</STRONG> may be implemented as macros.
  81
  82        These  functions do not return an error if the window contains cells of
  83        <EM>curses</EM> complex characters; that is, if  they  contain  characters  with
  84        codes wider than eight bits (or greater than 255 as an unsigned decimal
  85        integer).  They instead extract only the low-order eight  bits  of  the
  86        character code from the cell.
  87
  88
  89 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  90        X/Open  Curses,  Issue  4  describes  these functions.  It specifies no
  91        error conditions for them.
  92
  93
  94 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
  95        The original <EM>curses</EM> in 4BSD (1980) defined <EM>winch</EM> as a  macro  accessing
  96        the  <EM>WINDOW</EM>  structure member representing character cell data, at that
  97        time a <EM>char</EM>, containing  only  a  7-bit  ASCII  character  code  and  a
  98        "standout" attribute bit, the only one the library supported.
  99
 100        SVr2  <EM>curses</EM> (1984) extended this approach, widening the character code
 101        to eight bits and permitting several attributes to be combined with  it
 102        by  storing  them  together  in  a  <EM>chtype</EM>, an alias of <EM>unsigned</EM> <EM>short</EM>.
 103        Because a macro was used, its value was not type-checked as a  function
 104        return  value  could have been.  Goodheart documented SVr3 (1987) <EM>winch</EM>
 105        as returning an  <EM>int</EM>.   SVr3.1's  (1987)  <EM>chtype</EM>  became  an  alias  of
 106        <EM>unsigned</EM>  <EM>long</EM>,  using  16 bits for the character code and widening the
 107        type in practical terms to 32 bits, as 64-bit Unix systems were not yet
 108        in wide use, and fixed-width integral types would not be standard until
 109        ISO C99.  SVr3.2 (1988) added a 6-bit color pair  identifier  alongside
 110        the attributes.
 111
 112        X/Open Curses does not specify the sizes of the character code or color
 113        pair identifier, nor the quantity of attribute bits, in  <EM>chtype</EM>;  these
 114        are   implementation-dependent.    <EM>ncurses</EM>  uses  eight  bits  for  the
 115        character code.  An application requiring a wider character  type,  for
 116        instance   to   represent   Unicode,   should  use  the  wide-character
 117        counterparts of these functions.
 118
 119
 120 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 121        <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG> describes comparable functions of the  <EM>ncurses</EM>  library
 122        in its wide-character configuration (<EM>ncursesw</EM>).
 123
 124        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
 125
 126
 127
 128 ncurses 6.5                       2024-05-18                     <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
 129 </PRE>
 130 <div class="nav">
 131 <ul>
 132 <li><a href="#h2-NAME">NAME</a></li>
 133 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 134 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 135 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 136 <li><a href="#h2-NOTES">NOTES</a></li>
 137 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 138 <li><a href="#h2-HISTORY">HISTORY</a></li>
 139 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 140 </ul>
 141 </div>
 142 </BODY>
 143 </HTML>