Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / curs_inch.3x.html
blob: ec1e2c77acbc84c10339e08ae5645b09058c077b [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 * t
3 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]4 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]30 * @Id: curs_inch.3x,v 1.17 2010/12/04 18:36:44 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]31-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]42<H1 class="no-header">curs_inch 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]50<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]51 <STRONG>inch</STRONG>, <STRONG>winch</STRONG>, <STRONG>mvinch</STRONG>, <STRONG>mvwinch</STRONG> - get a character and
52 attributes from a <STRONG>curses</STRONG> window
53
54
55</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]56<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]57 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59 <STRONG>chtype</STRONG> <STRONG>inch(void);</STRONG>
60 <STRONG>chtype</STRONG> <STRONG>winch(WINDOW</STRONG> <STRONG>*win);</STRONG>
61 <STRONG>chtype</STRONG> <STRONG>mvinch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
62 <STRONG>chtype</STRONG> <STRONG>mvwinch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
63
64
65</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]66<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]67 These routines return the character, of type <STRONG>chtype</STRONG>, at
68 the current position in the named window. If any
69 attributes are set for that position, their values are
70 OR'ed into the value returned. Constants defined in
71 <STRONG>&lt;curses.h&gt;</STRONG> can be used with the <STRONG>&amp;</STRONG> (logical AND) operator
72 to extract the character or attributes alone.
73
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]74
75</PRE>
76<H3><a name="h3-Attributes">Attributes</a></H3><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]77 The following bit-masks may be AND-ed with characters
78 returned by <STRONG>winch</STRONG>.
79
80 <STRONG>A_CHARTEXT</STRONG> Bit-mask to extract character
81 <STRONG>A_ATTRIBUTES</STRONG> Bit-mask to extract attributes
82 <STRONG>A_COLOR</STRONG> Bit-mask to extract color-pair field information
83
84
85</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]86<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
87 Functions with a "mv" prefix first perform a cursor move-
88 ment using <STRONG>wmove</STRONG>, and return an error if the position is
89 outside the window, or if the window pointer is null.
90
91
92</PRE>
93<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]94 Note that all of these routines may be macros.
95
96
97</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]98<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]99 These functions are described in the XSI Curses standard,
100 Issue 4.
101
102
103</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]104<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]105 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
106
107 Comparable functions in the wide-character (ncursesw)
108 library are described in <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>.
109
110
111
112 <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
113</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]114<div class="nav">
115<ul>
116<li><a href="#h2-NAME">NAME</a></li>
117<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
118<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
119<ul>
120<li><a href="#h3-Attributes">Attributes</a></li>
121</ul>
122</li>
123<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
124<li><a href="#h2-NOTES">NOTES</a></li>
125<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
126<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
127</ul>
128</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]129</BODY>
130</HTML>