ncurses 5.3
[ncurses.git] / doc / html / man / curs_addch.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2000,2002 Free Software Foundation, Inc.              *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: curs_addch.3x,v 1.20 2002/08/10 22:12:36 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>curs_addch 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>curs_addch 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>addch</STRONG>,  <STRONG>waddch</STRONG>,  <STRONG>mvaddch</STRONG>,  <STRONG>mvwaddch</STRONG>, <STRONG>echochar</STRONG>, <STRONG>wechochar</STRONG> -
48        add a character (with attributes) to a <STRONG>curses</STRONG> window, then
49        advance the cursor
50
51
52 </PRE>
53 <H2>SYNOPSIS</H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>int</STRONG> <STRONG>addch(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
57        <STRONG>int</STRONG> <STRONG>waddch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
58        <STRONG>int</STRONG> <STRONG>mvaddch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
59        <STRONG>int</STRONG> <STRONG>mvwaddch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
60        <STRONG>int</STRONG> <STRONG>echochar(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
61        <STRONG>int</STRONG> <STRONG>wechochar(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
62
63
64 </PRE>
65 <H2>DESCRIPTION</H2><PRE>
66        The  <STRONG>addch</STRONG>,  <STRONG>waddch</STRONG>, <STRONG>mvaddch</STRONG> and <STRONG>mvwaddch</STRONG> routines put the
67        character <EM>ch</EM> into the given window at its  current  window
68        position,  which  is then advanced.  They are analogous to
69        <STRONG>putchar</STRONG> in <STRONG><A HREF="stdio.3.html">stdio(3)</A></STRONG>.  If the advance is at the right  mar-
70        gin,  the  cursor  automatically wraps to the beginning of
71        the next line.  At the bottom  of  the  current  scrolling
72        region,  if  <STRONG>scrollok</STRONG>  is enabled, the scrolling region is
73        scrolled up one line.
74
75        If <EM>ch</EM> is a tab, newline, or backspace, the cursor is moved
76        appropriately within the window.  Backspace moves the cur-
77        sor one character left; at the left edge of  a  window  it
78        does  nothing.   Newline  does  a <STRONG>clrtoeol</STRONG>, then moves the
79        cursor to  the  window  left  margin  on  the  next  line,
80        scrolling  the window if on the last line).  Tabs are con-
81        sidered to be at every eighth column.   The  tab  interval
82        may be altered by setting the <STRONG>TABSIZE</STRONG> variable.
83
84        If <EM>ch</EM> is any control character other than tab, newline, or
85        backspace, it is drawn  in  <STRONG>^</STRONG><EM>X</EM>  notation.   Calling  <STRONG>winch</STRONG>
86        after adding a control character does not return the char-
87        acter itself, but instead returns the ^-representation  of
88        the control character.
89
90        Video attributes can be combined with a character argument
91        passed to <STRONG>addch</STRONG> or related functions by logical-ORing them
92        into  the  character.   (Thus, text, including attributes,
93        can be copied from one place to  another  using  <STRONG>inch</STRONG>  and
94        <STRONG>addch</STRONG>.).   See the <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> page for values of prede-
95        fined video attribute constants that can be usefully OR'ed
96        into characters.
97
98        The  <STRONG>echochar</STRONG>  and  <STRONG>wechochar</STRONG> routines are equivalent to a
99        call to <STRONG>addch</STRONG> followed by a call to <STRONG>refresh</STRONG>, or a call  to
100        <STRONG>waddch</STRONG> followed by a call to <STRONG>wrefresh</STRONG>.  The knowledge that
101        only a single character is being output is used  and,  for
102        non-control  characters,  a  considerable performance gain
103        may be seen by  using  these  routines  instead  of  their
104        equivalents.
105
106    <STRONG>Line</STRONG> <STRONG>Graphics</STRONG>
107        The  following  variables  may be used to add line drawing
108        characters to the screen with routines of the  <STRONG>addch</STRONG>  fam-
109        ily.   The  default  character listed below is used if the
110        <STRONG>acsc</STRONG>  capability  doesn't   define   a   terminal-specific
111        replacement for it (but see the EXTENSIONS section below).
112        The names are taken from VT100 nomenclature.
113
114        <EM>Name</EM>           <EM>Default</EM>   <EM>Description</EM>
115        --------------------------------------------------
116        ACS_BLOCK      #         solid square block
117        ACS_BOARD      #         board of squares
118        ACS_BTEE       +         bottom tee
119        ACS_BULLET     o         bullet
120        ACS_CKBOARD    :         checker board (stipple)
121        ACS_DARROW     v         arrow pointing down
122        ACS_DEGREE     '         degree symbol
123        ACS_DIAMOND    +         diamond
124        ACS_GEQUAL     &gt;         greater-than-or-equal-to
125        ACS_HLINE      -         horizontal line
126        ACS_LANTERN    #         lantern symbol
127        ACS_LARROW     &lt;         arrow pointing left
128        ACS_LEQUAL     &lt;         less-than-or-equal-to
129        ACS_LLCORNER   +         lower left-hand corner
130        ACS_LRCORNER   +         lower right-hand corner
131        ACS_LTEE       +         left tee
132        ACS_NEQUAL     !         not-equal
133        ACS_PI         *         greek pi
134        ACS_PLMINUS    #         plus/minus
135        ACS_PLUS       +         plus
136        ACS_RARROW     &gt;         arrow pointing right
137        ACS_RTEE       +         right tee
138        ACS_S1         -         scan line 1
139        ACS_S3         -         scan line 3
140        ACS_S7         -         scan line 7
141        ACS_S9         _         scan line 9
142        ACS_STERLING   f         pound-sterling symbol
143        ACS_TTEE       +         top tee
144        ACS_UARROW     ^         arrow pointing up
145        ACS_ULCORNER   +         upper left-hand corner
146        ACS_URCORNER   +         upper right-hand corner
147        ACS_VLINE      |         vertical line
148
149
150
151 </PRE>
152 <H2>RETURN VALUE</H2><PRE>
153        All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
154        success  (the  SVr4 manuals specify only "an integer value
155        other than <STRONG>ERR</STRONG>") upon successful completion, unless other-
156        wise noted in the preceding routine descriptions.
157
158
159 </PRE>
160 <H2>NOTES</H2><PRE>
161        Note  that  <STRONG>addch</STRONG>,  <STRONG>mvaddch</STRONG>, <STRONG>mvwaddch</STRONG>, and <STRONG>echochar</STRONG> may be
162        macros.
163
164
165 </PRE>
166 <H2>PORTABILITY</H2><PRE>
167        All these functions are described in the XSI Curses  stan-
168        dard,  Issue  4.  The defaults specified for forms-drawing
169        characters apply in the POSIX locale.
170
171        Some ACS symbols (ACS_S3, ACS_S7, ACS_LEQUAL,  ACS_GEQUAL,
172        ACS_PI,  ACS_NEQUAL,  ACS_STERLING) were not documented in
173        any publicly released System V.   However,  many  publicly
174        available  terminfos  include  <STRONG>acsc</STRONG> strings in which their
175        key characters (pryz{|}) are embedded, and  a  second-hand
176        list  of  their  character descriptions has come to light.
177        The  ACS-prefixed  names  for  them  were   invented   for
178        <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>.
179
180        The  <STRONG>TABSIZE</STRONG>  variable  is implemented in some versions of
181        curses, but is not part of X/Open curses.
182
183
184 </PRE>
185 <H2>SEE ALSO</H2><PRE>
186        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>,  <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>,
187        <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="putc.3S.html">putc(3S)</A></STRONG>.
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220 </PRE>
221 <HR>
222 <ADDRESS>
223 Man(1) output converted with
224 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
225 </ADDRESS>
226 </BODY>
227 </HTML>