2 ****************************************************************************
3 * Copyright 2019,2020 Thomas E. Dickey *
4 * Copyright 2002-2012,2017 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_ins_wstr.3x,v 1.11 2020/10/17 23:21:25 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_ins_wstr 3X</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_ins_wstr 3X</H1>
44 <B><A HREF="curs_ins_wstr.3X.html">curs_ins_wstr(3X)</A></B> <B><A HREF="curs_ins_wstr.3X.html">curs_ins_wstr(3X)</A></B>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <B>ins_wstr</B>, <B>ins_nwstr</B>, <B>wins_wstr</B>, <B>wins_nwstr</B>, <B>mvins_wstr</B>, <B>mvins_nwstr</B>,
51 <B>mvwins_wstr</B>, <B>mvwins_nwstr</B> - insert a wide-character string into a
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <B>#include</B> <B><curses.h></B>
58 <B>int</B> <B>ins_wstr(const</B> <B>wchar_t</B> <B>*</B><I>wstr);</I>
59 <B>int</B> <B>ins_nwstr(const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
60 <B>int</B> <B>wins_wstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
61 <B>int</B> <B>wins_nwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
63 <B>int</B> <B>mvins_wstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
64 <B>int</B> <B>mvins_nwstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
65 <B>int</B> <B>mvwins_wstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>);</B>
66 <B>int</B> <B>mvwins_nwstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>wchar_t</B> <B>*</B><I>wstr</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
69 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
70 These routines insert a <B>wchar_t</B> character string (as many characters as
71 will fit on the line) before the character under the cursor. All char-
72 acters to the right of the cursor are shifted right, with the possibil-
73 ity of the rightmost characters on the line being lost. No wrapping is
74 performed. The cursor position does not change (after moving to <I>y</I>, <I>x</I>,
75 if specified). The four routines with <I>n</I> as the last argument insert a
76 leading substring of at most <I>n</I> <B>wchar_t</B> characters. If <I>n</I> is less than
77 1, the entire string is inserted.
79 If a character in <I>wstr</I> is a tab, newline, carriage return or backspace,
80 the cursor is moved appropriately within the window. A newline also
81 does a <B>clrtoeol</B> before moving. Tabs are considered to be at every
82 eighth column. If a character in <I>wstr</I> is another control character, it
83 is drawn in the <B>^</B><I>X</I> notation. Calling <B>win_wch</B> after adding a control
84 character (and moving to it, if necessary) does not return the control
85 character, but instead returns a character in the ^-representation of
86 the control character.
89 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
90 Note that all but wins_nwstr may be macros.
92 If the first character in the string is a nonspacing character, these
93 functions will fail. XSI does not define what will happen if a non-
94 spacing character follows a control character.
97 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
98 Upon successful completion, these functions return <B>OK</B>. Otherwise, they
101 Functions with a "mv" prefix first perform a cursor movement using
102 <B>wmove</B>, and return an error if the position is outside the window, or if
103 the window pointer is null.
106 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
107 <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_insstr.3X.html">curs_insstr(3X)</A></B>, <B><A HREF="curs_in_wch.3X.html">curs_in_wch(3X)</A></B>, <B><A HREF="curs_ins_wch.3X.html">curs_ins_wch(3X)</A></B>.
111 <B><A HREF="curs_ins_wstr.3X.html">curs_ins_wstr(3X)</A></B>
115 <li><a href="#h2-NAME">NAME</a></li>
116 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
117 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
118 <li><a href="#h2-NOTES">NOTES</a></li>
119 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
120 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>