X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_add_wchstr.3x.html;h=0e681db9a68c4c69bbf2c22efd559fad1921678a;hp=343a69b80a60731bea2667ea4fba4a62731dd487;hb=2a32bee362db64f5a06b2124976b928ac3faa578;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html index 343a69b8..0e681db9 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, +
+ 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,61 +65,77 @@ 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 then 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 +
+ These functions copy the (null-terminated) array of com- + plex characters wchstr into the window image structure + starting at the current cursor position. The four func- + tions 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: + + 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, + + o they do not expand other control characters to ^-es- + capes, and + + o they truncate the string if it crosses the right mar- + gin, 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 except wadd_wchnstr may be macros. +
+ All functions return the integer ERR upon failure and OK + on success. + X/Open does not define any error conditions. This imple- + mentation returns an error if the window pointer is null. --
- All routines return the integer ERR upon failure and OK on - success. + 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. --
- All these entry points are described in the XSI Curses - standard, Issue 4. +
+ All functions except wadd_wchnstr may be macros. --
- curses(3x), curs_addchstr(3x) curs_addwstr(3x) +
+ These entry points are described in the XSI Curses stan- + dard, Issue 4. + + +
+ curs_addwstr(3x), curses(3x). + + Comparable functions in the narrow-character (ncurses) li- + brary are described in curs_addchstr(3x). - curs_add_wchstr(3x) + curs_add_wchstr(3x)-