| .\"*************************************************************************** |
| .\" Copyright 2019-2021,2022 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.14 2022/02/12 20:05:11 tom Exp $ |
| .TH curs_ins_wstr 3X "" |
| .ie \n(.g .ds `` \(lq |
| .el .ds `` `` |
| .ie \n(.g .ds '' \(rq |
| .el .ds '' '' |
| .na |
| .hy 0 |
| .SH NAME |
| \fBins_wstr\fP, |
| \fBins_nwstr\fP, |
| \fBwins_wstr\fP, |
| \fBwins_nwstr\fP, |
| \fBmvins_wstr\fP, |
| \fBmvins_nwstr\fP, |
| \fBmvwins_wstr\fP, |
| \fBmvwins_nwstr\fP \- insert a wide-character string into a curses window |
| .ad |
| .hy |
| .SH SYNOPSIS |
| .nf |
| \fB#include <curses.h>\fP |
| .sp |
| \fBint ins_wstr(const wchar_t *\fIwstr);\fR |
| .br |
| \fBint ins_nwstr(const wchar_t *\fIwstr\fB, int \fIn\fB);\fR |
| .br |
| \fBint wins_wstr(WINDOW *\fIwin\fB, const wchar_t *\fIwstr\fB);\fR |
| .br |
| \fBint wins_nwstr(WINDOW *\fIwin\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR |
| .sp |
| \fBint mvins_wstr(int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB);\fR |
| .br |
| \fBint mvins_nwstr(int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR |
| .br |
| \fBint mvwins_wstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB);\fR |
| .br |
| \fBint mvwins_nwstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const wchar_t *\fIwstr\fB, int \fIn\fB);\fR |
| .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. |
| 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. |
| The cursor position does not change |
| (after moving to \fIy\fP, \fIx\fP, if specified). |
| The four routines 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 1, the entire string is inserted. |
| .PP |
| If a character in \fIwstr\fP is a tab, newline, carriage return or |
| backspace, the cursor is moved appropriately within the window. |
| A newline also does a \fBclrtoeol\fP before moving. |
| Tabs are considered to be at every eighth column. |
| If a character in \fIwstr\fP is another control character, |
| it is drawn in the \fB^\fIX\fR notation. |
| Calling \fBwin_wch\fP after adding a control character |
| (and moving to it, if necessary) |
| does not return the control character, |
| but instead returns a character in the ^-representation |
| of the control character. |
| .SH NOTES |
| Note that all but wins_nwstr may be macros. |
| .PP |
| If the first character in the string is a nonspacing character, these |
| functions will fail. |
| XSI does not define what will happen if a nonspacing character follows |
| a control character. |
| .SH RETURN VALUE |
| Upon successful completion, these functions return \fBOK\fP. |
| Otherwise, they return \fBERR\fP. |
| .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 SEE ALSO |
| \fBcurses\fP(3X), |
| \fBcurs_insstr\fP(3X), |
| \fBcurs_in_wch\fP(3X), |
| \fBcurs_ins_wch\fP(3X). |