ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / wresize.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018,2020 Thomas E. Dickey                                     *
4   * Copyright 1998-2010,2015 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   * Author: Thomas E. Dickey 1996
31   * @Id: wresize.3x,v 1.16 2020/02/02 23:34:34 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>wresize 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">wresize 3x</H1>
44 <PRE>
45 <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>                                                        <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>wresize</STRONG> - resize a curses window
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>int</STRONG> <STRONG>wresize(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        This is an extension to the curses library.  It reallocates storage for
62        an <STRONG>ncurses</STRONG> window to adjust its dimensions to the specified values.  If
63        either  dimension  is larger than the current values, the window's data
64        is filled with blanks that have the current  background  rendition  (as
65        set by <STRONG>wbkgdset</STRONG>) merged into them.
66
67
68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
69        The  function  returns  the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on success.
70        It will fail if either of the dimensions less than or equal to zero, or
71        if an error occurs while (re)allocating memory for the window.
72
73
74 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
75        The  only  restriction placed on the dimensions is that they be greater
76        than zero.  The dimensions are not compared to <STRONG>curses</STRONG> screen dimensions
77        to  simplify  the logic of <STRONG>resizeterm</STRONG>.  The caller must ensure that the
78        window's dimensions fit within the actual screen dimensions.
79
80
81 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
82        It is not possible to resize windows with SVr4 curses.
83
84        This extension of ncurses was introduced in mid-1995.  It  was  adopted
85        in NetBSD curses (2001) and PDCurses (2003).
86
87
88 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
89        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>.
90
91
92 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
93        Thomas  Dickey  (from  an  equivalent  function written in 1988 for BSD
94        curses).
95
96
97
98                                                                    <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>
99 </PRE>
100 <div class="nav">
101 <ul>
102 <li><a href="#h2-NAME">NAME</a></li>
103 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
104 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
105 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
106 <li><a href="#h2-NOTES">NOTES</a></li>
107 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
108 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
109 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
110 </ul>
111 </div>
112 </BODY>
113 </HTML>