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