X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_ins_wch.3x.html;h=5ab6a01189f8fdeb90d2c9991bd56b9c2153396f;hb=HEAD;hp=ec9b685018d0f72348c185eb4fedf11ab5f596d8;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;p=ncurses.git diff --git a/doc/html/man/curs_ins_wch.3x.html b/doc/html/man/curs_ins_wch.3x.html index ec9b6850..7c25b2ed 100644 --- a/doc/html/man/curs_ins_wch.3x.html +++ b/doc/html/man/curs_ins_wch.3x.html @@ -1,6 +1,7 @@ -
- --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 com- - plex 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); + 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 ren- - dition before the character under the cursor. All charac- - ters 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 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. + 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. --
- No errors are defined. +
+ A terminal's insert_character (ich1) capability is not necessarily + employed. --
- curses(3x), curs_insch(3x). + ins_wch, mvins_wch, and mvwins_wch may be implemented as macros. + + +
+ 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. + + +
+ 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-04-20 curs_ins_wch(3x)