3 ****************************************************************************
4 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_inch.3x,v 1.17 2010/12/04 18:36:44 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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">
42 <H1 class="no-header">curs_inch 3x</H1>
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>
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
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
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>
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><curses.h></STRONG> can be used with the <STRONG>&</STRONG> (logical AND) operator to
68 extract the character or attributes alone.
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>.
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
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.
86 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
87 Note that all of these routines may be macros.
90 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
91 These functions are described in the XSI Curses standard, Issue 4.
94 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
95 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
97 Comparable functions in the wide-character (ncursesw) library are
98 described in <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>.
102 <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
106 <li><a href="#h2-NAME">NAME</a></li>
107 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
108 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
110 <li><a href="#h3-Attributes">Attributes</a></li>
113 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
114 <li><a href="#h2-NOTES">NOTES</a></li>
115 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
116 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>