ncurses 6.0 - patch 20160326
[ncurses.git] / doc / html / man / curs_addch.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2014,2015 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   * @Id: curs_addch.3x,v 1.37 2015/09/05 21:13:25 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_addch 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_addch 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>                                           <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>addch</STRONG>,  <STRONG>waddch</STRONG>,  <STRONG>mvaddch</STRONG>,  <STRONG>mvwaddch</STRONG>, <STRONG>echochar</STRONG>, <STRONG>wechochar</STRONG> -
51        add a character (with attributes) to a <STRONG>curses</STRONG> window, then
52        advance the cursor
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>addch(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
59        <STRONG>int</STRONG> <STRONG>waddch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
60        <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>
61        <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>
62        <STRONG>int</STRONG> <STRONG>echochar(const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
63        <STRONG>int</STRONG> <STRONG>wechochar(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
64
65
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67
68 </PRE><H3><a name="h3-Adding-characters">Adding characters</a></H3><PRE>
69        The  <STRONG>addch</STRONG>,  <STRONG>waddch</STRONG>, <STRONG>mvaddch</STRONG> and <STRONG>mvwaddch</STRONG> routines put the
70        character <EM>ch</EM> into the given window at its  current  window
71        position,  which  is then advanced.  They are analogous to
72        <STRONG>putchar</STRONG> in <STRONG>stdio(3)</STRONG>.  If the advance is at the right  mar-
73        gin:
74
75        <STRONG>o</STRONG>   The cursor automatically wraps to the beginning of the
76            next line.
77
78        <STRONG>o</STRONG>   At the bottom of the current scrolling region, and  if
79            <STRONG>scrollok</STRONG>  is enabled, the scrolling region is scrolled
80            up one line.
81
82        <STRONG>o</STRONG>   If <STRONG>scrollok</STRONG> is not enabled, writing a character at the
83            lower  right  margin  succeeds.   However, an error is
84            returned because it is not possible to wrap to  a  new
85            line
86
87        If <EM>ch</EM> is a tab, newline, carriage return or backspace, the
88        cursor is moved appropriately within the window:
89
90        <STRONG>o</STRONG>   Backspace moves the cursor one character left; at  the
91            left edge of a window it does nothing.
92
93        <STRONG>o</STRONG>   Carriage  return  moves  the cursor to the window left
94            margin on the current line.
95
96        <STRONG>o</STRONG>   Newline does a <STRONG>clrtoeol</STRONG>, then moves the cursor to  the
97            window  left  margin  on  the next line, scrolling the
98            window if on the last line.
99
100        <STRONG>o</STRONG>   Tabs are considered to be at every eighth column.  The
101            tab  interval  may  be  altered by setting the <STRONG>TABSIZE</STRONG>
102            variable.
103
104        If <EM>ch</EM> is any other control character, it is  drawn  in  <STRONG>^</STRONG><EM>X</EM>
105        notation.   Calling <STRONG>winch</STRONG> after adding a control character
106        does not return the character itself, but instead  returns
107        the ^-representation of the control character.
108
109        Video attributes can be combined with a character argument
110        passed to <STRONG>addch</STRONG> or related functions by logical-ORing them
111        into  the  character.   (Thus, text, including attributes,
112        can be copied from one place to  another  using  <STRONG>inch</STRONG>  and
113        <STRONG>addch</STRONG>.)   See  the <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> page for values of prede-
114        fined video attribute constants that can be usefully OR'ed
115        into characters.
116
117
118 </PRE><H3><a name="h3-Echoing-characters">Echoing characters</a></H3><PRE>
119        The  <STRONG>echochar</STRONG>  and  <STRONG>wechochar</STRONG> routines are equivalent to a
120        call to <STRONG>addch</STRONG> followed by a call to <STRONG>refresh</STRONG>, or a call  to
121        <STRONG>waddch</STRONG> followed by a call to <STRONG>wrefresh</STRONG>.  The knowledge that
122        only a single character is being output is used  and,  for
123        non-control  characters,  a  considerable performance gain
124        may be seen by  using  these  routines  instead  of  their
125        equivalents.
126
127
128 </PRE><H3><a name="h3-Line-Graphics">Line Graphics</a></H3><PRE>
129        The  following  variables  may be used to add line drawing
130        characters to the screen with routines of the  <STRONG>addch</STRONG>  fam-
131        ily.   The  default  character listed below is used if the
132        <STRONG>acsc</STRONG>  capability  does  not  define  a   terminal-specific
133        replacement for it, or if the terminal and locale configu-
134        ration requires Unicode but the library is unable  to  use
135        Unicode.
136
137        The names are taken from VT100 nomenclature.
138
139        <EM>Name</EM>           <EM>Default</EM>   <EM>Description</EM>
140        --------------------------------------------------
141        ACS_BLOCK      #         solid square block
142        ACS_BOARD      #         board of squares
143        ACS_BTEE       +         bottom tee
144        ACS_BULLET     o         bullet
145        ACS_CKBOARD    :         checker board (stipple)
146        ACS_DARROW     v         arrow pointing down
147        ACS_DEGREE     '         degree symbol
148        ACS_DIAMOND    +         diamond
149        ACS_GEQUAL     &gt;         greater-than-or-equal-to
150        ACS_HLINE      -         horizontal line
151        ACS_LANTERN    #         lantern symbol
152        ACS_LARROW     &lt;         arrow pointing left
153        ACS_LEQUAL     &lt;         less-than-or-equal-to
154        ACS_LLCORNER   +         lower left-hand corner
155        ACS_LRCORNER   +         lower right-hand corner
156        ACS_LTEE       +         left tee
157        ACS_NEQUAL     !         not-equal
158        ACS_PI         *         greek pi
159        ACS_PLMINUS    #         plus/minus
160        ACS_PLUS       +         plus
161        ACS_RARROW     &gt;         arrow pointing right
162        ACS_RTEE       +         right tee
163        ACS_S1         -         scan line 1
164        ACS_S3         -         scan line 3
165        ACS_S7         -         scan line 7
166        ACS_S9         _         scan line 9
167        ACS_STERLING   f         pound-sterling symbol
168        ACS_TTEE       +         top tee
169        ACS_UARROW     ^         arrow pointing up
170        ACS_ULCORNER   +         upper left-hand corner
171        ACS_URCORNER   +         upper right-hand corner
172        ACS_VLINE      |         vertical line
173
174
175 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
176        All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
177        success (the SVr4 manuals specify only "an  integer  value
178        other than <STRONG>ERR</STRONG>") upon successful completion, unless other-
179        wise noted in the preceding routine descriptions.
180
181        Functions with a "mv" prefix first perform a cursor  move-
182        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
183        outside the window, or if the window pointer is null.
184
185
186 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
187        Note that <STRONG>addch</STRONG>, <STRONG>mvaddch</STRONG>, <STRONG>mvwaddch</STRONG>, and  <STRONG>echochar</STRONG>  may  be
188        macros.
189
190
191 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
192        All  these functions are described in the XSI Curses stan-
193        dard, Issue 4.  The defaults specified  for  forms-drawing
194        characters apply in the POSIX locale.
195
196        X/Open  Curses  states  that the <EM>ACS</EM><STRONG>_</STRONG> definitions are <STRONG>char</STRONG>
197        constants.  For  the  wide-character  implementation  (see
198        <STRONG>curs_add_wch</STRONG>), there are analogous <EM>WACS</EM><STRONG>_</STRONG> definitions which
199        are <STRONG>cchar_t</STRONG> constants.
200
201        Some ACS symbols (ACS_S3, ACS_S7, ACS_LEQUAL,  ACS_GEQUAL,
202        ACS_PI,  ACS_NEQUAL,  ACS_STERLING) were not documented in
203        any publicly released System V.   However,  many  publicly
204        available  terminfos  include  <STRONG>acsc</STRONG> strings in which their
205        key characters (pryz{|}) are embedded, and  a  second-hand
206        list  of  their  character descriptions has come to light.
207        The  ACS-prefixed  names  for  them  were   invented   for
208        <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>.
209
210        The  <EM>displayed</EM>  values  for  the  <EM>ACS</EM><STRONG>_</STRONG> and <EM>WACS</EM><STRONG>_</STRONG> constants
211        depend on
212
213        <STRONG>o</STRONG>   the library configuration, i.e., <STRONG>ncurses</STRONG> versus <STRONG>ncurs-</STRONG>
214            <STRONG>esw</STRONG>, where the latter is capable of displaying Unicode
215            while the former is not, and
216
217        <STRONG>o</STRONG>   whether the <EM>locale</EM> uses UTF-8 encoding.
218
219        In certain cases, the terminal is unable to display  line-
220        drawing  characters except by using UTF-8 (see the discus-
221        sion of <STRONG>NCURSES_NO_UTF8_ACS</STRONG> in <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>).
222
223        The <STRONG>TABSIZE</STRONG> variable is implemented in  some  versions  of
224        curses, but is not part of X/Open curses.
225
226        If  <EM>ch</EM>  is  a  carriage return, the cursor is moved to the
227        beginning of the current row of the window.  This is  true
228        of other implementations, but is not documented.
229
230
231 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
232        <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>,
233        <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="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,
234        <STRONG>putc(3)</STRONG>.
235
236        Comparable  functions  in  the  wide-character  (ncursesw)
237        library are described in <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>.
238
239
240
241                                                          <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
242 </PRE>
243 <div class="nav">
244 <ul>
245 <li><a href="#h2-NAME">NAME</a></li>
246 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
247 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
248 <ul>
249 <li><a href="#h3-Adding-characters">Adding characters</a></li>
250 <li><a href="#h3-Echoing-characters">Echoing characters</a></li>
251 <li><a href="#h3-Line-Graphics">Line Graphics</a></li>
252 </ul>
253 </li>
254 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
255 <li><a href="#h2-NOTES">NOTES</a></li>
256 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
257 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
258 </ul>
259 </div>
260 </BODY>
261 </HTML>