cursaddwch(3X) cursaddwch(3X)
NAME
addwch, waddwch, mvaddwch, mvwaddwch, echowchar, wechowchar - add
a complex character and rendition to a curses window, then advance the
cursor
SYNOPSIS
##include <>
int addwch( const cchart **wch );;
int waddwch( WINDOW **win,, const cchart **wch );;
int mvaddwch( int y,, int x,, const cchart **wch );;
int mvwaddwch( WINDOW **win,, int y,, int x,, const cchart **wch );;
int echowchar( const cchart **wch );;
int wechowchar( WINDOW **win,, const cchart **wch );;
DESCRIPTION
The addwch, waddwch, mvaddwch, and mvwaddwch functions put the com-
plex character wch into the given window at its current position, which
is then advanced. These functions perform wrapping and special-charac-
ter processing as follows:
- If wch refers to a spacing character, then any previous character
at that location is removed. A new character specified by wch is
placed at that location with rendition specified by wch. The cur-
sor 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 complex character, and the rendition
specified by wch is ignored.
- If the character part of wch is a tab, newline, backspace or other
control character, the window is updated and the cursor moves as
if addch(3X) were called.
The echowchar function is functionally equivalent to a call to addwch
followed by a call to refresh. Similarly, the wechowchar is function-
ally equivalent to a call to waddwch followed by a call to wrefresh.
The knowledge that only a single character is being output is taken
into consideration and, for non-control characters, a considerable per-
formance gain might be seen by using the *echo* functions instead of
their equivalents.
RETURN VALUES
All routines return the integer ER upon failure and OK on success.
NOTES
Note that addwch, mvaddwch, mvwaddwch, and echowchar may be macros.
PORTABILITY
All these functions are described in the XSI Curses standard, 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), cursattrget(3X), cursclear(3X), cursoutopts(3X),
cursrefresh(3X), putwc(3)
cursaddwch(3X)
|