ncurses 6.0 - patch 20171118
[ncurses.git] / man / curs_add_wchstr.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 2002-2012,2017 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_add_wchstr.3x,v 1.11 2017/11/18 23:56:00 tom Exp $
30 .TH curs_add_wchstr 3X ""
31 .de bP
32 .ie n  .IP \(bu 4
33 .el    .IP \(bu 2
34 ..
35 .na
36 .hy 0
37 .SH NAME
38 \fBadd_wchstr\fR,
39 \fBadd_wchnstr\fR,
40 \fBwadd_wchstr\fR,
41 \fBwadd_wchnstr\fR,
42 \fBmvadd_wchstr\fR,
43 \fBmvadd_wchnstr\fR,
44 \fBmvwadd_wchstr\fR,
45 \fBmvwadd_wchnstr\fR \- add an array of complex characters (and attributes) to a curses window
46 .ad
47 .hy
48 .SH SYNOPSIS
49 .nf
50 \fB#include <curses.h>\fR
51 .PP
52 \fBint add_wchstr(const cchar_t *\fR\fIwchstr\fR\fB);\fR
53 .br
54 \fBint add_wchnstr(const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
55 .br
56 \fBint wadd_wchstr(WINDOW *\fR \fIwin\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB);\fR
57 .br
58 \fBint wadd_wchnstr(WINDOW *\fR \fIwin\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
59 .br
60 \fBint mvadd_wchstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB);\fR
61 .br
62 \fBint mvadd_wchnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
63 .br
64 \fBint mvwadd_wchstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB);\fR
65 .br
66 \fBint mvwadd_wchnstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const cchar_t *\fR\fIwchstr\fR\fB, int \fR\fIn\fR\fB);\fR
67 .fi
68 .SH DESCRIPTION
69 These functions copy the (null-terminated)
70 array of complex characters \fIwchstr\fR
71 into the window image structure
72 starting at the current cursor position.
73 The four functions with \fIn\fR as the last
74 argument copy at most \fIn\fR elements,
75 but no more than will fit on the line.
76 If \fBn\fR=\fB\-1\fR then the whole array is copied,
77 to the maximum number of characters that will fit on the line.
78 .PP
79 The window cursor is \fInot\fR advanced.
80 These functions work faster than \fBwaddnstr\fR.
81 On the other hand:
82 .bP
83 they do not perform checking
84 (such as for the newline, backspace, or carriage return characters),
85 .bP
86 they do not advance the current cursor position,
87 .bP
88 they do not expand other control characters to ^-escapes, and
89 .bP
90 they truncate the string if it crosses the right margin,
91 rather than wrapping it around to the new line.
92 .PP
93 These functions end successfully
94 on encountering a null \fIcchar_t\fR, or
95 when they have filled the current line.
96 If a complex character cannot completely fit at the end of the current line,
97 the remaining columns are filled with the background character and rendition.
98 .SH RETURN VALUE
99 All functions return the integer \fBERR\fR upon failure and \fBOK\fR on success.
100 .PP
101 X/Open does not define any error conditions.
102 This implementation returns an error
103 if the window pointer is null.
104 .PP
105 Functions with a "mv" prefix first perform a cursor movement using
106 \fBwmove\fP, and return an error if the position is outside the window,
107 or if the window pointer is null.
108 .SH NOTES
109 All functions except \fBwadd_wchnstr\fR may be macros.
110 .SH PORTABILITY
111 These entry points are described in the XSI Curses standard, Issue 4.
112 .SH SEE ALSO
113 \fBcurs_addwstr\fR(3X),
114 \fBcurses\fR(3X).
115 .PP
116 Comparable functions in the narrow-character (ncurses) library are
117 described in
118 \fBcurs_addchstr\fR(3X).