diff options
Diffstat (limited to '')
| -rw-r--r-- | upstream/opensuse-tumbleweed/man3/ins_wstr.3ncurses | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/upstream/opensuse-tumbleweed/man3/ins_wstr.3ncurses b/upstream/opensuse-tumbleweed/man3/ins_wstr.3ncurses new file mode 100644 index 00000000..87be4e61 --- /dev/null +++ b/upstream/opensuse-tumbleweed/man3/ins_wstr.3ncurses @@ -0,0 +1,123 @@ +.\"*************************************************************************** +.\" 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_ins_wstr.3x,v 1.30 2023/12/16 20:36:15 tom Exp $ +.TH ins_wstr 3NCURSES 2023-12-16 "ncurses 6.4" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. +.SH NAME +\fB\%ins_wstr\fP, +\fB\%ins_nwstr\fP, +\fB\%wins_wstr\fP, +\fB\%wins_nwstr\fP, +\fB\%mvins_wstr\fP, +\fB\%mvins_nwstr\fP, +\fB\%mvwins_wstr\fP, +\fB\%mvwins_nwstr\fP \- +insert a wide-character string in a \fIcurses\fR window +.SH SYNOPSIS +.nf +\fB#include <ncursesw/curses.h> +.PP +\fBint ins_wstr(const wchar_t *\fIwstr\fP); +\fBint ins_nwstr(const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint wins_wstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP); +\fBint wins_nwstr(WINDOW *\fIwin\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); +.PP +\fBint mvins_wstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); +\fBint mvins_nwstr(int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); +\fBint mvwins_wstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP); +\fBint mvwins_nwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const wchar_t *\fIwstr\fP, int \fIn\fP); +.fi +.SH DESCRIPTION +These routines insert a \fBwchar_t\fP character string +(as many characters as will fit on the line) +before the character under the cursor, +as if calling \fB\%wins_wch\fP(3NCURSES). +All characters to the right of the cursor are shifted right, +with the possibility of the rightmost characters on the line being lost. +No wrapping is performed. +.PP +The cursor position does not change +(after moving to \fIy\fP, \fIx\fP, if specified). +.PP +The functions with \fIn\fP as the last argument +insert a leading substring of at most \fIn\fP \fBwchar_t\fP characters. +If \fIn\fP is less than zero, the entire string is inserted +(stopping on a L'\e0' character). +.PP +Special characters are handled as in \fB\%wadd_wch\fP(3NCURSES). +.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 \fIwin\fP parameter is null or +.bP +if the \fIwstr\fP parameter is null or +.bP +if the \fBwins_wch\fP function returns an error. +.PP +Functions with a \*(``mv\*('' prefix first perform a cursor movement using +\fB\%wmove\fP(3NCURSES), and return an error if the position is outside the window, +or if the window pointer is null. +.SH NOTES +All but \fBwins_nwstr\fP may be macros. +.PP +If the first character in the string is a non-spacing character, these +functions will fail. +XSI does not define what will happen if a non-spacing character follows +a control character. +.SH PORTABILITY +These functions are described in the XSI Curses standard, Issue 4, +which adds \fI\%const\fP qualifiers to the arguments. +.PP +X/Open states that the entire string is inserted if \fIn\fP is less than 1. +This is probably an error, +because it is inconsistent with other functions, +and differs from the X/Open implementation on Solaris. +.SH SEE ALSO +\fB\%ncurses\fP(3NCURSES), +\fB\%insstr\fP(3NCURSES), +\fB\%ins_wch\fP(3NCURSES), +\fB\%in_wch\fP(3NCURSES) |