X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_add_wchstr.3x.html;h=ed9a3f20b4fcd13ba7df333d102bdcaf6ccb00b0;hp=0f676ce3a150a8d123fcd1212766bf38ba6bb201;hb=ed646e3f683083e787c6ba773364401dc9fa9d40;hpb=3a935d9991cdf43ebfa952073c9b555f73a3e011 diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html index 0f676ce3..ed9a3f20 100644 --- a/doc/html/man/curs_add_wchstr.3x.html +++ b/doc/html/man/curs_add_wchstr.3x.html @@ -1,7 +1,6 @@ - +
+ +- -curs_add_wchstr(3x) curs_add_wchstr(3x) +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 +
+ 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); @@ -67,65 +64,72 @@ int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int n); --
- These routines copy the array of complex characters wchstr - into the window image structure at and after the current - cursor position. The four routines 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 routines work - faster than waddnstr. On the other hand, they do not per- - form checking (such as for the newline, backspace, or car- - riage return characters), they do not advance the current - cursor position, they do not expand other control charac- - ters to ^-escapes, and they truncate the string if it - crosses the right margin, rather than wrapping it around - to the new line. - - These routines 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. +
+ 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: --
- All functions except wadd_wchnstr may be macros. + o they do not perform checking (such as for the newline, backspace, + or carriage return characters), + o they do not advance the current cursor position, --
- All routines return the integer ERR upon failure and OK on - success. + o they do not expand other control characters to ^-escapes, and - Functions with a "mv" prefix first perform a cursor move- - ment using wmove, and return an error if the position is - outside the window, or if the window pointer is null. + o 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 these entry points are described in the XSI Curses - standard, Issue 4. +
+ All functions return the integer ERR upon failure and OK on success. --
- curses(3x), curs_addchstr(3x), curs_addwstr(3x) + X/Open does not define any error conditions. This implementation re- + turns 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 de- + scribed in curs_addchstr(3x). - curs_add_wchstr(3x) + curs_add_wchstr(3x)-