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