ncurses 4.2
[ncurses.git] / man / curs_inch.3x
1 '\" t
2 .\" $Id: curs_inch.3x,v 1.8 1997/12/13 22:36:42 tom Exp $
3 .TH curs_inch 3X ""
4 .SH NAME
5 \fBinch\fR, \fBwinch\fR, \fBmvinch\fR, \fBmvwinch\fR
6 - get a character and attributes from a \fBcurses\fR window
7 .SH SYNOPSIS
8 \fB#include <curses.h>\fR
9
10 \fBchtype inch(void);\fR
11 .br
12 \fBchtype winch(WINDOW *win);\fR
13 .br
14 \fBchtype mvinch(int y, int x);\fR
15 .br
16 \fBchtype mvwinch(WINDOW *win, int y, int x);\fR
17 .br
18 .SH DESCRIPTION
19 These routines return the character, of type \fBchtype\fR, at the current
20 position in the named window.  If any attributes are set for that position,
21 their values are OR'ed into the value returned.  Constants defined in
22 \fB<curses.h>\fR can be used with the \fB&\fR (logical AND) operator to
23 extract the character or attributes alone.
24
25 .SS Attributes
26 The following bit-masks may be AND-ed with characters returned by \fBwinch\fR.
27
28 .TS
29 l l .
30 \fBA_CHARTEXT\fR        Bit-mask to extract character
31 \fBA_ATTRIBUTES\fR      Bit-mask to extract attributes
32 \fBA_COLOR\fR   Bit-mask to extract color-pair field information
33 .TE
34 .SH NOTES
35 Note that all of these routines may be macros.
36 .SH PORTABILITY
37 These functions are described in the XSI Curses standard, Issue 4.
38 .SH SEE ALSO
39 \fBcurses\fR(3X).
40 .\"#
41 .\"# The following sets edit modes for GNU EMACS
42 .\"# Local Variables:
43 .\"# mode:nroff
44 .\"# fill-column:79
45 .\"# End: