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