2 ****************************************************************************
3 * Copyright (c) 1998-2013,2015 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.20 2015/09/19 22:53:26 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 class="no-header">resizeterm 3x</H1>
44 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>is_term_resized</STRONG>, <STRONG>resize_term</STRONG>, <STRONG>resizeterm</STRONG> - change the
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
59 <STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
60 <STRONG>int</STRONG> <STRONG>resize_term(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
61 <STRONG>int</STRONG> <STRONG>resizeterm(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66 This is an extension to the curses library. It provides
67 callers with a hook into the <STRONG>ncurses</STRONG> data to resize win-
68 dows, primarily for use by programs running in an X Window
69 terminal (e.g., xterm).
73 <H3><a name="h3-resizeterm">resizeterm</a></H3><PRE>
74 The function <STRONG>resizeterm</STRONG> resizes the standard and current
75 windows to the specified dimensions, and adjusts other
76 bookkeeping data used by the <STRONG>ncurses</STRONG> library that record
77 the window dimensions such as the <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> vari-
82 <H3><a name="h3-resize_term">resize_term</a></H3><PRE>
83 Most of the work is done by the inner function
84 <STRONG>resize_term</STRONG>. The outer function <STRONG>resizeterm</STRONG> adds bookkeep-
85 ing for the SIGWINCH handler. When resizing the windows,
86 <STRONG>resize_term</STRONG> blank-fills the areas that are extended. The
87 calling application should fill in these areas with appro-
88 priate data. The <STRONG>resize_term</STRONG> function attempts to resize
89 all windows. However, due to the calling convention of
90 pads, it is not possible to resize these without addi-
91 tional interaction with the application.
95 <H3><a name="h3-is_term_resized">is_term_resized</a></H3><PRE>
96 A support function <STRONG>is_term_resized</STRONG> is provided so that
97 applications can check if the <STRONG>resize_term</STRONG> function would
98 modify the window structures. It returns <STRONG>TRUE</STRONG> if the win-
99 dows would be modified, and <STRONG>FALSE</STRONG> otherwise.
103 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
104 Except as noted, these functions return the integer <STRONG>ERR</STRONG>
105 upon failure and <STRONG>OK</STRONG> on success. They will fail if either
106 of the dimensions are less than or equal to zero, or if an
107 error occurs while (re)allocating memory for the windows.
111 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
112 While these functions are intended to be used to support a
113 signal handler (i.e., for SIGWINCH), care should be taken
114 to avoid invoking them in a context where <STRONG>malloc</STRONG> or <STRONG>real-</STRONG>
115 <STRONG>loc</STRONG> may have been interrupted, since it uses those func-
118 If ncurses is configured to supply its own SIGWINCH han-
121 <STRONG>o</STRONG> on receipt of a SIGWINCH, the handler sets a flag
123 <STRONG>o</STRONG> which is tested in <STRONG>wgetch</STRONG> and <STRONG>doupdate</STRONG>,
125 <STRONG>o</STRONG> in turn, calling the <STRONG>resizeterm</STRONG> function,
127 <STRONG>o</STRONG> which <STRONG>ungetch</STRONG>'s a <STRONG>KEY_RESIZE</STRONG> which will be read on the
128 next call to <STRONG>wgetch</STRONG>.
130 The <STRONG>KEY_RESIZE</STRONG> alerts an application that the screen
131 size has changed, and that it should repaint special
132 features such as pads that cannot be done automati-
135 Calling <STRONG>resizeterm</STRONG> or <STRONG>resize_term</STRONG> directly from a sig-
136 nal handler is unsafe. This indirect method is used
137 to provide a safe way to resize the ncurses data
140 If the environment variables <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> are set,
141 this overrides the library's use of the window size
142 obtained from the operating system. Thus, even if a SIG-
143 WINCH is received, no screen size change may be recorded.
147 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
148 <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>.
152 <H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
153 Thomas Dickey (from an equivalent function written in 1988
158 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
162 <li><a href="#h2-NAME">NAME</a></li>
163 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
164 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
166 <li><a href="#h3-resizeterm">resizeterm</a></li>
167 <li><a href="#h3-resize_term">resize_term</a></li>
168 <li><a href="#h3-is_term_resized">is_term_resized</a></li>
171 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
172 <li><a href="#h2-NOTES">NOTES</a></li>
173 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
174 <li><a href="#h2-AUTHOR">AUTHOR</a></li>