X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_ins_wch.3x.html;h=5ab6a01189f8fdeb90d2c9991bd56b9c2153396f;hb=HEAD;hp=6dd267cf5f100d7eafbbc89c09957d5d7f38b839;hpb=9f479192e3ca3413d235c66bf058f8cc63764898;p=ncurses.git diff --git a/doc/html/man/curs_ins_wch.3x.html b/doc/html/man/curs_ins_wch.3x.html index 6dd267cf..08ba1f41 100644 --- a/doc/html/man/curs_ins_wch.3x.html +++ b/doc/html/man/curs_ins_wch.3x.html @@ -1,6 +1,6 @@ -curs_ins_wch 3X +curs_ins_wch 3x 2024-05-25 ncurses 6.5 Library calls - + -

curs_ins_wch 3X

curs_ins_wch 3x 2024-05-25 ncurses 6.5 Library calls

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

NAME

-       ins_wch,  mvins_wch,  mvwins_wch, wins_wch - insert a complex character
-       and rendition into a window
+       ins_wch,  mvins_wch,  mvwins_wch,  wins_wch  -  insert a curses complex
+       character in a window

SYNOPSIS

-       #include <curses.h>
-
-       int ins_wch(const cchar_t *wch);
-       int wins_wch(WINDOW *win, const cchar_t *wch);
+       #include <curses.h>
 
-       int mvins_wch(int y, int x, const cchar_t *wch);
-       int mvwins_wch(WINDOW *win, int y, int x, const cchar_t *wch);
+       int ins_wch(const cchar_t *wch);
+       int wins_wch(WINDOW *win, const cchar_t *wch);
+       int mvins_wch(int y, int x, const cchar_t *wch);
+       int mvwins_wch(WINDOW *win, int y, int x, const cchar_t *wch);

DESCRIPTION

-       These routines, insert the complex character wch with rendition  before
-       the  character  under  the  cursor.  All characters to the right of the
-       cursor are moved one space to the right, with the  possibility  of  the
-       rightmost  character  on  the line being lost.  The insertion operation
-       does not change the cursor position.
+       These functions insert the curses complex character wch at  the  cursor
+       in  the  specified window win (or stdscr).  The character previously at
+       the cursor and any to its  right  move  one  cell  to  the  right;  the
+       rightmost  character  on  the  line  is discarded.  The cursor does not
+       advance.

RETURN VALUE

-       If successful, these functions return OK.  If not, they return ERR.
+       These functions return OK on success and ERR on failure.
+
+       Functions taking a WINDOW pointer argument fail if the pointer is NULL.
+
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
+
 
-       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.
+

NOTES

+       ins_wch, mvins_wch, and mvwins_wch may be implemented as macros.
 
+       A  terminal's  insert_character  (ich1)  capability  is not necessarily
+       employed.
 
-

ERRORS

-       No errors are defined.
+
+

PORTABILITY

+       X/Open Curses, Issue 4 describes these functions.
+
+       SVr4 describes successful return values only as "an integer value other
+       than ERR".
+
+
+

HISTORY

+       SVr4  (1989)  implemented  these  functions  under  the  names  inswch,
+       winswch, mvinswch, and mvwinswch.