]> ncurses.scripts.mit.edu Git - ncurses.git/blob - man/curs_inch.3x
ncurses 6.4 - patch 20240323
[ncurses.git] / man / curs_inch.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
4 .\" Copyright 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 .\"
31 .\" $Id: curs_inch.3x,v 1.46 2024/03/16 15:35:01 tom Exp $
32 .TH curs_inch 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
33 .ie \n(.g \{\
34 .ds `` \(lq
35 .ds '' \(rq
36 .\}
37 .el \{\
38 .ie t .ds `` ``
39 .el   .ds `` ""
40 .ie t .ds '' ''
41 .el   .ds '' ""
42 .\}
43 .
44 .de bP
45 .ie n  .IP \(bu 4
46 .el    .IP \(bu 2
47 ..
48 .SH NAME
49 \fB\%inch\fP,
50 \fB\%winch\fP,
51 \fB\%mvinch\fP,
52 \fB\%mvwinch\fP \-
53 get a \fIcurses\fR character from a window
54 .SH SYNOPSIS
55 .nf
56 \fB#include <curses.h>
57 .PP
58 \fBchtype inch(void);
59 \fBchtype winch(WINDOW *\fIwin\fP);
60 .PP
61 \fBchtype mvinch(int \fIy\fP, int \fIx\fP);
62 \fBchtype mvwinch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP);
63 .fi
64 .SH DESCRIPTION
65 These routines return the character, of type \fBchtype\fP, at the current
66 position in the named window.
67 If any attributes are set for that position,
68 their values are OR'ed into the value returned.
69 Constants defined in
70 \fB<curses.h>\fP can be used with the \fB&\fP (logical AND) operator to
71 extract the character or attributes alone.
72 .
73 .SS Attributes
74 The following bit masks may be AND-ed with characters returned by \fBwinch\fP.
75 .PP
76 .TS
77 Lb Lb
78 Lb Lx.
79 Name    Description
80 _
81 A_CHARTEXT      Extract character
82 A_ATTRIBUTES    Extract attributes
83 A_COLOR Extract color pair information
84 .TE
85 .SH RETURN VALUE
86 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
87 \fBwmove\fP, and return an error if the position is outside the window,
88 or if the window pointer is null.
89 .PP
90 The \fBwinch\fP function does not return an error if the window contains
91 characters larger than 8-bits (255).
92 Only the low-order 8 bits of the character are used by \fBwinch\fP.
93 .SH NOTES
94 Note that all of these routines may be macros.
95 .SH PORTABILITY
96 These functions are described in the XSI Curses standard, Issue 4.
97 .PP
98 Very old systems (before standardization) provide a different function
99 with the same name:
100 .bP
101 The \fBwinch\fP function was part of the original BSD curses library,
102 which stored a 7-bit character combined with the \fIstandout\fP attribute.
103 .IP
104 In BSD curses, \fBwinch\fP returned only the character (as an integer)
105 with the \fIstandout\fP attribute removed.
106 .bP
107 System V curses added support for several video attributes which
108 could be combined with characters in the window.
109 .IP
110 Reflecting this improvement, the function was altered to return the
111 character combined with all video attributes in a \fBchtype\fP value.
112 .PP
113 X/Open Curses does not specify
114 the size and layout of attributes, color and character values in
115 \fBchtype\fP; it is implementation-dependent.
116 This implementation uses 8 bits for character values.
117 An application using more bits, e.g., a Unicode value,
118 should use the wide-character equivalents to these functions.
119 .SH SEE ALSO
120 .TP
121 \fB\%curses\fP(3X)
122 gives an overview of the \fB\%WINDOW\fP and \fB\%chtype\fP data types.
123 .TP
124 \fB\%curs_attr\fP(3X)
125 goes into more detail, pointing out portability problems and
126 constraints on the use of \fB\%chtype\fP for returning window
127 information.
128 .TP
129 \fB\%curs_in_wch\fP(3X)
130 describes comparable functions for the wide-character (ncursesw)
131 library.