Miscellaneous Library Functions curs_add_wch(3X)
NAME
add_wch, wadd_wch, mvadd_wch, mvwadd_wch, echo_wchar,
wecho_wchar - add a complex character and rendition to a
curses window, then advance the cursorSYNOPSIS
#include
int add_wch( const cchar_t *wch );
int wadd_wch( WINDOW *win, const cchar_t *wch );
int mvadd_wch( int y, int x, const cchar_t *wch );
int mvwadd_wch( WINDOW *win, int y, int x, const cchar_t
*wch );int echo_wchar( const cchar_t *wch );
int wecho_wchar( WINDOW *win, const cchar_t *wch );
DESCRIPTION
The add_wch, wadd_wch, mvadd_wch, and mvwadd_wch functions
put the complex character wch into the given window at its current position, which is then advanced. These functionsperform wrapping and special-character processing as fol-
lows:- If wch refers to a spacing character, then any previous
character at that location is removed. A new characterspecified by wch is placed at that location with rendi-
tion specified by wch. The cursor then advances to the next spacing character on the screen.- If wch refers to a non-spacing character, all previous
characters at that location are preserved. The non-
spacing characters of wch are added to the spacing com-
plex character, and the rendition specified by wch is ignored.- If the character part of wch is a tab, newline, back-
space or other control character, the window is updated and the cursor moves as if addch were called.The echo_wchar function is functionally equivalent to a call
to add_wch followed by a call to refresh. Similarly, the
wecho_wchar is functionally equivalent to a call to wadd_wch
followed by a call to wrefresh. The knowledge that only a single character is being output is taken into considerationand, for non-control characters, a considerable performance
gain might be seen by using the *echo* functions instead of their equivalents.RETURN VALUES
All routines return the integer ERR upon failure and OK on success. SunOS 5.10 Last change: 1Miscellaneous Library Functions curs_add_wch(3X)
NOTESNote that add_wch, mvadd_wch, mvwadd_wch, and echo_wchar may
be macros. PORTABILITYAll these functions are described in the XSI Curses stan-
dard, Issue 4. The defaults specified for forms-drawing
characters apply in the POSIX locale.XSI documents constants beginning with WACS_ which are used
for line-drawing. Those are not currently implemented in
ncurses.SEE ALSO
curses(3X), curs_addch(3X), curs_attr(3X), curs_clear(3X),
curs_outopts(3X), curs_refresh(3X), putwc(3)
SunOS 5.10 Last change: 2