X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_ins_wstr.3x.html;h=fa4289381f561612e91864f696717fccdf674c1f;hp=c2a128c2d7ba1b77a88fc25f9bd41b6fb7f862f3;hb=HEAD;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_ins_wstr.3x.html b/doc/html/man/curs_ins_wstr.3x.html index c2a128c2..f2982eaa 100644 --- a/doc/html/man/curs_ins_wstr.3x.html +++ b/doc/html/man/curs_ins_wstr.3x.html @@ -1,7 +1,7 @@ - - + -curs_ins_wstr 3x - - + + +curs_ins_wstr 3x 2024-04-20 ncurses 6.5 Library calls + + -

curs_ins_wstr 3x

-
+

curs_ins_wstr 3x 2024-04-20 ncurses 6.5 Library calls

-
-curs_ins_wstr(3x)                               curs_ins_wstr(3x)
+curs_ins_wstr(3x)                Library calls               curs_ins_wstr(3x)
 
 
 
 
-
-

NAME

-       ins_wstr,  ins_nwstr,  wins_wstr,  wins_nwstr, mvins_wstr,
-       mvins_nwstr, mvwins_wstr, mvwins_nwstr -  insert  a  wide-
-       character string into a curses window
+

NAME

+       ins_wstr,  ins_nwstr,  wins_wstr,  wins_nwstr, mvins_wstr, mvins_nwstr,
+       mvwins_wstr, mvwins_nwstr - insert a wide-character string in a  curses
+       window
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
-       int ins_wstr(const wchar_t *wstr);
+       int ins_wstr(const wchar_t *wstr);
        int ins_nwstr(const wchar_t *wstr, int n);
        int wins_wstr(WINDOW *win, const wchar_t *wstr);
        int wins_nwstr(WINDOW *win, const wchar_t *wstr, int n);
+
        int mvins_wstr(int y, int x, const wchar_t *wstr);
        int mvins_nwstr(int y, int x, const wchar_t *wstr, int n);
        int mvwins_wstr(WINDOW *win, int y, int x, const wchar_t *wstr);
        int mvwins_nwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);
 
 
-
-

DESCRIPTION

-       These  routines insert a wchar_t character string (as many
-       characters as will fit on the line) before  the  character
-       under the cursor.  All characters to the right of the cur-
-       sor are shifted right, with the possibility of the  right-
-       most  characters  on  the line being lost.  No wrapping is
-       performed.  The cursor position  does  not  change  (after
-       moving  to  y, x, if specified).  The four routines with n
-       as the last argument insert a leading substring of at most
-       n  wchar_t  characters.   If  n is less than 1, the entire
-       string is inserted.
-
-       If a character in wstr is a tab, newline, carriage  return
-       or backspace, the cursor is moved appropriately within the
-       window.  A newline also does  a  clrtoeol  before  moving.
-       Tabs  are  considered  to be at every eighth column.  If a
-       character in wstr is  another  control  character,  it  is
-       drawn  in the ^X notation.  Calling win_wch after adding a
-       control character (and moving to it,  if  necessary)  does
-       not  return  the  control character, but instead returns a
-       character in the ^-representation of the  control  charac-
-       ter.
+

DESCRIPTION

+       These routines insert a wchar_t character string (as many characters as
+       will fit on the line) before the character  under  the  cursor,  as  if
+       calling  wins_wch(3x).   All  characters to the right of the cursor are
+       shifted right, with the possibility of the rightmost characters on  the
+       line being lost.  No wrapping is performed.
 
+       The  cursor  position  does  not  change  (after  moving  to  y,  x, if
+       specified).
 
-
-

NOTES

-       Note that all but wins_nwstr may be macros.
+       The functions with n as the last argument insert a leading substring of
+       at  most  n  wchar_t  characters.   If  n is less than zero, the entire
+       string is inserted (stopping on a L'\0' character).
 
-       If the first character in the string is a nonspacing char-
-       acter, these functions will fail.   XSI  does  not  define
-       what  will happen if a nonspacing character follows a con-
-       trol character.
+       Special characters are handled as in wadd_wch(3x).
 
 
-
-

RETURN VALUES

-       Upon successful completion,  these  functions  return  OK.
-       Otherwise, they return ERR.
+

RETURN VALUE

+       All functions return the integer ERR upon failure and OK on success.
 
+       X/Open  Curses  does  not   specify   any   error   conditions.    This
+       implementation returns an error
 
-
-

SEE ALSO

-       curses(3x),        curs_insstr(3x),       curs_in_wch(3x),
-       curs_ins_wch(3x).
+       o   if the win parameter is null or
+
+       o   if the wstr parameter is null or
+
+       o   if the wins_wch function returns an error.
+
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.
+
+
+

NOTES

+       All but wins_nwstr may be macros.
+
+       If the first character in the string is a non-spacing character,  these
+       functions will fail.  X/Open Curses does not define what will happen if
+       a non-spacing character follows a control character.
+
+
+

PORTABILITY

+       These functions are described in X/Open Curses,  Issue  4,  which  adds
+       const qualifiers to the arguments.
+
+       X/Open  states  that the entire string is inserted if n is less than 1.
+       This is probably an  error,  because  it  is  inconsistent  with  other
+       functions, and differs from the X/Open implementation on Solaris.
+
+
+

SEE ALSO

+       curs_insstr(3x)  describes  comparable functions of the ncurses library
+       in its non-wide-character configuration.
+
+       curses(3x), curs_ins_wch(3x), curs_in_wch(3x)
 
 
 
-                                                curs_ins_wstr(3x)
+ncurses 6.5                       2024-04-20                 curs_ins_wstr(3x)
 
-
-
-Man(1) output converted with -man2html -
+