X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_ins_wstr.3x.html;h=200264c5200d1c6d7877cbc4a658358be8240852;hb=75a9c36c205ebefe07580acd0b1053a2abbd44b9;hp=11f6636d0366f78003b6314bfa1f6708022ad6e4;hpb=f79c210479470378389aab5b8d4d42d4a7f3d9a4;p=ncurses.git diff --git a/doc/html/man/curs_ins_wstr.3x.html b/doc/html/man/curs_ins_wstr.3x.html index 11f6636d..200264c5 100644 --- a/doc/html/man/curs_ins_wstr.3x.html +++ b/doc/html/man/curs_ins_wstr.3x.html @@ -1,6 +1,6 @@
-curs_ins_wstr(3x) Library calls curs_ins_wstr(3x) @@ -47,15 +47,15 @@
- ins_wstr, ins_nwstr, wins_wstr, wins_nwstr, mvins_wstr, mvins_nwstr, - mvwins_wstr, mvwins_nwstr - insert a wide-character string into a - curses window + ins_wstr, ins_nwstr, wins_wstr, wins_nwstr, mvins_wstr, mvins_nwstr, + mvwins_wstr, mvwins_nwstr - insert a wide-character string in a curses + window
#include <curses.h> - int ins_wstr(const wchar_t *wstr); + int ins_wstr(const wchar_t *wstr); int ins_nwstr(const wchar_t *wstr, int n); int wins_wstr(WINDOW *win, const wchar_t *wstr); int wins_nwstr(WINDOW *win, const wchar_t *wstr, int n); @@ -68,55 +68,73 @@
These routines insert a wchar_t character string (as many characters as - will fit on the line) before the character under the cursor. All char- - acters to the right of the cursor are shifted right, with the possibil- - ity of the rightmost characters on the line being lost. No wrapping is - performed. 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 substring of at most n wchar_t characters. If n is less than - 1, the entire string is inserted. - - If a character in wstr 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 wstr is another control character, it - is drawn in the ^X notation. Calling win_wch 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. + will fit on the line) before the character under the cursor, as if + calling wins_wch(3x). All characters to the right of the cursor are + shifted right, with the possibility of the rightmost characters on the + line being lost. No wrapping is performed. + + 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 wchar_t characters. If n is less than zero, the entire + string is inserted (stopping on a L'\0' character). + + Special characters are handled as in wadd_wch(3x). + + +
+ All functions return the integer ERR upon failure and OK on success. + + X/Open Curses does not specify any error conditions. This + implementation returns an error + + o if the win parameter is null or + + o if the wstr parameter is null or + + o if the wins_wch function returns an error. + + Functions with a "mv" prefix first perform a cursor movement using + wmove(3x), and return an error if the position is outside the window, + or if the window pointer is null.
- Note that all but wins_nwstr may be macros. + All but wins_nwstr may be macros. - If the first character in the string is a nonspacing character, these + If the first character in the string is a non-spacing character, these functions will fail. XSI does not define what will happen if a non- spacing character follows a control character. -
- Upon successful completion, these functions return OK. Otherwise, they - return ERR. +
+ These functions are described in the XSI Curses standard, Issue 4, + which adds const qualifiers to the arguments. - Functions with a "mv" prefix first perform a cursor movement using - wmove, and return an error if the position is outside the window, or if - the window pointer is null. + X/Open states that the entire string is inserted if n is less than 1. + This is probably an error, because it is inconsistent with other + functions, and differs from the X/Open implementation on Solaris.
- curses(3x), curs_insstr(3x), curs_in_wch(3x), curs_ins_wch(3x). + curs_insstr(3x) describes comparable functions of the ncurses library + in its non-wide-character configuration. + curses(3x), curs_ins_wch(3x), curs_in_wch(3x) -ncurses 6.4 2022-02-12 curs_ins_wstr(3x) + +ncurses 6.4 2024-04-13 curs_ins_wstr(3x)