X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_insch.3x.html;h=12edc6cd880ddf9cf9c15dd9c0ef4d03455d20b5;hp=ad192dc3e89f1a45a22f59534fa90c1a5153321a;hb=HEAD;hpb=9f479192e3ca3413d235c66bf058f8cc63764898 diff --git a/doc/html/man/curs_insch.3x.html b/doc/html/man/curs_insch.3x.html index ad192dc3..5f60c67c 100644 --- a/doc/html/man/curs_insch.3x.html +++ b/doc/html/man/curs_insch.3x.html @@ -1,6 +1,6 @@
--curs_insch(3X) curs_insch(3X) +curs_insch(3x) Library calls curs_insch(3x)
- insch, winsch, mvinsch, mvwinsch - insert a character before cursor in - a curses window + insch, winsch, mvinsch, mvwinsch - insert a curses character in a + window
- #include <curses.h> - - int insch(chtype ch); - int winsch(WINDOW *win, chtype ch); + #include <curses.h> - int mvinsch(int y, int x, chtype ch); - int mvwinsch(WINDOW *win, int y, int x, chtype ch); + int insch(chtype ch); + int winsch(WINDOW *win, chtype ch); + int mvinsch(int y, int x, chtype ch); + int mvwinsch(WINDOW *win, int y, int x, chtype ch);
- These routines insert the character ch 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 character ch 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.
- All routines that return an integer return ERR upon failure and OK - (SVr4 specifies only "an integer value other than ERR") upon successful - completion, unless otherwise noted in the preceding routine - descriptions. + These functions return OK on success and ERR on failure. - 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. + 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.
- These routines do not necessarily imply use of a hardware insert - character feature. + insch, mvinsch, and mvwinsch may be implemented as macros. - Note that insch, mvinsch, and mvwinsch may be macros. + A terminal's insert_character (ich1) capability is not necessarily + employed.
- These functions are described in the XSI Curses standard, Issue 4. + X/Open Curses, Issue 4 describes these functions. + + SVr4 curses describes a successful return value only as "an integer + value other than ERR".
- curses(3X). + curs_ins_wch(3x) describes comparable functions in the wide-character + curses configuration. - Comparable functions in the wide-character (ncursesw) library are - described in curs_ins_wch(3X). + curses(3x), terminfo(5) - curs_insch(3X) +ncurses 6.5 2024-04-20 curs_insch(3x)