curs_ins_wch.3x - Man Page

insert a curses complex character in a window

Synopsis

#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);

Description

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.

Return Value

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.

Notes

ins_wch, mvins_wch, and mvwins_wch may be implemented as macros.

A terminal's insert_character (ich1) capability is not necessarily employed.

Portability

X/Open Curses Issue 4 describes these functions. It specifies no error conditions for them.

History

These functions were initially specified by X/Open Curses Issue 4 (1995). The System V Interface Definition Version 4 of the same year specified a function named winswch (and the usual variants). This was a later addition to SVr4.x, not appearing in the first SVr4 (1989). It differed from X/Open's later wins_wch in that it took an argument of type chtype instead of cchar_t.

See Also

curs_insch(3X) describes comparable functions in the non-wide-character curses configuration.

curses(3X), terminfo(5)

Referenced By

The man pages ins_wch.3x(3), mvins_wch.3x(3), mvwins_wch.3x(3) and wins_wch.3x(3) are aliases of curs_ins_wch.3x(3).

2025-01-18 ncurses 6.5 Library calls