diff options
Diffstat (limited to 'upstream/opensuse-tumbleweed/man3/addwstr.3ncurses')
| -rw-r--r-- | upstream/opensuse-tumbleweed/man3/addwstr.3ncurses | 103 |
1 files changed, 66 insertions, 37 deletions
diff --git a/upstream/opensuse-tumbleweed/man3/addwstr.3ncurses b/upstream/opensuse-tumbleweed/man3/addwstr.3ncurses index 47c01f2d..f04261dd 100644 --- a/upstream/opensuse-tumbleweed/man3/addwstr.3ncurses +++ b/upstream/opensuse-tumbleweed/man3/addwstr.3ncurses @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019-2022,2023 Thomas E. Dickey * +.\" Copyright 2019-2023,2024 Thomas E. Dickey * .\" Copyright 2002-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addwstr.3x,v 1.29 2023/11/18 21:18:55 tom Exp $ -.TH addwstr 3NCURSES 2023-11-18 "ncurses 6.4" "Library calls" +.\" $Id: curs_addwstr.3x,v 1.37 2024/04/20 19:18:18 tom Exp $ +.TH addwstr 3NCURSES 2024-04-20 "ncurses 6.5" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -59,59 +59,88 @@ add a wide-character string to a \fIcurses\fR window and advance the cursor \fB#include <ncursesw/curses.h> .PP \fBint addwstr(const wchar_t *\fIwstr\fP); -\fBint addnwstr(const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint mvaddwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); +\fBint mvwaddwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); \fBint waddwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP); -\fBint waddnwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); .PP -\fBint mvaddwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); +\fBint addnwstr(const wchar_t *\fIwstr\fP, int \fIn\fP); \fBint mvaddnwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); -\fBint mvwaddwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); \fBint mvwaddnwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint waddnwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); .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 \fB\%wadd_wch\fP(3NCURSES) for the resulting \fBcchar_t\fP: +.B waddwstr +writes the characters of the (wide-null-terminated) wide-character +string +.I wstr +to the window +.IR win . +Its process is similar to constructing a +.I cchar_t +for each +.I wchar_t +in +.IR wstr , +then calling \fB\%wadd_wch\fP(3NCURSES) with the resulting +.IR cchar_t . .bP -spacing and non-spacing characters in the string -are processed one at a time, and +Spacing and non-spacing characters in the string +are processed one at a time, +and .bP -control characters are processed as in \fB\%waddch\fP(3NCURSES). +control characters are processed as in \fB\%wadd_wch\fP(3NCURSES). .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. +.B waddnwstr +writes at most +.I n +wide characters, +or until a terminating wide null character occurs in +.IR wstr . +If +.I n +is \-1, +.B +.B waddnwstr +writes the entire wide string. .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. +\fB\%ncurses\fP(3NCURSES) describes the variants of these functions. .SH RETURN VALUE -All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. +These functions return +.B OK +on success and +.B ERR +on failure. .PP -X/Open does not define any error conditions. -This implementation returns an error +X/Open Curses does not specify any error conditions. +.I \%ncurses +returns an error .bP -if the window pointer is null or +if the window pointer is +.BR NULL , .bP -if the string pointer is null or +if the string pointer is +.BR NULL , +or .bP -if the corresponding calls to \fBwadd_wch\fP return an error. +if an internal \fB\%wadd_wch\fP(3NCURSES) call returns 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. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .SH NOTES -All of these functions except \fBwaddnwstr\fP may be macros. +All of these functions except +.B waddnwstr +may be implemented as macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +X/Open Curses, +Issue 4 describes these functions. .SH SEE ALSO +\fB\%addstr\fP(3NCURSES) describes comparable functions of the +.I \%ncurses +library in its non-wide-character configuration. +.PP \fB\%ncurses\fP(3NCURSES), -\fB\%addch\fP(3NCURSES), -\fB\%addchstr\fP(3NCURSES), -\fB\%addstr\fP(3NCURSES), \fB\%add_wch\fP(3NCURSES), \fB\%add_wchstr\fP(3NCURSES) |