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