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.52 2024/05/11 20:39:53 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-11 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-11 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 rendering attributes and
  65        color pair identifier, at  the  cursor  position  in  the  window  <EM>win</EM>.
  66        Subsection  "Video  Attributes"  of  <STRONG><A HREF="curs_attr.3x.html">attron(3x)</A></STRONG> explains how to extract
  67        these data from a <EM>chtype</EM>.  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> describes the variants  of  this
  68        function.
  69
  70
  71 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  72        Functions  prefixed with "mv" first perform cursor movement and fail if
  73        the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
  74
  75        These functions do not return an error if the window comprises cells of
  76        <EM>curses</EM>  complex characters (that is, they contain characters with codes
  77        wider than eight bits, or greater  than  255  as  an  unsigned  decimal
  78        integer).   They  instead  extract  only  the  low-order  eight bits of
  79        character data in the cell.
  80
  81
  82 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
  83        <STRONG>inch</STRONG>, <STRONG>mvinch</STRONG>, and <STRONG>mvwinch</STRONG> may be implemented as macros.
  84
  85
  86 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  87        X/Open Curses, Issue 4 describes  these  functions.   It  specifies  no
  88        error conditions for them.
  89
  90
  91 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
  92        <STRONG>winch</STRONG>  was  implemented  in  the original 4BSD <EM>curses</EM> library (November
  93        1980).  It returned only the character code (as an  integer)  with  the
  94        "standout"  attribute bit (the only one it supported) cleared.  Because
  95        7-bit ASCII was the only character  encoding  supported,  4BSD's  <STRONG>winch</STRONG>
  96        returned a <EM>char</EM> type.
  97
  98        System V  <EM>curses</EM>  (1983)  permitted  several rendering attributes to be
  99        combined with a character in a window.   Reflecting  this  improvement,
 100        <STRONG>winch</STRONG>  returned  an <EM>int</EM> in SVr3.2 (1988) and switched to <EM>chtype</EM> in SVr4
 101        (1989).
 102
 103        X/Open Curses does not specify the sizes of the character code or color
 104        pair  identifier,  nor  the  quantity  of  rendering attribute bits, in
 105        <EM>chtype</EM>; these are implementation-dependent.  <EM>ncurses</EM>  uses  eight  bits
 106        for  the  character  code.   An application requiring a wider character
 107        type, for instance to handle Unicode,  should  use  the  wide-character
 108        counterparts of these functions.
 109
 110
 111 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 112        <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>  describes  comparable functions of the <EM>ncurses</EM> library
 113        in its wide-character configuration (<EM>ncursesw</EM>).
 114
 115        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
 116
 117
 118
 119 ncurses 6.5                       2024-05-11                     <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
 120 </PRE>
 121 <div class="nav">
 122 <ul>
 123 <li><a href="#h2-NAME">NAME</a></li>
 124 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 125 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 126 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 127 <li><a href="#h2-NOTES">NOTES</a></li>
 128 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 129 <li><a href="#h2-HISTORY">HISTORY</a></li>
 130 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 131 </ul>
 132 </div>
 133 </BODY>
 134 </HTML>