Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / b2cef93693cf7cfd01098c9b69603c90f0f4b803 / . / doc / html / man / curs_insstr.3x.html
blob: fc2428f8b41b8445f3b4090287e8b8206360a002 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]3 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]4 * *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
12 * *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
15 * *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
27 * authorization. *
28 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]29 * @Id: curs_insstr.3x,v 1.21 2010/12/04 18:38:55 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]34<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36<TITLE>curs_insstr 3x</TITLE>
37<link rev=made href="mailto:bug-ncurses@gnu.org">
38<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]41<H1 class="no-header">curs_insstr 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]50 <STRONG>insstr</STRONG>, <STRONG>insnstr</STRONG>, <STRONG>winsstr</STRONG>, <STRONG>winsnstr</STRONG>, <STRONG>mvinsstr</STRONG>, <STRONG>mvinsnstr</STRONG>,
51 <STRONG>mvwinsstr</STRONG>, <STRONG>mvwinsnstr</STRONG> - insert string before cursor in a
52 <STRONG>curses</STRONG> window
53
54
55</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]56<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]57 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58 <STRONG>int</STRONG> <STRONG>insstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
59 <STRONG>int</STRONG> <STRONG>insnstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
60 <STRONG>int</STRONG> <STRONG>winsstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
61 <STRONG>int</STRONG> <STRONG>winsnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
62 <STRONG>int</STRONG> <STRONG>mvinsstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
63 <STRONG>int</STRONG> <STRONG>mvinsnstr(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvwinsstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
65 <STRONG>int</STRONG> <STRONG>mvwinsnstr(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG>
66 <STRONG>int</STRONG> <STRONG>n);</STRONG>
67
68
69</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]70<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
71 These routines insert a character string (as many charac-
72 ters as will fit on the line) before the character under
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]73 the cursor. All characters to the right of the cursor are
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]74 shifted right with the possibility of the rightmost char-
75 acters on the line being lost. The cursor position does
76 not change (after moving to <EM>y</EM>, <EM>x</EM>, if specified). The
77 functions with <EM>n</EM> as the last argument insert a leading
78 substring of at most <EM>n</EM> characters. If <EM>n</EM>&lt;=0, then the
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]79 entire string is inserted.
80
81 Special characters are handled as in <STRONG>addch</STRONG>.
82
83
84</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]85<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
86 All routines that return an integer return <STRONG>ERR</STRONG> upon fail-
87 ure and OK (SVr4 specifies only "an integer value other
88 than <STRONG>ERR</STRONG>") upon successful completion, unless otherwise
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]89 noted in the preceding routine descriptions.
90
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]91 X/Open defines no error conditions. In this implementa-
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]92 tion, if the window parameter is null or the str parameter
93 is null, an error is returned.
94
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]95 Functions with a "mv" prefix first perform a cursor move-
96 ment using <STRONG>wmove</STRONG>, and return an error if the position is
97 outside the window, or if the window pointer is null.
98
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]99
100</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]101<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]102 Note that all but <STRONG>winsnstr</STRONG> may be macros.
103
104
105</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]106<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
107 These functions are described in the XSI Curses standard,
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]108 Issue 4, which adds const qualifiers to the arguments.
109
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]110 The Single Unix Specification, Version 2 states that
111 <STRONG>insnstr</STRONG> and <STRONG>winsnstr</STRONG> perform wrapping. This is probably
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]112 an error, since it makes this group of functions inconsis-
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]113 tent. Also, no implementation of curses documents this
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]114 inconsistency.
115
116
117</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]118<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
119 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]120
121
122
123 <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
124</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]125<div class="nav">
126<ul>
127<li><a href="#h2-NAME">NAME</a></li>
128<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
129<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
130<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
131<li><a href="#h2-NOTES">NOTES</a></li>
132<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
133<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
134</ul>
135</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]136</BODY>
137</HTML>