ncurses 6.0 - patch 20171028
[ncurses.git] / doc / html / man / curs_inch.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2010,2017 Free Software Foundation, Inc.              *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_inch.3x,v 1.19 2017/10/28 20:16:52 Sven.Joachim Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_inch 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_inch 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>                                                    <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>inch</STRONG>,  <STRONG>winch</STRONG>,  <STRONG>mvinch</STRONG>,  <STRONG>mvwinch</STRONG> - get a character and attributes from a
51        <STRONG>curses</STRONG> 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>*win);</STRONG>
59        <STRONG>chtype</STRONG> <STRONG>mvinch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
60        <STRONG>chtype</STRONG> <STRONG>mvwinch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        These routines return the character, of type  <STRONG>chtype</STRONG>,  at  the  current
65        position in the named window.  If any attributes are set for that posi-
66        tion, their values  are  OR'ed  into  the  value  returned.   Constants
67        defined  in <STRONG>&lt;curses.h&gt;</STRONG> can be used with the <STRONG>&amp;</STRONG> (logical AND) operator to
68        extract the character or attributes alone.
69
70
71 </PRE><H3><a name="h3-Attributes">Attributes</a></H3><PRE>
72        The following bit-masks may  be  AND-ed  with  characters  returned  by
73        <STRONG>winch</STRONG>.
74
75        <STRONG>A_CHARTEXT</STRONG>     Bit-mask to extract character
76        <STRONG>A_ATTRIBUTES</STRONG>   Bit-mask to extract attributes
77        <STRONG>A_COLOR</STRONG>        Bit-mask to extract color-pair field information
78
79
80 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
81        Functions  with  a  "mv"  prefix  first perform a cursor movement using
82        <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
83        the window pointer is null.
84
85        The  <STRONG>winch</STRONG>  function  does  not  return an error if the window contains
86        characters larger than 8-bits (255).  Only the low-order 8 bits of  the
87        character are used by <STRONG>winch</STRONG>.
88
89
90 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
91        Note that all of these routines may be macros.
92
93
94 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
95        These functions are described in the XSI Curses standard, Issue 4.
96
97        Very  old systems (before standardization) provide a different function
98        with the same name:
99
100        <STRONG>o</STRONG>   The <STRONG>winch</STRONG> function was part of the  original  BSD  curses  library,
101            which   stored   a  7-bit  character  combined  with  the  <EM>standout</EM>
102            attribute.
103
104            In BSD curses, <STRONG>winch</STRONG> returned only the character  (as  an  integer)
105            with the <EM>standout</EM> attribute removed.
106
107        <STRONG>o</STRONG>   System  V  curses  added support for several video attributes which
108            could be combined with characters in the window.
109
110            Reflecting this improvement, the function was altered to return the
111            character combined with all video attributes in a <STRONG>chtype</STRONG> value.
112
113        X/Open Curses does not specify the size and layout of attributes, color
114        and character values in <STRONG>chtype</STRONG>; it is  implementation-dependent.   This
115        implementation  uses 8 bits for character values.  An application using
116        more bits, e.g., a Unicode value, should use the wide-character equiva-
117        lents to these functions.
118
119
120 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
121        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
122             gives an overview of the WINDOW and <STRONG>chtype</STRONG> data types.
123
124        <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
125             goes  into more detail, pointing out portability problems and con-
126             straints on the use of <STRONG>chtype</STRONG> for returning window information.
127
128        <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
129             describes comparable functions for the  wide-character  (ncursesw)
130             library.
131
132
133
134                                                                  <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
135 </PRE>
136 <div class="nav">
137 <ul>
138 <li><a href="#h2-NAME">NAME</a></li>
139 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
140 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
141 <ul>
142 <li><a href="#h3-Attributes">Attributes</a></li>
143 </ul>
144 </li>
145 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
146 <li><a href="#h2-NOTES">NOTES</a></li>
147 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
148 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
149 </ul>
150 </div>
151 </BODY>
152 </HTML>