ncurses 5.7 - patch 20100918
[ncurses.git] / doc / html / man / curs_add_wch.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 2001-2006,2010 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_add_wch.3x,v 1.9 2010/09/18 20:18:34 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_add_wch 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_add_wch 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>                                       <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2>NAME</H2><PRE>
50        <STRONG>add_wch</STRONG>,   <STRONG>wadd_wch</STRONG>,  <STRONG>mvadd_wch</STRONG>,  <STRONG>mvwadd_wch</STRONG>,  <STRONG>echo_wchar</STRONG>,
51        <STRONG>wecho_wchar</STRONG> - add a complex character and rendition  to  a
52        <STRONG>curses</STRONG> window, then advance the cursor
53
54
55 </PRE>
56 <H2>SYNOPSIS</H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59        <STRONG>int</STRONG> <STRONG>add_wch(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
60        <STRONG>int</STRONG> <STRONG>wadd_wch(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
61        <STRONG>int</STRONG> <STRONG>mvadd_wch(</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
62        <STRONG>int</STRONG>  <STRONG>mvwadd_wch(</STRONG>  <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG>
63        <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
64        <STRONG>int</STRONG> <STRONG>echo_wchar(</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
65        <STRONG>int</STRONG> <STRONG>wecho_wchar(</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM> <STRONG>);</STRONG>
66
67
68 </PRE>
69 <H2>DESCRIPTION</H2><PRE>
70        The <STRONG>add_wch</STRONG>, <STRONG>wadd_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, and <STRONG>mvwadd_wch</STRONG> functions
71        put the complex character <EM>wch</EM> into the given window at its
72        current position, which is then advanced.  These functions
73        perform  wrapping and special-character processing as fol-
74        lows:
75
76        <STRONG>o</STRONG>   If <EM>wch</EM> refers to a spacing character, then any  previ-
77            ous  character  at  that  location  is removed.  A new
78            character specified by <EM>wch</EM> is placed at that  location
79            with  rendition  specified  by  <EM>wch</EM>.   The cursor then
80            advances to the next spacing character on the screen.
81
82        <STRONG>o</STRONG>   If <EM>wch</EM> refers to a non-spacing character, all previous
83            characters  at  that location are preserved.  The non-
84            spacing characters of <EM>wch</EM> are  added  to  the  spacing
85            complex  character, and the rendition specified by <EM>wch</EM>
86            is ignored.
87
88        <STRONG>o</STRONG>   If the character  part  of  <EM>wch</EM>  is  a  tab,  newline,
89            backspace  or  other  control character, the window is
90            updated and the cursor moves as if <STRONG>addch</STRONG> were called.
91
92        The <STRONG>echo_wchar</STRONG> function is functionally  equivalent  to  a
93        call to <STRONG>add_wch</STRONG> followed by a call to <STRONG>refresh</STRONG>.  Similarly,
94        the <STRONG>wecho_wchar</STRONG> is functionally equivalent to  a  call  to
95        <STRONG>wadd_wch</STRONG>  followed  by  a call to <STRONG>wrefresh</STRONG>.  The knowledge
96        that only a single character is being output is taken into
97        consideration and, for non-control characters, a consider-
98        able performance gain might be seen by  using  the  *<STRONG>echo</STRONG>*
99        functions instead of their equivalents.
100
101
102 </PRE>
103 <H2>RETURN VALUES</H2><PRE>
104        All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on
105        success.
106
107        Functions with a "mv" prefix first perform a cursor  move-
108        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
109        outside the window, or if the window pointer is null.
110
111
112 </PRE>
113 <H2>NOTES</H2><PRE>
114        Note that <STRONG>add_wch</STRONG>, <STRONG>mvadd_wch</STRONG>, <STRONG>mvwadd_wch</STRONG>,  and  <STRONG>echo_wchar</STRONG>
115        may be macros.
116
117
118 </PRE>
119 <H2>PORTABILITY</H2><PRE>
120        All  these functions are described in the XSI Curses stan-
121        dard, Issue 4.  The defaults specified  for  forms-drawing
122        characters apply in the POSIX locale.
123
124        XSI  documents  constants  beginning  with <STRONG>WACS_</STRONG> which are
125        used for line-drawing.  Those  are  not  currently  imple-
126        mented in <STRONG>ncurses</STRONG>.
127
128
129 </PRE>
130 <H2>SEE ALSO</H2><PRE>
131        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(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>,
132        <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="putwc.3.html">putwc(3)</A></STRONG>
133
134
135
136                                                        <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
137 </PRE>
138 <HR>
139 <ADDRESS>
140 Man(1) output converted with
141 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
142 </ADDRESS>
143 </BODY>
144 </HTML>