wins_wch3x
Insert a curses complex character in a window
Part of curs_ins_wch(3x).
Usage
#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);
Overview
wins_wch inserts the curses complex character wch at the cursor position in the window win. The character previously at the cursor and any to its right move one cell to the right; the formerly rightmost character on the line is discarded. Unlike add_wch(3X), wins_wch does not advance the cursor. ncurses(3X) describes the variants of this function.
Return value
These functions return OK on success and ERR on failure.
In ncurses, they return ERR if
•
|
|
|---|---|
•
|
(for functions taking a WINDOW pointer argument) win is a null pointer. |
Functions prefixed with “mv” first perform cursor movement and fail if the position (y, x) is outside the window boundaries.
Notes
ins_wch, mvins_wch, and mvwins_wch may be implemented as macros.
curses does not necessarily employ the terminal's insert_character (ich1) capability to achieve insertion.
Portability
X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.