ncurses 6.2 - patch 20201212
[ncurses.git] / man / wresize.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
3 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" Author: Thomas E. Dickey 1996
31 .\"
32 .\" $Id: wresize.3x,v 1.17 2020/10/17 23:56:38 tom Exp $
33 .TH wresize 3X ""
34 .SH NAME
35 \fBwresize\fR \- resize a curses window
36 .SH SYNOPSIS
37 \fB#include <curses.h>\fR
38 .sp
39 \fBint wresize(WINDOW *\fP\fIwin\fP\fB, int \fP\fIlines\fP\fB, int \fP\fIcolumns\fP\fB);\fR
40 .SH DESCRIPTION
41 This is an extension to the curses library.
42 It reallocates storage for an \fBncurses\fR
43 window to adjust its dimensions to the specified values.
44 If either dimension is larger than the current values, the
45 window's data is filled with blanks that have the current background rendition
46 (as set by \fBwbkgdset\fR) merged into them.
47 .SH RETURN VALUE
48 The function returns the integer \fBERR\fR upon failure and \fBOK\fR on success.
49 It will fail if either of the dimensions less than or equal to zero,
50 or if an error occurs while (re)allocating memory for the window.
51 .SH NOTES
52 The only restriction placed on the dimensions is that they be greater than zero.
53 The dimensions are not compared to \fBcurses\fR screen dimensions to
54 simplify the logic of \fBresizeterm\fR.
55 The caller must ensure that the window's dimensions fit within the
56 actual screen dimensions.
57 .SH PORTABILITY
58 .PP
59 It is not possible to resize windows with SVr4 curses.
60 .PP
61 This extension of ncurses was introduced in mid-1995.
62 It was adopted in NetBSD curses (2001) and PDCurses (2003).
63 .SH SEE ALSO
64 \fBresizeterm\fR(3X).
65 .SH AUTHOR
66 Thomas Dickey (from an equivalent function written in 1988 for BSD curses).