ncurses 6.0 - patch 20150606
[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.35 2015/05/13 19:18:37 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        The  <STRONG>addch</STRONG>,  <STRONG>waddch</STRONG>, <STRONG>mvaddch</STRONG> and <STRONG>mvwaddch</STRONG> routines put the
71        character <EM>ch</EM> into the given window at its  current  window
72        position,  which  is then advanced.  They are analogous to
73        <STRONG>putchar</STRONG> in <STRONG>stdio(3)</STRONG>.  If the advance is at the right  mar-
74        gin:
75
76        <STRONG>o</STRONG>   The cursor automatically wraps to the beginning of the
77            next line.
78
79        <STRONG>o</STRONG>   At the bottom of the current scrolling region, and  if
80            <STRONG>scrollok</STRONG>  is enabled, the scrolling region is scrolled
81            up one line.
82
83        <STRONG>o</STRONG>   If <STRONG>scrollok</STRONG> is not enabled, writing a character at the
84            lower  right  margin  succeeds.   However, an error is
85            returned because it is not possible to wrap to  a  new
86            line
87
88        If <EM>ch</EM> is a tab, newline, carriage return or backspace, the
89        cursor is moved appropriately within the window:
90
91        <STRONG>o</STRONG>   Backspace moves the cursor one character left; at  the
92            left edge of a window it does nothing.
93
94        <STRONG>o</STRONG>   Carriage  return  moves  the cursor to the window left
95            margin on the current line.
96
97        <STRONG>o</STRONG>   Newline does a <STRONG>clrtoeol</STRONG>, then moves the cursor to  the
98            window  left  margin  on  the next line, scrolling the
99            window if on the last line.
100
101        <STRONG>o</STRONG>   Tabs are considered to be at every eighth column.  The
102            tab  interval  may  be  altered by setting the <STRONG>TABSIZE</STRONG>
103            variable.
104
105        If <EM>ch</EM> is any other control character, it is  drawn  in  <STRONG>^</STRONG><EM>X</EM>
106        notation.   Calling <STRONG>winch</STRONG> after adding a control character
107        does not return the character itself, but instead  returns
108        the ^-representation of the control character.
109
110        Video attributes can be combined with a character argument
111        passed to <STRONG>addch</STRONG> or related functions by logical-ORing them
112        into  the  character.   (Thus, text, including attributes,
113        can be copied from one place to  another  using  <STRONG>inch</STRONG>  and
114        <STRONG>addch</STRONG>.)   See  the <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG> page for values of prede-
115        fined video attribute constants that can be usefully OR'ed
116        into characters.
117
118        The  <STRONG>echochar</STRONG>  and  <STRONG>wechochar</STRONG> routines are equivalent to a
119        call to <STRONG>addch</STRONG> followed by a call to <STRONG>refresh</STRONG>, or a call  to
120        <STRONG>waddch</STRONG> followed by a call to <STRONG>wrefresh</STRONG>.  The knowledge that
121        only a single character is being output is used  and,  for
122        non-control  characters,  a  considerable performance gain
123        may be seen by  using  these  routines  instead  of  their
124        equivalents.
125
126
127 </PRE>
128 <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.  The names are taken from VT100 nomen-
134        clature.
135
136        <EM>Name</EM>           <EM>Default</EM>   <EM>Description</EM>
137        --------------------------------------------------
138        ACS_BLOCK      #         solid square block
139        ACS_BOARD      #         board of squares
140        ACS_BTEE       +         bottom tee
141        ACS_BULLET     o         bullet
142        ACS_CKBOARD    :         checker board (stipple)
143        ACS_DARROW     v         arrow pointing down
144        ACS_DEGREE     '         degree symbol
145        ACS_DIAMOND    +         diamond
146        ACS_GEQUAL     &gt;         greater-than-or-equal-to
147        ACS_HLINE      -         horizontal line
148        ACS_LANTERN    #         lantern symbol
149        ACS_LARROW     &lt;         arrow pointing left
150        ACS_LEQUAL     &lt;         less-than-or-equal-to
151        ACS_LLCORNER   +         lower left-hand corner
152        ACS_LRCORNER   +         lower right-hand corner
153        ACS_LTEE       +         left tee
154        ACS_NEQUAL     !         not-equal
155        ACS_PI         *         greek pi
156        ACS_PLMINUS    #         plus/minus
157        ACS_PLUS       +         plus
158        ACS_RARROW     &gt;         arrow pointing right
159        ACS_RTEE       +         right tee
160        ACS_S1         -         scan line 1
161        ACS_S3         -         scan line 3
162        ACS_S7         -         scan line 7
163        ACS_S9         _         scan line 9
164        ACS_STERLING   f         pound-sterling symbol
165        ACS_TTEE       +         top tee
166        ACS_UARROW     ^         arrow pointing up
167        ACS_ULCORNER   +         upper left-hand corner
168        ACS_URCORNER   +         upper right-hand corner
169        ACS_VLINE      |         vertical line
170
171
172 </PRE>
173 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
174        All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
175        success  (the  SVr4 manuals specify only "an integer value
176        other than <STRONG>ERR</STRONG>") upon successful completion, unless other-
177        wise noted in the preceding routine descriptions.
178
179        Functions  with a "mv" prefix first perform a cursor move-
180        ment using <STRONG>wmove</STRONG>, and return an error if the  position  is
181        outside the window, or if the window pointer is null.
182
183
184 </PRE>
185 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
186        Note  that  <STRONG>addch</STRONG>,  <STRONG>mvaddch</STRONG>, <STRONG>mvwaddch</STRONG>, and <STRONG>echochar</STRONG> may be
187        macros.
188
189
190 </PRE>
191 <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 <STRONG>TABSIZE</STRONG> variable is implemented in  some  versions  of
211        curses, but is not part of X/Open curses.
212
213        If  <EM>ch</EM>  is  a  carriage return, the cursor is moved to the
214        beginning of the current row of the window.  This is  true
215        of other implementations, but is not documented.
216
217
218 </PRE>
219 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
220        <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>,
221        <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>,
222        <STRONG>putc(3)</STRONG>.
223
224        Comparable  functions  in  the  wide-character  (ncursesw)
225        library are described in <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>.
226
227
228
229                                                          <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
230 </PRE>
231 <div class="nav">
232 <ul>
233 <li><a href="#h2-NAME">NAME</a></li>
234 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
235 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
236 <ul>
237 <li><a href="#h3-Line-Graphics">Line Graphics</a></li>
238 </ul>
239 </li>
240 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
241 <li><a href="#h2-NOTES">NOTES</a></li>
242 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
243 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
244 </ul>
245 </div>
246 </BODY>
247 </HTML>