1 <!DOCTYPE HTML PUBLIC
"-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 2002-2005,2010 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.6 2010/12/04 18:38:55 tom Exp @
34 <TITLE>curs_ins_wstr
3x
</TITLE>
35 <link rev=made
href=
"mailto:bug-ncurses@gnu.org">
36 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1">
39 <H1>curs_ins_wstr
3x
</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF=
"curs_ins_wstr.3x.html">curs_ins_wstr(
3x)
</A></STRONG> <STRONG><A HREF=
"curs_ins_wstr.3x.html">curs_ins_wstr(
3x)
</A></STRONG>
50 <STRONG>ins_wstr
</STRONG>,
<STRONG>ins_nwstr
</STRONG>,
<STRONG>wins_wstr
</STRONG>,
<STRONG>wins_nwstr
</STRONG>,
<STRONG>mvins_wstr
</STRONG>,
51 <STRONG>mvins_nwstr
</STRONG>,
<STRONG>mvwins_wstr
</STRONG>,
<STRONG>mvwins_nwstr
</STRONG> - insert a wide-
52 character string into a curses window
56 <H2>SYNOPSIS
</H2><PRE>
57 <STRONG>#include
</STRONG> <STRONG><curses.h
></STRONG>
59 <STRONG>int
</STRONG> <STRONG>ins_wstr(const
</STRONG> <STRONG>wchar_t
</STRONG> <STRONG>*
</STRONG><EM>wstr);
</EM>
60 <STRONG>int
</STRONG> <STRONG>ins_nwstr(const
</STRONG> <STRONG>wchar_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>n
</EM><STRONG>);
</STRONG>
61 <STRONG>int
</STRONG> <STRONG>wins_wstr(WINDOW
</STRONG> <STRONG>*
</STRONG><EM>win
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>wchar_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>);
</STRONG>
62 <STRONG>int
</STRONG> <STRONG>wins_nwstr(WINDOW
</STRONG> <STRONG>*
</STRONG><EM>win
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>wchar_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>n
</EM><STRONG>);
</STRONG>
63 <STRONG>int
</STRONG> <STRONG>mvins_wstr(int
</STRONG> <EM>y
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>x
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>wchar_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>);
</STRONG>
64 <STRONG>int
</STRONG> <STRONG>mvins_nwstr(int
</STRONG> <EM>y
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>x
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>wchar_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>n
</EM><STRONG>);
</STRONG>
65 <STRONG>int
</STRONG> <STRONG>mvwins_wstr(WINDOW
</STRONG> <STRONG>*
</STRONG><EM>win
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>y
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>x
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>wchar_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>);
</STRONG>
66 <STRONG>int
</STRONG> <STRONG>mvwins_nwstr(WINDOW
</STRONG> <STRONG>*
</STRONG><EM>win
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>y
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>x
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>wchar_t
</STRONG> <STRONG>*
</STRONG><EM>wstr
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>n
</EM><STRONG>);
</STRONG>
70 <H2>DESCRIPTION
</H2><PRE>
71 These routines insert a
<STRONG>wchar_t
</STRONG> character string (as many
72 characters as will fit on the line) before the character
73 under the cursor. All characters to the right of the cur-
74 sor are shifted right, with the possibility of the right-
75 most characters on the line being lost. No wrapping is
76 performed. The cursor position does not change (after
77 moving to
<EM>y
</EM>,
<EM>x
</EM>, if specified). The four routines with
<EM>n
</EM>
78 as the last argument insert a leading substring of at most
79 <EM>n
</EM> <STRONG>wchar_t
</STRONG> characters. If
<EM>n
</EM> is less than
1, the entire
82 If a character in
<EM>wstr
</EM> is a tab, newline, carriage return
83 or backspace, the cursor is moved appropriately within the
84 window. A newline also does a
<STRONG>clrtoeol
</STRONG> before moving.
85 Tabs are considered to be at every eighth column. If a
86 character in
<EM>wstr
</EM> is another control character, it is
87 drawn in the
<STRONG>^
</STRONG><EM>X
</EM> notation. Calling
<STRONG>win_wch
</STRONG> after adding a
88 control character (and moving to it, if necessary) does
89 not return the control character, but instead returns a
90 character in the ^-representation of the control charac-
96 Note that all but wins_nwstr may be macros.
98 If the first character in the string is a nonspacing char-
99 acter, these functions will fail. XSI does not define
100 what will happen if a nonspacing character follows a con-
105 <H2>RETURN VALUES
</H2><PRE>
106 Upon successful completion, these functions return OK.
107 Otherwise, they return ERR.
109 Functions with a
"mv" prefix first perform a cursor move-
110 ment using
<STRONG>wmove
</STRONG>, and return an error if the position is
111 outside the window, or if the window pointer is null.
115 <H2>SEE ALSO
</H2><PRE>
116 <STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>,
<STRONG><A HREF=
"curs_insstr.3x.html">curs_insstr(
3x)
</A></STRONG>,
<STRONG><A HREF=
"curs_in_wch.3x.html">curs_in_wch(
3x)
</A></STRONG>,
117 <STRONG><A HREF=
"curs_ins_wch.3x.html">curs_ins_wch(
3x)
</A></STRONG>.
121 <STRONG><A HREF=
"curs_ins_wstr.3x.html">curs_ins_wstr(
3x)
</A></STRONG>
125 Man(
1) output converted with
126 <a href=
"http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html
</a>