X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_insstr.3x.html;h=b7e866c08e43c364e592e8af23da4b8c1b157a37;hp=2349cbc28668e8bd96c2e831449a38cb3a34befa;hb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_insstr.3x.html b/doc/html/man/curs_insstr.3x.html index 2349cbc2..b7e866c0 100644 --- a/doc/html/man/curs_insstr.3x.html +++ b/doc/html/man/curs_insstr.3x.html @@ -1,135 +1,138 @@ + + +
+ + +- - --
- insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr, - mvwinsstr, mvwinsnstr - insert string before cursor in a - curses window +curs_insstr(3x) curs_insstr(3x) --
- #include <curses.h> - int insstr(const char *str); - int insnstr(const char *str, int n); - int winsstr(WINDOW *win, const char *str); - int winsnstr(WINDOW *win, const char *str, int n); - int mvinsstr(int y, int x, const char *str); - int mvinsnstr(int y, int x, const char *str, int n); - int mvwinsstr(WINDOW *win, int y, int x, const char *str); - int mvwinsnstr(WINDOW *win, int y, int x, const char *str, - int n);-
- These routines insert a character string (as many charac- - ters 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 char- - acters on the line being lost. The cursor position does - not change (after moving to y, x, if specified). The four - routines with n as the last argument insert a leading sub- - string of at most n characters. If n<=0, then the entire - string is inserted. - - If a character in str is a tab, newline, carriage return - or backspace, the cursor is moved appropriately within the - window. A newline also does a clrtoeol before moving. - Tabs are considered to be at every eighth column. If a - character in str is another control character, it is drawn - in the ^X notation. Calling winch 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. +NAME
+ insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr, + mvwinsstr, mvwinsnstr - insert string before cursor in a + curses window-RETURN VALUE
- All routines that return an integer return ERR upon fail- - ure and OK (SVr4 specifies only "an integer value other - than ERR") upon successful completion, unless otherwise - noted in the preceding routine descriptions. +SYNOPSIS
+ #include <curses.h> + int insstr(const char *str); + int insnstr(const char *str, int n); + int winsstr(WINDOW *win, const char *str); + int winsnstr(WINDOW *win, const char *str, int n); + int mvinsstr(int y, int x, const char *str); + int mvinsnstr(int y, int x, const char *str, int n); + int mvwinsstr(WINDOW *win, int y, int x, const char *str); + int mvwinsnstr(WINDOW *win, int y, int x, const char *str, + int n);-NOTES
- Note that all but winsnstr may be macros. - +DESCRIPTION
+ These routines insert a character string (as many charac- + ters 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 char- + acters on the line being lost. The cursor position does + not change (after moving to y, x, if specified). The + functions with n as the last argument insert a leading + substring of at most n characters. If n<=0, then the + entire string is inserted. --PORTABILITY
- These functions are described in the XSI Curses standard, - Issue 4, which adds const qualifiers to the arguments. - The XSI Curses error conditions EILSEQ and EILOVERFLOW - associated with extended-level conformance are not yet - detected (this implementation does not yet support XPG4 - multi-byte characters). + Special characters are handled as in addch.-SEE ALSO
- curses(3x), curs_clear(3x), curs_inch(3x). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +RETURN VALUE
+ All routines that return an integer return ERR upon fail- + ure and OK (SVr4 specifies only "an integer value other + than ERR") upon successful completion, unless otherwise + noted in the preceding routine descriptions. + X/Open defines no error conditions. In this implementa- + tion, if the window parameter is null or the str parameter + is null, an error is returned. + Functions with a "mv" prefix first perform a cursor move- + ment using wmove, and return an error if the position is + outside the window, or if the window pointer is null. ++NOTES
+ Note that all but winsnstr may be macros. ++PORTABILITY
+ These functions are described in the XSI Curses standard, + Issue 4, which adds const qualifiers to the arguments. + The Single Unix Specification, Version 2 states that + insnstr and winsnstr perform wrapping. This is probably + an error, since it makes this group of functions inconsis- + tent. Also, no implementation of curses documents this + inconsistency. ++SEE ALSO
+ curses(3x), curs_util(3x), curs_clear(3x), curs_inch(3x). + curs_insstr(3x)-
- -Man(1) output converted with -man2html - +