X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_ins_wch.3x.html;h=08ba1f4176c1a4135d1b0efa00b3a1dd1d726856;hb=979d4bf823d05c9c1cb349e6585a0359095aeb3a;hp=27326794e5aa21e99c7ee38d25e6aacb3da47d08;hpb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;p=ncurses.git diff --git a/doc/html/man/curs_ins_wch.3x.html b/doc/html/man/curs_ins_wch.3x.html index 27326794..08ba1f41 100644 --- a/doc/html/man/curs_ins_wch.3x.html +++ b/doc/html/man/curs_ins_wch.3x.html @@ -1,6 +1,6 @@
--curs_ins_wch(3x) curs_ins_wch(3x) +curs_ins_wch(3x) Library calls curs_ins_wch(3x)
- ins_wch, mvins_wch, mvwins_wch, wins_wch - insert a complex character - and rendition into a window + ins_wch, mvins_wch, mvwins_wch, wins_wch - insert a curses complex + character in a window
- #include <curses.h> + #include <curses.h> int ins_wch(const cchar_t *wch); int wins_wch(WINDOW *win, const cchar_t *wch); - int mvins_wch(int y, int x, const cchar_t *wch); int mvwins_wch(WINDOW *win, int y, int x, const cchar_t *wch);
- These routines, insert the complex character wch with rendition before - the character under the cursor. All characters to the right of the - cursor are moved one space to the right, with the possibility of the - rightmost character on the line being lost. The insertion operation - does not change the cursor position. + These functions insert the curses complex character wch at the cursor + in the specified window win (or stdscr). The character previously at + the cursor and any to its right move one cell to the right; the + rightmost character on the line is discarded. The cursor does not + advance.
- If successful, these functions return OK. If not, they return ERR. + These functions return OK on success and ERR on failure. + + Functions taking a WINDOW pointer argument fail if the pointer is NULL. + + Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries. + + +
+ ins_wch, mvins_wch, and mvwins_wch may be implemented as macros. - 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. + A terminal's insert_character (ich1) capability is not necessarily + employed. -
- No errors are defined. +
+ X/Open Curses, Issue 4 describes these functions. + + SVr4 describes successful return values only as "an integer value other + than ERR". + + +
+ SVr4 (1989) implemented these functions under the names inswch, + winswch, mvinswch, and mvwinswch.
- curses(3x), curs_insch(3x). + curs_insch(3x) describes comparable functions in the non-wide-character + curses configuration. + + curses(3x), terminfo(5) - curs_ins_wch(3x) +ncurses 6.5 2024-05-25 curs_ins_wch(3x)