blob: 7c25b2ed7e9d8c9060174186ac62e5207ad31c63 [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -04001<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05302 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -04003 * Copyright 2019-2023,2024 Thomas E. Dickey *
4 * Copyright 2002-2010,2017 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05305 * *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
28 * authorization. *
29 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -040030 * @Id: curs_ins_wch.3x,v 1.30 2024/04/20 19:18:18 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053031-->
Steve Kondikae271bc2015-11-15 02:50:53 +010032<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053033<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +010035<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
micky3879b9f5e72025-07-08 18:04:53 -040036<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37<TITLE>curs_ins_wch 3x 2024-04-20 ncurses 6.5 Library calls</TITLE>
38<link rel="author" href="mailto:bug-ncurses@gnu.org">
39
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053040</HEAD>
41<BODY>
micky3879b9f5e72025-07-08 18:04:53 -040042<H1 class="no-header">curs_ins_wch 3x 2024-04-20 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053043<PRE>
micky3879b9f5e72025-07-08 18:04:53 -040044<STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053045
46
47
48
micky3879b9f5e72025-07-08 18:04:53 -040049</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>ins_wch</STRONG>, <STRONG>mvins_wch</STRONG>, <STRONG>mvwins_wch</STRONG>, <STRONG>wins_wch</STRONG> - insert a <EM>curses</EM> complex
51 character in a window
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053052
53
micky3879b9f5e72025-07-08 18:04:53 -040054</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053056
57 <STRONG>int</STRONG> <STRONG>ins_wch(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -040058 <STRONG>int</STRONG> <STRONG>wins_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>mvins_wch(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>mvwins_wch(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>wch</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053061
62
micky3879b9f5e72025-07-08 18:04:53 -040063</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64 These functions insert the <EM>curses</EM> complex character <EM>wch</EM> at the cursor
65 in the specified window <EM>win</EM> (or <STRONG>stdscr</STRONG>). The character previously at
66 the cursor and any to its right move one cell to the right; the
67 rightmost character on the line is discarded. The cursor does not
68 advance.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053069
70
micky3879b9f5e72025-07-08 18:04:53 -040071</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72 These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053073
micky3879b9f5e72025-07-08 18:04:53 -040074 Functions taking a <EM>WINDOW</EM> pointer argument fail if the pointer is <STRONG>NULL</STRONG>.
75
76 Functions prefixed with "mv" first perform cursor movement and fail if
77 the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
Steve Kondikae271bc2015-11-15 02:50:53 +010078
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053079
micky3879b9f5e72025-07-08 18:04:53 -040080</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
81 A terminal's <STRONG>insert_character</STRONG> (<STRONG>ich1</STRONG>) capability is not necessarily
82 employed.
83
84 <STRONG>ins_wch</STRONG>, <STRONG>mvins_wch</STRONG>, and <STRONG>mvwins_wch</STRONG> may be implemented as macros.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053085
86
micky3879b9f5e72025-07-08 18:04:53 -040087</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
88 X/Open Curses, Issue 4 describes these functions.
89
90 SVr4 describes successful return values only as "an integer value other
91 than <STRONG>ERR</STRONG>".
92
93
94</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
95 SVr4 (1989) implemented these functions under the names <STRONG>inswch</STRONG>,
96 <STRONG>winswch</STRONG>, <STRONG>mvinswch</STRONG>, and <STRONG>mvwinswch</STRONG>.
97
98
99</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
100 <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG> describes comparable functions in the non-wide-character
101 <EM>curses</EM> configuration.
102
103 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530104
105
106
micky3879b9f5e72025-07-08 18:04:53 -0400107ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530108</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100109<div class="nav">
110<ul>
111<li><a href="#h2-NAME">NAME</a></li>
112<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
113<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
114<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
micky3879b9f5e72025-07-08 18:04:53 -0400115<li><a href="#h2-NOTES">NOTES</a></li>
116<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
117<li><a href="#h2-HISTORY">HISTORY</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100118<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
119</ul>
120</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530121</BODY>
122</HTML>