ncurses 6.1 - patch 20190406
[ncurses.git] / man / curs_ins_wch.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 2002-2010,2017 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_ins_wch.3x,v 1.6 2017/11/21 00:53:44 tom Exp $
30 .TH curs_ins_wch 3X ""
31 .SH NAME
32 \fBins_wch\fR,
33 \fBmvins_wch\fR,
34 \fBmvwins_wch\fR,
35 \fBwins_wch\fR \- insert a complex character and rendition into a window
36 .SH SYNOPSIS
37 #include <curses.h>
38 .sp
39 \fBint ins_wch(const cchar_t *\fR\fIwch\fR\fB);\fR
40 .br
41 \fBint wins_wch(WINDOW *\fR\fIwin, const cchar_t *\fR\fIwch\fR\fB);\fR
42 .br
43 \fBint mvins_wch(int \fR\fIy, int \fR\fIx, const cchar_t *\fR\fIwch\fR\fB);\fR
44 .br
45 \fBint mvwins_wch(WINDOW *\fR\fIwin, int \fR\fIy, int \fR\fIx, const cchar_t *\fR\fIwch\fR\fB);\fR
46 .SH DESCRIPTION
47 These routines, insert the complex character \fIwch\fR with rendition
48 before the character under the cursor.
49 All characters to the right of the cursor are moved one space to the right,
50 with the possibility of the rightmost character on the line being lost.
51 The insertion operation does not change the cursor position.
52 .SH RETURN VALUE
53 If successful, these functions return \fBOK\fP.
54 If not, they return \fBERR\fP.
55 .PP
56 Functions with a "mv" prefix first perform a cursor movement using
57 \fBwmove\fP, and return an error if the position is outside the window,
58 or if the window pointer is null.
59 .SH ERRORS
60 No errors are defined.
61 .SH SEE ALSO
62 \fBcurses\fR(3X),
63 \fBcurs_insch\fR(3X).