ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / curs_window.3x.html
1 <!--
2   ****************************************************************************
3   * Copyright 2020,2021 Thomas E. Dickey                                     *
4   * Copyright 1998-2015,2016 Free Software Foundation, Inc.                  *
5   *                                                                          *
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   ****************************************************************************
30   * @Id: curs_window.3x,v 1.23 2021/06/17 21:11:08 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_window 3X</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_window 3X</H1>
43 <PRE>
44 <B><A HREF="curs_window.3X.html">curs_window(3X)</A></B>                                                <B><A HREF="curs_window.3X.html">curs_window(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>newwin</B>, <B>delwin</B>, <B>mvwin</B>, <B>subwin</B>, <B>derwin</B>, <B>mvderwin</B>, <B>dupwin</B>, <B>wsyncup</B>,
51        <B>syncok</B>, <B>wcursyncup</B>, <B>wsyncdown</B> - create <B>curses</B> windows
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;curses.h&gt;</B>
56
57        <B>WINDOW</B> <B>*newwin(</B>
58              <B>int</B> <I>nlines</I><B>,</B> <B>int</B> <I>ncols</I><B>,</B>
59              <B>int</B> <I>begin</I><B>_</B><I>y</I><B>,</B> <B>int</B> <I>begin</I><B>_</B><I>x</I><B>);</B>
60        <B>int</B> <B>delwin(WINDOW</B> <B>*</B><I>win</I><B>);</B>
61        <B>int</B> <B>mvwin(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
62        <B>WINDOW</B> <B>*subwin(WINDOW</B> <B>*</B><I>orig</I><B>,</B>
63              <B>int</B> <I>nlines</I><B>,</B> <B>int</B> <I>ncols</I><B>,</B>
64              <B>int</B> <I>begin</I><B>_</B><I>y</I><B>,</B> <B>int</B> <I>begin</I><B>_</B><I>x</I><B>);</B>
65        <B>WINDOW</B> <B>*derwin(WINDOW</B> <B>*</B><I>orig</I><B>,</B>
66              <B>int</B> <I>nlines</I><B>,</B> <B>int</B> <I>ncols</I><B>,</B>
67              <B>int</B> <I>begin</I><B>_</B><I>y</I><B>,</B> <B>int</B> <I>begin</I><B>_</B><I>x</I><B>);</B>
68        <B>int</B> <B>mvderwin(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>par</I><B>_</B><I>y</I><B>,</B> <B>int</B> <I>par</I><B>_</B><I>x</I><B>);</B>
69        <B>WINDOW</B> <B>*dupwin(WINDOW</B> <B>*</B><I>win</I><B>);</B>
70        <B>void</B> <B>wsyncup(WINDOW</B> <B>*</B><I>win</I><B>);</B>
71        <B>int</B> <B>syncok(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>bool</B> <I>bf</I><B>);</B>
72        <B>void</B> <B>wcursyncup(WINDOW</B> <B>*</B><I>win</I><B>);</B>
73        <B>void</B> <B>wsyncdown(WINDOW</B> <B>*</B><I>win</I><B>);</B>
74
75
76 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
77
78 </PRE><H3><a name="h3-newwin">newwin</a></H3><PRE>
79        Calling <B>newwin</B> creates and returns a pointer to a new window  with  the
80        given  number  of lines and columns.  The upper left-hand corner of the
81        window is at
82               line <I>begin</I>_<I>y</I>,
83               column <I>begin</I>_<I>x</I>
84
85        If either <I>nlines</I> or <I>ncols</I> is zero, they default to
86               <B>LINES</B> <B>-</B> <I>begin</I>_<I>y</I> and
87               <B>COLS</B> <B>-</B> <I>begin</I>_<I>x</I>.
88
89        A new full-screen window is created by calling <B>newwin(0,0,0,0)</B>.
90
91        Regardless of the function  used  for  creating  a  new  window  (e.g.,
92        <B>newwin</B>, <B>subwin</B>, <B>derwin</B>, <B>newpad</B>), rather than a duplicate (with <B>dupwin</B>),
93        all of the window modes are initialized to the default  values.   These
94        functions set window modes after a window is created:
95
96               idcok, idlok, immedok, keypad, leaveok, nodelay, scrollok,
97               setscrreg, syncok, wbkgdset, wbkgrndset, and wtimeout
98
99
100 </PRE><H3><a name="h3-delwin">delwin</a></H3><PRE>
101        Calling <B>delwin</B> deletes the named window, freeing all memory  associated
102        with  it  (it does not actually erase the window's screen image).  Sub-
103        windows must be deleted before the main window can be deleted.
104
105
106 </PRE><H3><a name="h3-mvwin">mvwin</a></H3><PRE>
107        Calling <B>mvwin</B> moves the window so that the upper left-hand corner is at
108        position  (<I>x</I>,  <I>y</I>).   If  the  move would cause the window to be off the
109        screen, it is an error and the window is not moved.  Moving  subwindows
110        is allowed, but should be avoided.
111
112
113 </PRE><H3><a name="h3-subwin">subwin</a></H3><PRE>
114        Calling  <B>subwin</B>  creates and returns a pointer to a new window with the
115        given number of lines, <I>nlines</I>, and columns, <I>ncols</I>.  The  window  is  at
116        position (<I>begin</I>_<I>y</I>, <I>begin</I>_<I>x</I>) on the screen.  The subwindow shares memory
117        with the window <I>orig</I>, so that changes made to one  window  will  affect
118        both  windows.  When using this routine, it is necessary to call <B>touch-</B>
119        <B>win</B> or <B>touchline</B> on <I>orig</I> before calling <B>wrefresh</B> on the subwindow.
120
121
122 </PRE><H3><a name="h3-derwin">derwin</a></H3><PRE>
123        Calling <B>derwin</B> is the same as calling <B>subwin,</B> except that  <I>begin</I>_<I>y</I>  and
124        <I>begin</I>_<I>x</I>  are  relative to the origin of the window <I>orig</I> rather than the
125        screen.  There is no difference between the subwindows and the  derived
126        windows.
127
128        Calling  <B>mvderwin</B> moves a derived window (or subwindow) inside its par-
129        ent window.  The screen-relative  parameters  of  the  window  are  not
130        changed.  This routine is used to display different parts of the parent
131        window at the same physical position on the screen.
132
133
134 </PRE><H3><a name="h3-dupwin">dupwin</a></H3><PRE>
135        Calling <B>dupwin</B> creates an exact duplicate of the window <I>win</I>.
136
137
138 </PRE><H3><a name="h3-wsyncup">wsyncup</a></H3><PRE>
139        Calling <B>wsyncup</B> touches all locations in  ancestors  of  <I>win</I>  that  are
140        changed  in  <I>win</I>.   If  <B>syncok</B> is called with second argument <B>TRUE</B> then
141        <B>wsyncup</B> is called automatically whenever there is a change in the  win-
142        dow.
143
144
145 </PRE><H3><a name="h3-wsyncdown">wsyncdown</a></H3><PRE>
146        The  <B>wsyncdown</B>  routine  touches  each  location  in  <I>win</I> that has been
147        touched in any of its ancestor windows.  This routine is called by <B>wre-</B>
148        <B>fresh</B>, so it should almost never be necessary to call it manually.
149
150
151 </PRE><H3><a name="h3-wcursyncup">wcursyncup</a></H3><PRE>
152        The  routine  <B>wcursyncup</B> updates the current cursor position of all the
153        ancestors of the window to reflect the current cursor position  of  the
154        window.
155
156
157 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
158        Routines that return an integer return the integer <B>ERR</B> upon failure and
159        <B>OK</B> (SVr4 only specifies "an integer value other than  <B>ERR</B>")  upon  suc-
160        cessful completion.
161
162        Routines that return pointers return <B>NULL</B> on error.
163
164        X/Open defines no error conditions.  In this implementation
165
166        <B>delwin</B>
167             returns  an  error if the window pointer is null, or if the window
168             is the parent of another window.
169
170        <B>derwin</B>
171             returns an error if the parent window pointer is null, or  if  any
172             of  its  ordinates  or dimensions is negative, or if the resulting
173             window does not fit inside the parent window.
174
175        <B>dupwin</B>
176             returns an error if the window pointer is null.
177
178             This implementation also maintains a list of windows,  and  checks
179             that  the pointer passed to <B>delwin</B> is one that it created, return-
180             ing an error if it was not..
181
182        <B>mvderwin</B>
183             returns an error if the window pointer is null, or if some part of
184             the window would be placed off-screen.
185
186        <B>mvwin</B>
187             returns  an  error if the window pointer is null, or if the window
188             is really a pad, or if some part of the  window  would  be  placed
189             off-screen.
190
191        <B>newwin</B>
192             will  fail if either of its beginning ordinates is negative, or if
193             either the number of lines or columns is negative.
194
195        <B>syncok</B>
196             returns an error if the window pointer is null.
197
198        <B>subwin</B>
199             returns an error if the parent window pointer is null, or  if  any
200             of  its  ordinates  or dimensions is negative, or if the resulting
201             window does not fit inside the parent window.
202
203        The functions which return a window pointer may also fail if  there  is
204        insufficient  memory  for  its data structures.  Any of these functions
205        will fail if the screen has not been initialized, i.e., with <B>initscr</B> or
206        <B>newterm</B>.
207
208
209 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
210        If  many small changes are made to the window, the <B>wsyncup</B> option could
211        degrade performance.
212
213        Note that <B>syncok</B> may be a macro.
214
215
216 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
217        The subwindow functions (<B>subwin</B>, <B>derwin</B>, <B>mvderwin</B>, <B>wsyncup</B>,  <B>wsyncdown</B>,
218        <B>wcursyncup</B>,  <B>syncok</B>)  are flaky, incompletely implemented, and not well
219        tested.
220
221        The System V curses documentation is very unclear  about  what  <B>wsyncup</B>
222        and  <B>wsyncdown</B>  actually do.  It seems to imply that they are only sup-
223        posed to touch exactly  those  lines  that  are  affected  by  ancestor
224        changes.  The language here, and the behavior of the <B>curses</B> implementa-
225        tion, is patterned on the XPG4 curses standard.  The weaker  XPG4  spec
226        may result in slower updates.
227
228
229 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
230        The XSI Curses standard, Issue 4 describes these functions.
231
232
233 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
234        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_refresh.3X.html">curs_refresh(3X)</A></B>, <B><A HREF="curs_touch.3X.html">curs_touch(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>
235
236
237
238                                                                <B><A HREF="curs_window.3X.html">curs_window(3X)</A></B>
239 </PRE>
240 <div class="nav">
241 <ul>
242 <li><a href="#h2-NAME">NAME</a></li>
243 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
244 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
245 <ul>
246 <li><a href="#h3-newwin">newwin</a></li>
247 <li><a href="#h3-delwin">delwin</a></li>
248 <li><a href="#h3-mvwin">mvwin</a></li>
249 <li><a href="#h3-subwin">subwin</a></li>
250 <li><a href="#h3-derwin">derwin</a></li>
251 <li><a href="#h3-dupwin">dupwin</a></li>
252 <li><a href="#h3-wsyncup">wsyncup</a></li>
253 <li><a href="#h3-wsyncdown">wsyncdown</a></li>
254 <li><a href="#h3-wcursyncup">wcursyncup</a></li>
255 </ul>
256 </li>
257 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
258 <li><a href="#h2-NOTES">NOTES</a></li>
259 <li><a href="#h2-BUGS">BUGS</a></li>
260 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
261 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
262 </ul>
263 </div>
264 </BODY>
265 </HTML>