ncurses 6.0 - patch 20150822
[ncurses.git] / man / curs_addch.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2014,2015 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: curs_addch.3x,v 1.36 2015/07/16 09:14:44 tom Exp $
31 .TH curs_addch 3X ""
32 .de bP
33 .IP \(bu 4
34 ..
35 .SH NAME
36 \fBaddch\fR,
37 \fBwaddch\fR,
38 \fBmvaddch\fR,
39 \fBmvwaddch\fR,
40 \fBechochar\fR,
41 \fBwechochar\fR \- add a character (with attributes) to a \fBcurses\fR window, then advance the cursor
42 .SH SYNOPSIS
43 \fB#include <curses.h>\fR
44 .PP
45 \fBint addch(const chtype ch);\fR
46 .br
47 \fBint waddch(WINDOW *win, const chtype ch);\fR
48 .br
49 \fBint mvaddch(int y, int x, const chtype ch);\fR
50 .br
51 \fBint mvwaddch(WINDOW *win, int y, int x, const chtype ch);\fR
52 .br
53 \fBint echochar(const chtype ch);\fR
54 .br
55 \fBint wechochar(WINDOW *win, const chtype ch);\fR
56 .br
57 .SH DESCRIPTION
58 .SS Adding characters
59 The \fBaddch\fR, \fBwaddch\fR, \fBmvaddch\fR and \fBmvwaddch\fR routines put
60 the character \fIch\fR into the given window at its current window position,
61 which is then advanced.  They are analogous to \fBputchar\fR in \fBstdio\fR(3).
62 If the advance is at the right margin:
63 .bP
64 The cursor automatically wraps to the beginning of the next line.
65 .bP
66 At the bottom of the current scrolling region,
67 and if \fBscrollok\fR is enabled,
68 the scrolling region is scrolled up one line.
69 .bP
70 If \fBscrollok\fR is not enabled,
71 writing a character at the lower right margin succeeds.
72 However, an error is returned because
73 it is not possible to wrap to a new line
74 .PP
75 If \fIch\fR is a tab, newline, carriage return or backspace,
76 the cursor is moved appropriately within the window:
77 .bP
78 Backspace moves the cursor one character left; at the left
79 edge of a window it does nothing.
80 .bP
81 Carriage return moves the cursor to the window left margin on the current line.
82 .bP
83 Newline does a \fBclrtoeol\fR,
84 then moves the cursor to the window left margin on the next line,
85 scrolling the window if on the last line.
86 .bP
87 Tabs are considered to be at every eighth column.
88 The tab interval may be altered by setting the \fBTABSIZE\fR variable.
89 .PP
90 If \fIch\fR is any other control character, it
91 is drawn in \fB^\fR\fIX\fR notation.  Calling \fBwinch\fR after adding a
92 control character does not return the character itself, but instead returns
93 the ^-representation of the control character.
94 .PP
95 Video attributes can be combined with a character argument passed to
96 \fBaddch\fR or related functions by logical-ORing them into the character.
97 (Thus, text, including attributes, can be copied from one place to another
98 using \fBinch\fR and \fBaddch\fR.)  See the \fBcurs_attr\fR(3X) page for
99 values of predefined video attribute constants that can be usefully OR'ed
100 into characters.
101 .SS Echoing characters
102 .PP
103 The \fBechochar\fR and \fBwechochar\fR routines are equivalent to a call to
104 \fBaddch\fR followed by a call to \fBrefresh\fR, or a call to \fBwaddch\fR
105 followed by a call to \fBwrefresh\fR.  The knowledge that only a single
106 character is being output is used and, for non-control characters, a
107 considerable performance gain may be seen by using these routines instead of
108 their equivalents.
109 .SS Line Graphics
110 The following variables may be used to add line drawing characters to the
111 screen with routines of the \fBaddch\fR family.  The default character listed
112 below is used if the \fBacsc\fR capability does not define a terminal-specific
113 replacement for it.
114 The names are taken from VT100 nomenclature.
115 .PP
116 .TS
117 l l l
118 _ _ _
119 l l l.
120 \fIName\fR      \fIDefault\fR   \fIDescription\fR
121 ACS_BLOCK       #       solid square block
122 ACS_BOARD       #       board of squares
123 ACS_BTEE        +       bottom tee
124 ACS_BULLET      o       bullet
125 ACS_CKBOARD     :       checker board (stipple)
126 ACS_DARROW      v       arrow pointing down
127 ACS_DEGREE      '       degree symbol
128 ACS_DIAMOND     +       diamond
129 ACS_GEQUAL      >       greater-than-or-equal-to
130 ACS_HLINE       \-      horizontal line
131 ACS_LANTERN     #       lantern symbol
132 ACS_LARROW      <       arrow pointing left
133 ACS_LEQUAL      <       less-than-or-equal-to
134 ACS_LLCORNER    +       lower left-hand corner
135 ACS_LRCORNER    +       lower right-hand corner
136 ACS_LTEE        +       left tee
137 ACS_NEQUAL      !       not-equal
138 ACS_PI  *       greek pi
139 ACS_PLMINUS     #       plus/minus
140 ACS_PLUS        +       plus
141 ACS_RARROW      >       arrow pointing right
142 ACS_RTEE        +       right tee
143 ACS_S1  \-      scan line 1
144 ACS_S3  \-      scan line 3
145 ACS_S7  \-      scan line 7
146 ACS_S9  \&_     scan line 9
147 ACS_STERLING    f       pound-sterling symbol
148 ACS_TTEE        +       top tee
149 ACS_UARROW      ^       arrow pointing up
150 ACS_ULCORNER    +       upper left-hand corner
151 ACS_URCORNER    +       upper right-hand corner
152 ACS_VLINE       |       vertical line
153 .TE
154 .SH RETURN VALUE
155 All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success
156 (the SVr4 manuals specify only "an integer value other than \fBERR\fR") upon
157 successful completion, unless otherwise noted in the preceding routine
158 descriptions.
159 .PP
160 Functions with a "mv" prefix first perform a cursor movement using
161 \fBwmove\fP, and return an error if the position is outside the window,
162 or if the window pointer is null.
163 .SH NOTES
164 Note that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and
165 \fBechochar\fR may be macros.
166 .SH PORTABILITY
167 All these functions are described in the XSI Curses standard, Issue 4.
168 The defaults specified for forms-drawing characters apply in the POSIX locale.
169 .LP
170 X/Open Curses states that the \fIACS_\fP definitions are \fBchar\fP constants.
171 For the wide-character implementation (see \fBcurs_add_wch\fP),
172 there are analogous \fIWACS_\fP definitions which are \fBcchar_t\fP constants.
173 .LP
174 Some ACS symbols
175 (ACS_S3,
176 ACS_S7,
177 ACS_LEQUAL,
178 ACS_GEQUAL,
179 ACS_PI,
180 ACS_NEQUAL,
181 ACS_STERLING)
182 were not documented in
183 any publicly released System V.  However, many publicly available terminfos
184 include \fBacsc\fR strings in which their key characters (pryz{|}) are
185 embedded, and a second-hand list of their character descriptions has come
186 to light.  The ACS-prefixed names for them were invented for \fBncurses\fR(3X).
187 .LP
188 The \fBTABSIZE\fR variable is implemented in some versions of curses,
189 but is not part of X/Open curses.
190 .LP
191 If \fIch\fR is a carriage return,
192 the cursor is moved to the beginning of the current row of the window.
193 This is true of other implementations, but is not documented.
194 .SH SEE ALSO
195 \fBcurses\fR(3X),
196 \fBcurs_attr\fR(3X),
197 \fBcurs_clear\fR(3X),
198 \fBcurs_inch\fR(3X),
199 \fBcurs_outopts\fR(3X),
200 \fBcurs_refresh\fR(3X),
201 \fBcurs_variables\fR(3X),
202 \fBputc\fR(3).
203 .PP
204 Comparable functions in the wide-character (ncursesw) library are
205 described in
206 \fBcurs_add_wch\fR(3X).