2 ****************************************************************************
3 * Copyright (c) 1998-2012,2013 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************
29 * Author: Thomas E. Dickey 1996-on
30 * @Id: resizeterm.3x,v 1.17 2013/06/22 20:41:54 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>resizeterm 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1>resizeterm 3x</H1>
45 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
51 <H2><a name="h2-NAME">NAME</a></H2><PRE>
52 <STRONG>is_term_resized</STRONG>, <STRONG>resize_term</STRONG>, <STRONG>resizeterm</STRONG> - change the
57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
58 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
60 <STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
61 <STRONG>int</STRONG> <STRONG>resize_term(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
62 <STRONG>int</STRONG> <STRONG>resizeterm(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
66 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67 This is an extension to the curses library. It provides
68 callers with a hook into the <STRONG>ncurses</STRONG> data to resize win-
69 dows, primarily for use by programs running in an X Window
70 terminal (e.g., xterm). The function <STRONG>resizeterm</STRONG> resizes
71 the standard and current windows to the specified dimen-
72 sions, and adjusts other bookkeeping data used by the
73 <STRONG>ncurses</STRONG> library that record the window dimensions such as
74 the <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> variables.
76 Most of the work is done by the inner function
77 <STRONG>resize_term</STRONG>. The outer function <STRONG>resizeterm</STRONG> adds bookkeep-
78 ing for the SIGWINCH handler. When resizing the windows,
79 <STRONG>resize_term</STRONG> blank-fills the areas that are extended. The
80 calling application should fill in these areas with appro-
81 priate data. The <STRONG>resize_term</STRONG> function attempts to resize
82 all windows. However, due to the calling convention of
83 pads, it is not possible to resize these without addi-
84 tional interaction with the application.
86 A support function <STRONG>is_term_resized</STRONG> is provided so that
87 applications can check if the <STRONG>resize_term</STRONG> function would
88 modify the window structures. It returns TRUE if the win-
89 dows would be modified, and FALSE otherwise.
93 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
94 Except as noted, these functions return the integer <STRONG>ERR</STRONG>
95 upon failure and <STRONG>OK</STRONG> on success. They will fail if either
96 of the dimensions are less than or equal to zero, or if an
97 error occurs while (re)allocating memory for the windows.
101 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
102 While these functions are intended to be used to support a
103 signal handler (i.e., for SIGWINCH), care should be taken
104 to avoid invoking them in a context where <STRONG>malloc</STRONG> or <STRONG>real-</STRONG>
105 <STRONG>loc</STRONG> may have been interrupted, since it uses those func-
108 If ncurses is configured to supply its own SIGWINCH han-
109 dler, the <STRONG>resizeterm</STRONG> function <STRONG>ungetch</STRONG>'s a <STRONG>KEY_RESIZE</STRONG> which
110 will be read on the next call to <STRONG>getch</STRONG>. This is used to
111 alert an application that the screen size has changed, and
112 that it should repaint special features such as pads that
113 cannot be done automatically.
115 If the environment variables <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> are set,
116 this overrides the library's use of the window size
117 obtained from the operating system. Thus, even if a SIG-
118 WINCH is received, no screen size change may be recorded.
122 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
123 <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.
127 <H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
128 Thomas Dickey (from an equivalent function written in 1988
133 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
137 <li><a href="#h2-NAME">NAME</a></li>
138 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
139 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
140 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
141 <li><a href="#h2-NOTES">NOTES</a></li>
142 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
143 <li><a href="#h2-AUTHOR">AUTHOR</a></li>