X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_insstr.3x.html;h=becdc103a9ac7392d3c4dc5bf10dd73f8d0aaf26;hp=b169a7950cb2c76c48d05757d91aa5e783998a43;hb=f06e14af5e11df95d6542964bf1b349d2843bb11;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_insstr.3x.html b/doc/html/man/curs_insstr.3x.html index b169a795..becdc103 100644 --- a/doc/html/man/curs_insstr.3x.html +++ b/doc/html/man/curs_insstr.3x.html @@ -1,7 +1,6 @@ - +
+ +- -curs_insstr(3x) curs_insstr(3x) +curs_insstr(3x) curs_insstr(3x) --
+
insstr, insnstr, winsstr, winsnstr, mvinsstr, mvinsnstr, mvwinsstr, mvwinsnstr - insert string before cursor in a curses window --
+
#include <curses.h> int insstr(const char *str); int insnstr(const char *str, int n); @@ -66,64 +64,67 @@ int n); --
- These routines insert a character string (as many charac- - ters as will fit on the line) before the character under +
+ 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. + 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. + Special characters are handled as in addch. --
- 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 + +
+ 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. + + +
Note that all but winsnstr may be macros. --
- 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 - multibyte characters). +
+ 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. --
- curses(3x), curs_clear(3x), curs_inch(3x). + +
+ curses(3x), curs_util(3x), curs_clear(3x), curs_inch(3x). - curs_insstr(3x) + curs_insstr(3x)-