X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_add_wchstr.3x.html;h=8d7b7c2c1a7b42afbab7be473a39461e7249ad0c;hb=979d4bf823d05c9c1cb349e6585a0359095aeb3a;hp=c3f2ca1a081bf9327565b19e3a4eaeb9a372b61a;hpb=9f479192e3ca3413d235c66bf058f8cc63764898;p=ncurses.git diff --git a/doc/html/man/curs_add_wchstr.3x.html b/doc/html/man/curs_add_wchstr.3x.html index c3f2ca1a..8d7b7c2c 100644 --- a/doc/html/man/curs_add_wchstr.3x.html +++ b/doc/html/man/curs_add_wchstr.3x.html @@ -1,6 +1,6 @@ -curs_add_wchstr 3X +curs_add_wchstr 3x 2024-05-11 ncurses 6.5 Library calls - + -

curs_add_wchstr 3X

curs_add_wchstr 3x 2024-05-11 ncurses 6.5 Library calls

-curs_add_wchstr(3X)                                        curs_add_wchstr(3X)
+curs_add_wchstr(3x)              Library calls             curs_add_wchstr(3x)

NAME

-       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  a  curses  complex
+       character string to a window

SYNOPSIS

-       #include <curses.h>
+       #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 add_wchstr(const cchar_t *wchstr);
+       int wadd_wchstr(WINDOW * win, const cchar_t *wchstr);
+       int mvadd_wchstr(int y, int x, const cchar_t *wchstr);
+       int mvwadd_wchstr(WINDOW *win, int y, int x, const cchar_t *wchstr);
 
-       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);
+       int add_wchnstr(const cchar_t *wchstr, int n);
+       int wadd_wchnstr(WINDOW * win, const cchar_t *wchstr, int n);
+       int mvadd_wchnstr(int y, int x, const cchar_t *wchstr, int n);
+       int mvwadd_wchnstr(WINDOW *win, int y, int x, const cchar_t *wchstr, int n);

DESCRIPTION

-       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:
+       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.
 
-       o   they  do  not perform checking (such as for the newline, backspace,
-           or carriage return characters),
+       Because  these  functions do not call wadd_wch(3x) internally, they are
+       faster than waddwstr(3x) and waddnwstr(3x).  On the other hand, they
 
-       o   they do not advance the current cursor position,
+       o   do  not  treat  the  backspace,  carriage  return,  or  line   feed
+           characters specially;
 
-       o   they do not expand other control characters to ^-escapes, and
+       o   do not represent unprintable characters with wunctrl(3x);
 
-       o   they truncate the string if it crosses  the  right  margin,  rather
-           than wrapping it around to the new line.
+       o   do  not  update  the  cursor  position to follow the last character
+           written;
 
-       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.

RETURN VALUE

-       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.  ncurses returns
+       ERR if
+
+       o   win is NULL or
 
-       X/Open does not define any error conditions.  This  implementation  re-
-       turns an error if the window pointer is null.
+       o   wchstr 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.
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

-       All functions except wadd_wchnstr may be macros.
+       All  of  these  functions  except  wadd_wchnstr  may  be implemented as
+       macros.

PORTABILITY

-       These entry points are described in the XSI Curses standard, Issue 4.
+       X/Open Curses, Issue 4 describes these functions.