mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-02 08:42:48 +00:00
96 lines
4.7 KiB
Plaintext
96 lines
4.7 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright (c) 1998,2000,2001 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_insstr.3x,v 1.12 2001/11/03 19:59:03 tom Exp $
|
|
.TH curs_insstr 3X ""
|
|
.SH NAME
|
|
\fBinsstr\fR,
|
|
\fBinsnstr\fR,
|
|
\fBwinsstr\fR,
|
|
\fBwinsnstr\fR,
|
|
\fBmvinsstr\fR,
|
|
\fBmvinsnstr\fR,
|
|
\fBmvwinsstr\fR,
|
|
\fBmvwinsnstr\fR - insert string before cursor in a \fBcurses\fR window
|
|
.SH SYNOPSIS
|
|
\fB#include <curses.h>\fR
|
|
.br
|
|
\fBint insstr(const char *str);\fR
|
|
.br
|
|
\fBint insnstr(const char *str, int n);\fR
|
|
.br
|
|
\fBint winsstr(WINDOW *win, const char *str);\fR
|
|
.br
|
|
\fBint winsnstr(WINDOW *win, const char *str, int n);\fR
|
|
.br
|
|
\fBint mvinsstr(int y, int x, const char *str);\fR
|
|
.br
|
|
\fBint mvinsnstr(int y, int x, const char *str, int n);\fR
|
|
.br
|
|
\fBint mvwinsstr(WINDOW *win, int y, int x, const char *str);\fR
|
|
.br
|
|
\fBint mvwinsnstr(WINDOW *win, int y, int x, const char *str, int n);\fR
|
|
.br
|
|
.SH DESCRIPTION
|
|
These routines insert a 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. The cursor position does not change (after moving to
|
|
\fIy\fR, \fIx\fR, if specified). The four routines with \fIn\fR as the last
|
|
argument insert a leading substring of at most \fIn\fR characters. If
|
|
\fIn\fR<=0, then the entire string is inserted.
|
|
|
|
If a character in \fIstr\fR is a tab, newline, carriage return or
|
|
backspace, the cursor is moved appropriately within the window. A
|
|
newline also does a \fBclrtoeol\fR before moving. Tabs are considered
|
|
to be at every eighth column. If a character in \fIstr\fR is another
|
|
control character, it is drawn in the \fB^\fR\fIX\fR notation.
|
|
Calling \fBwinch\fR 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 RETURN VALUE
|
|
All routines that return an integer return \fBERR\fR upon failure and OK (SVr4
|
|
specifies only "an integer value other than \fBERR\fR") upon successful
|
|
completion, unless otherwise noted in the preceding routine descriptions.
|
|
.SH NOTES
|
|
Note that all but \fBwinsnstr\fR may be macros.
|
|
.SH PORTABILITY
|
|
These functions are described in the XSI Curses standard, Issue 4, which adds
|
|
const qualifiers to the arguments. The XSI Curses error conditions
|
|
\fBEILSEQ\fR and \fBEILOVERFLOW\fR associated with extended-level conformance
|
|
are not yet detected (this implementation does not yet support XPG4 multibyte
|
|
characters).
|
|
.SH SEE ALSO
|
|
\fBcurses\fR(3X), \fBcurs_clear\fR(3X), \fBcurs_inch\fR(3X).
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|