|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | PORTABILITY | SEE ALSO | COLOPHON |
curs_add_wchstr(3X) curs_add_wchstr(3X)
add_wchstr, add_wchnstr, wadd_wchstr, wadd_wchnstr, mvadd_wchstr,
mvadd_wchnstr, mvwadd_wchstr, mvwadd_wchnstr - add an array of
complex characters (and attributes) to a curses window
#include <curses.h>
int add_wchstr(const cchar_t *wchstr);
int add_wchnstr(const cchar_t *wchstr, int n);
int wadd_wchstr(WINDOW * win, const cchar_t *wchstr);
int wadd_wchnstr(WINDOW * win, const cchar_t *wchstr, int n);
int mvadd_wchstr(int y, int x, const cchar_t *wchstr);
int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);
int mvwadd_wchstr(WINDOW *win, int y, int x, const cchar_t *wchstr);
int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int n);
These functions copy the (null-terminated) array of complex
characters wchstr into the window image structure starting at the
current cursor position. The four functions with n as the last
argument copy at most n elements, but no more than will fit on the
line. If n=-1 then the whole array is copied, to the maximum number
of characters that will fit on the line.
The window cursor is not advanced. These functions work faster than
waddnstr. On the other hand:
· they do not perform checking (such as for the newline, backspace,
or carriage return characters),
· they do not advance the current cursor position,
· they do not expand other control characters to ^-escapes, and
· they truncate the string if it crosses the right margin, rather
than wrapping it around to the new line.
These functions end successfully on encountering a null cchar_t, or
when they have filled the current line. If a complex character
cannot completely fit at the end of the current line, the remaining
columns are filled with the background character and rendition.
All functions return the integer ERR upon failure and OK on success.
X/Open does not define any error conditions. This implementation
returns an error if the window pointer is null.
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.
All functions except wadd_wchnstr may be macros.
These entry points are described in the XSI Curses standard, Issue 4.
curs_addwstr(3X), curses(3X).
Comparable functions in the narrow-character (ncurses) library are
described in curs_addchstr(3X).
This page is part of the ncurses (new curses) project. Information
about the project can be found at
⟨https://www.gnu.org/software/ncurses/ncurses.html⟩. If you have a
bug report for this manual page, send it to
bug-ncurses-request@gnu.org. This page was obtained from the
project's upstream Git mirror of the CVS repository
⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2017-07-05. If you
discover any rendering problems in this HTML version of the page, or
you believe there is a better or more up-to-date source for the page,
or you have corrections or improvements to the information in this
COLOPHON (which is not part of the original manual page), send a mail
to man-pages@man7.org
curs_add_wchstr(3X)