X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_add_wchstr.3x.html;h=8d7b7c2c1a7b42afbab7be473a39461e7249ad0c;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=aa3ebaf5245ef9c42b467b200bdf5f223b545f57;hpb=00dd248b527ad47f0fc3b0776a0889da0ac926d0;p=ncurses.git diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html index aa3ebaf5..8d7b7c2c 100644 --- a/doc/html/man/curs_add_wchstr.3x.html +++ b/doc/html/man/curs_add_wchstr.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_add_wchstr.3x,v 1.39 2024/04/20 21:20:07 tom Exp @ + * @Id: curs_add_wchstr.3x,v 1.40 2024/05/11 20:39:53 tom Exp @ -->
-curs_add_wchstr(3x) Library calls curs_add_wchstr(3x) @@ -67,53 +67,50 @@
- These functions copy the (null-terminated) array of complex characters - wchstr into the window image structure starting at the current cursor - position. + wadd_wchstr copies the string of complex characters wchstr to the + window win. A null complex character terminates the string. If a + complex character does completely fit at the end of the line, curses + fills the remaining columns with the window background; see bkgrnd(3x). + wadd_wchnstr does the same, but copies at most n characters, or as many + as possible if n is -1. ncurses(3x) describes the variants of these + functions. - 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. + Because these functions do not call wadd_wch(3x) internally, they are + faster than waddwstr(3x) and waddnwstr(3x). On the other hand, they - The window cursor is not advanced. These functions are faster than - waddnstr. On the other hand: + o do not treat the backspace, carriage return, or line feed + characters specially; - o they do not perform checking (such as for the newline, backspace, - or carriage return characters), + o do not represent unprintable characters with wunctrl(3x); - o they do not advance the current cursor position, + o do not update the cursor position to follow the last character + written; - o they do not expand other control characters to ^-escapes, and - - 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. + o truncate the string at the window's right margin, rather than + wrapping it to the next line and potentially scrolling.
- All functions return the integer ERR upon failure and OK on success. + These functions return OK on success and ERR on failure. - X/Open Curses does not specify any error conditions. This - implementation returns an error + X/Open Curses does not specify any error conditions. ncurses returns + ERR if - o if the win parameter is null or + o win is NULL or - o if the wchstr parameter is null. + o wchstr is NULL. Functions prefixed with "mv" first perform cursor movement and fail if the position (y, x) is outside the window boundaries.
- All functions except wadd_wchnstr may be macros. + All of these functions except wadd_wchnstr may be implemented as + macros.
- These functions are described in X/Open Curses, Issue 4. + X/Open Curses, Issue 4 describes these functions.
@@ -124,7 +121,7 @@ -ncurses 6.4 2024-04-20 curs_add_wchstr(3x) +ncurses 6.5 2024-05-11 curs_add_wchstr(3x)