1 .\"***************************************************************************
2 .\" Copyright 2019-2023,2024 Thomas E. Dickey *
3 .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: curs_add_wchstr.3x,v 1.40 2024/05/11 20:39:53 tom Exp $
31 .TH curs_add_wchstr 3X 2024-05-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
53 \fB\%mvadd_wchnstr\fP,
54 \fB\%mvwadd_wchstr\fP,
55 \fB\%mvwadd_wchnstr\fP \-
56 add a \fIcurses\fR complex character string to a window
59 \fB#include <curses.h>
61 \fBint add_wchstr(const cchar_t *\fIwchstr\fP);
62 \fBint wadd_wchstr(WINDOW * \fIwin\fP, const cchar_t *\fIwchstr\fP);
63 \fBint mvadd_wchstr(int \fIy\fP, int \fIx\fP, const cchar_t *\fIwchstr\fP);
64 \fBint mvwadd_wchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t *\fIwchstr\fP);
66 \fBint add_wchnstr(const cchar_t *\fIwchstr\fP, int \fIn\fP);
67 \fBint wadd_wchnstr(WINDOW * \fIwin\fP, const cchar_t *\fIwchstr\fP, int \fIn\fP);
68 \fBint mvadd_wchnstr(int \fIy\fP, int \fIx\fP, const cchar_t *\fIwchstr\fP, int \fIn\fP);
69 \fBint mvwadd_wchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t *\fIwchstr\fP, int \fIn\fP);
73 copies the string of complex characters
77 A null complex character terminates the string.
78 If a complex character does completely fit at the end of the line,
80 fills the remaining columns with the window background;
81 see \fB\%bkgrnd\fP(3X).
87 or as many as possible if
91 \fB\%ncurses\fP(3X) describes the variants of these functions.
93 Because these functions do not call \fB\%wadd_wch\fP(3X) internally,
94 they are faster than \fB\%waddwstr\fP(3X) and \fB\%waddnwstr\fP(3X).
98 do not treat the backspace,
100 or line feed characters specially;
102 do not represent unprintable characters with \fB\%wunctrl\fP(3X);
104 do not update the cursor position to follow the last character written;
106 truncate the string at the window's right margin,
107 rather than wrapping it to the next line and potentially scrolling.
109 These functions return
115 X/Open Curses does not specify any error conditions.
130 Functions prefixed with \*(``mv\*('' first perform cursor movement and
134 is outside the window boundaries.
136 All of these functions except
138 may be implemented as macros.
141 Issue 4 describes these functions.
143 \fB\%curs_addchstr\fP(3X) describes comparable functions of the
145 library in its non-wide-character configuration.
148 \fB\%curs_addwstr\fP(3X),
149 \fB\%curs_add_wch\fP(3X)