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_addwstr.3x,v 1.39 2024/05/25 20:10:58 tom Exp $
31 .TH curs_addwstr 3X 2024-05-25 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
55 \fB\%mvwaddnwstr\fP \-
56 add a wide-character string to a \fIcurses\fR window and advance the cursor
59 \fB#include <curses.h>
61 \fBint addwstr(const wchar_t *\fIwstr\fP);
62 \fBint mvaddwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP);
63 \fBint mvwaddwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP);
64 \fBint waddwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP);
66 \fBint addnwstr(const wchar_t *\fIwstr\fP, int \fIn\fP);
67 \fBint mvaddnwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP);
68 \fBint mvwaddnwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP);
69 \fBint waddnwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP, int \fIn\fP);
73 writes the characters of the (wide-null-terminated) wide-character
78 Its process is similar to constructing a
84 then calling \fB\%wadd_wch\fP(3X) with the resulting
87 Spacing and non-spacing characters in the string
88 are processed one at a time,
91 control characters are processed as in \fB\%wadd_wch\fP(3X).
97 or until a terminating wide null character occurs in
104 writes the entire wide string.
106 \fB\%ncurses\fP(3X) describes the variants of these functions.
108 These functions return
114 X/Open Curses does not specify any error conditions.
119 if the window pointer is
122 if the string pointer is
126 if an internal \fB\%wadd_wch\fP(3X) call returns an error.
128 Functions prefixed with \*(``mv\*('' first perform cursor movement and
132 is outside the window boundaries.
134 All of these functions except
136 may be implemented as macros.
139 Issue 4 describes these functions.
141 \fB\%curs_addstr\fP(3X) describes comparable functions of the
143 library in its non-wide-character configuration.
146 \fB\%curs_add_wch\fP(3X),
147 \fB\%curs_add_wchstr\fP(3X)