ncurses 5.3
[ncurses.git] / man / curs_insstr.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998,2000,2001 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_insstr.3x,v 1.12 2001/11/03 19:59:03 tom Exp $
30 .TH curs_insstr 3X ""
31 .SH NAME
32 \fBinsstr\fR,
33 \fBinsnstr\fR,
34 \fBwinsstr\fR,
35 \fBwinsnstr\fR,
36 \fBmvinsstr\fR,
37 \fBmvinsnstr\fR,
38 \fBmvwinsstr\fR,
39 \fBmvwinsnstr\fR - insert string before cursor in a \fBcurses\fR window
40 .SH SYNOPSIS
41 \fB#include <curses.h>\fR
42 .br
43 \fBint insstr(const char *str);\fR
44 .br
45 \fBint insnstr(const char *str, int n);\fR
46 .br
47 \fBint winsstr(WINDOW *win, const char *str);\fR
48 .br
49 \fBint winsnstr(WINDOW *win, const char *str, int n);\fR
50 .br
51 \fBint mvinsstr(int y, int x, const char *str);\fR
52 .br
53 \fBint mvinsnstr(int y, int x, const char *str, int n);\fR
54 .br
55 \fBint mvwinsstr(WINDOW *win, int y, int x, const char *str);\fR
56 .br
57 \fBint mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n);\fR
58 .br
59 .SH DESCRIPTION
60 These routines insert a character string (as many characters as will fit on the
61 line) before the character under the cursor.  All characters to the right of
62 the cursor are shifted right, with the possibility of the rightmost characters
63 on the line being lost.  The cursor position does not change (after moving to
64 \fIy\fR, \fIx\fR, if specified). The four routines with \fIn\fR as the last
65 argument insert a leading substring of at most \fIn\fR characters.  If
66 \fIn\fR<=0, then the entire string is inserted.
67
68 If a character in \fIstr\fR is a tab, newline, carriage return or
69 backspace, the cursor is moved appropriately within the window.  A
70 newline also does a \fBclrtoeol\fR before moving.  Tabs are considered
71 to be at every eighth column.  If a character in \fIstr\fR is another
72 control character, it is drawn in the \fB^\fR\fIX\fR notation.
73 Calling \fBwinch\fR after adding a control character (and moving to
74 it, if necessary) does not return the control character, but instead
75 returns a character in the ^-representation of the control character.
76 .SH RETURN VALUE
77 All routines that return an integer return \fBERR\fR upon failure and OK (SVr4
78 specifies only "an integer value other than \fBERR\fR") upon successful
79 completion, unless otherwise noted in the preceding routine descriptions.
80 .SH NOTES
81 Note that all but \fBwinsnstr\fR may be macros.
82 .SH PORTABILITY
83 These functions are described in the XSI Curses standard, Issue 4, which adds
84 const qualifiers to the arguments.  The XSI Curses error conditions
85 \fBEILSEQ\fR and \fBEILOVERFLOW\fR associated with extended-level conformance
86 are not yet detected (this implementation does not yet support XPG4 multibyte
87 characters).
88 .SH SEE ALSO
89 \fBcurses\fR(3X), \fBcurs_clear\fR(3X), \fBcurs_inch\fR(3X).
90 .\"#
91 .\"# The following sets edit modes for GNU EMACS
92 .\"# Local Variables:
93 .\"# mode:nroff
94 .\"# fill-column:79
95 .\"# End: