92 lines
4.3 KiB
Plaintext
92 lines
4.3 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright (c) 2002 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.3x,v 1.2 2002/03/09 23:16:59 tom Exp $
|
|
.TH curs_addwstr 3X ""
|
|
.SH NAME
|
|
\fBaddwstr\fR,
|
|
\fBaddnwstr\fR,
|
|
\fBwaddwstr\fR,
|
|
\fBwaddnwstr\fR,
|
|
\fBmvaddwstr\fR,
|
|
\fBmvaddnwstr\fR,
|
|
\fBmvwaddwstr\fR,
|
|
\fBmvwaddnwstr\fR \- add a string of wide characters to a \fBcurses\fR window and advance cursor
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fB#include <curses.h>\fR
|
|
|
|
\fBint addwstr(const wchar_t *\fR\fIwstr\fR\fB);\fR
|
|
.br
|
|
\fBint addnwstr(const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|
.br
|
|
\fBint waddwstr(WINDOW *\fR\fIwin\fR\fB, const wchar_t *\fR\fIwstr\fR\fB);\fR
|
|
.br
|
|
\fBint waddnwstr(WINDOW *\fR\fIwin\fR\fB, const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|
.br
|
|
\fBint mvaddwstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const wchar_t *\fR\fIwstr\fR\fB);\fR
|
|
.br
|
|
\fBint mvaddnwstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|
.br
|
|
\fBint mvwaddwstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const wchar_t *\fR\fIwstr\fR\fB);\fR
|
|
.br
|
|
\fBint mvwaddnwstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const wchar_t *\fR\fIwstr\fR\fB, int \fR\fIn\fR\fB);\fR
|
|
.fi
|
|
.SH DESCRIPTION
|
|
These routines write the characters of the (null-terminated) \fBwchar_t\fRcharacter string
|
|
\fIwstr\fR on the given window.
|
|
It is similar to constructing a \fBcchar_t\fR for each wchar_t in the string,
|
|
then calling \fBwadd_wch\fR for the resulting \fBcchar_t\fR.
|
|
.PP
|
|
The \fImv\fR routines 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 routines with \fIn\fR as the last argument
|
|
write at most \fIn\fR \fBwchar_t\fR characters.
|
|
If \fIn\fR is -1, then the entire string will be added,
|
|
up to the maximum number of characters that will fit on the line,
|
|
or until a terminating null is reached.
|
|
.SH RETURN VALUES
|
|
All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success.
|
|
.SH NOTES
|
|
Note that all of these routines except \fBwaddnwstr\fR may be macros.
|
|
.SH PORTABILITY
|
|
All these entry points are described in the XSI Curses standard, Issue 4.
|
|
.SH SEE ALSO
|
|
.PP
|
|
Functions:
|
|
\fBcurses\fR(3X),
|
|
\fBcurs_add_wch\fR(3X)
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|