118 lines
4.9 KiB
Groff
118 lines
4.9 KiB
Groff
.\" $OpenBSD: curs_addwstr.3,v 1.2 2023/10/17 09:52:08 nicm Exp $
|
|
.\"***************************************************************************
|
|
.\" Copyright 2019-2022,2023 Thomas E. Dickey *
|
|
.\" Copyright 2002-2012,2017 Free Software Foundation, Inc. *
|
|
.\" *
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|
.\" copy of this software and associated documentation files (the *
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
.\" *
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
.\" in all copies or substantial portions of the Software. *
|
|
.\" *
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
.\" *
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
.\" authorization. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" $Id: curs_addwstr.3,v 1.2 2023/10/17 09:52:08 nicm Exp $
|
|
.TH curs_addwstr 3 2023-07-15 "ncurses 6.4" "Library calls"
|
|
.ie \n(.g .ds `` \(lq
|
|
.el .ds `` ``
|
|
.ie \n(.g .ds '' \(rq
|
|
.el .ds '' ''
|
|
.de bP
|
|
.ie n .IP \(bu 4
|
|
.el .IP \(bu 2
|
|
..
|
|
.na
|
|
.hy 0
|
|
.SH NAME
|
|
\fBaddwstr\fP,
|
|
\fBaddnwstr\fP,
|
|
\fBwaddwstr\fP,
|
|
\fBwaddnwstr\fP,
|
|
\fBmvaddwstr\fP,
|
|
\fBmvaddnwstr\fP,
|
|
\fBmvwaddwstr\fP,
|
|
\fBmvwaddnwstr\fP \- add a string of wide characters to a \fBcurses\fP window and advance cursor
|
|
.ad
|
|
.hy
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fB#include <curses.h>\fP
|
|
.PP
|
|
\fBint addwstr(const wchar_t *\fIwstr\fB);\fR
|
|
.br
|
|
\fBint addnwstr(const wchar_t *\fIwstr\fB, int \fIn\fB);\fR
|
|
.br
|
|
\fBint waddwstr(WINDOW *\fIwin\fB, const wchar_t *\fIwstr\fB);\fR
|
|
.br
|
|
\fBint waddnwstr(WINDOW *\fIwin\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR
|
|
.sp
|
|
\fBint mvaddwstr(int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB);\fR
|
|
.br
|
|
\fBint mvaddnwstr(int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR
|
|
.br
|
|
\fBint mvwaddwstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB);\fR
|
|
.br
|
|
\fBint mvwaddnwstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR
|
|
.fi
|
|
.SH DESCRIPTION
|
|
These functions write the characters of the
|
|
(null-terminated) \fBwchar_t\fP character string
|
|
\fIwstr\fP on the given window.
|
|
It is similar to constructing a \fBcchar_t\fP for
|
|
each \fBwchar_t\fR in the string,
|
|
then calling \fBwadd_wch\fP(3) for the resulting \fBcchar_t\fP:
|
|
.bP
|
|
spacing and non-spacing characters in the string
|
|
are processed one at a time, and
|
|
.bP
|
|
control characters are processed as in \fBwaddch\fP(3).
|
|
.PP
|
|
The \fImv\fP functions perform cursor movement once, before writing any
|
|
characters.
|
|
Thereafter, the cursor is advanced as a side-effect of writing to the window.
|
|
.PP
|
|
The four functions with \fIn\fP as the last argument
|
|
write at most \fIn\fP \fBwchar_t\fP characters,
|
|
or until a terminating null is reached.
|
|
If \fIn\fP is \-1, then the entire string will be added.
|
|
.SH RETURN VALUE
|
|
All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success.
|
|
.PP
|
|
X/Open does not define any error conditions.
|
|
This implementation returns an error
|
|
.bP
|
|
if the window pointer is null or
|
|
.bP
|
|
if the string pointer is null or
|
|
.bP
|
|
if the corresponding calls to \fBwadd_wch\fP return an error.
|
|
.PP
|
|
Functions with a \*(``mv\*('' prefix first perform a cursor movement using
|
|
\fBwmove\fP, and return an error if the position is outside the window,
|
|
or if the window pointer is null.
|
|
.SH NOTES
|
|
All of these functions except \fBwaddnwstr\fP may be macros.
|
|
.SH PORTABILITY
|
|
These functions are described in the XSI Curses standard, Issue 4.
|
|
.SH SEE ALSO
|
|
\fBcurses\fP(3),
|
|
\fBcurs_addch\fP(3),
|
|
\fBcurs_add_wch\fP(3).
|