ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / resizeterm.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 1998-2015,2017 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-on
31   * @Id: resizeterm.3x,v 1.27 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>resizeterm 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">resizeterm 3x</H1>
44 <PRE>
45 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>                                                  <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>is_term_resized</STRONG>,  <STRONG>resize_term</STRONG>,  <STRONG>resizeterm</STRONG> - change the curses terminal
52        size
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
59        <STRONG>int</STRONG> <STRONG>resize_term(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
60        <STRONG>int</STRONG> <STRONG>resizeterm(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        This is an extension to the curses library.  It provides callers with a
65        hook into the <STRONG>ncurses</STRONG> data to resize windows, primarily for use by pro-
66        grams running in an X Window terminal (e.g., xterm).
67
68
69 </PRE><H3><a name="h3-resizeterm">resizeterm</a></H3><PRE>
70        The function <STRONG>resizeterm</STRONG> resizes the standard and current windows to the
71        specified  dimensions,  and  adjusts other bookkeeping data used by the
72        <STRONG>ncurses</STRONG> library that record the window dimensions such as the <STRONG>LINES</STRONG> and
73        <STRONG>COLS</STRONG> variables.
74
75
76 </PRE><H3><a name="h3-resize_term">resize_term</a></H3><PRE>
77        Most  of the work is done by the inner function <STRONG>resize_term</STRONG>.  The outer
78        function <STRONG>resizeterm</STRONG> adds bookkeeping for the <STRONG>SIGWINCH</STRONG> handler, as  well
79        as repainting the soft-key area (see <STRONG><A HREF="curs_slk.3x.html">slk_touch(3x)</A></STRONG>).
80
81        When  resizing  the windows, <STRONG>resize_term</STRONG> blank-fills the areas that are
82        extended.  The calling application should  fill  in  these  areas  with
83        appropriate data.
84
85        The  <STRONG>resize_term</STRONG> function attempts to resize all windows.  However, due
86        to the calling convention of pads, it is not possible to  resize  these
87        without additional interaction with the application.
88
89        When  resizing  windows,  <STRONG>resize_term</STRONG>  recursively  adjusts subwindows,
90        keeping them within the updated parent window's limits.  If a top-level
91        window  happens  to extend to the screen's limits, then on resizing the
92        window, <STRONG>resize_term</STRONG> will keep the window extending to the corresponding
93        limit, regardless of whether the screen has shrunk or grown.
94
95
96 </PRE><H3><a name="h3-is_term_resized">is_term_resized</a></H3><PRE>
97        A support function <STRONG>is_term_resized</STRONG> is provided so that applications can
98        check if the <STRONG>resize_term</STRONG> function would modify the  window  structures.
99        It returns <STRONG>TRUE</STRONG> if the windows would be modified, and <STRONG>FALSE</STRONG> otherwise.
100
101
102 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
103        Except  as  noted,  these functions return the integer <STRONG>ERR</STRONG> upon failure
104        and <STRONG>OK</STRONG> on success.  They will fail if either of the dimensions are less
105        than  or equal to zero, or if an error occurs while (re)allocating mem-
106        ory for the windows.
107
108
109 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
110        While these functions are intended to be used to support a signal  han-
111        dler  (i.e., for <STRONG>SIGWINCH</STRONG>), care should be taken to avoid invoking them
112        in a context where <STRONG>malloc</STRONG> or <STRONG>realloc</STRONG> may have been  interrupted,  since
113        it uses those functions.
114
115        If ncurses is configured to supply its own <STRONG>SIGWINCH</STRONG> handler,
116
117        <STRONG>o</STRONG>   on receipt of a <STRONG>SIGWINCH</STRONG>, the handler sets a flag
118
119        <STRONG>o</STRONG>   which is tested in <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> and <STRONG>doupdate</STRONG>,
120
121        <STRONG>o</STRONG>   in turn, calling the <STRONG>resizeterm</STRONG> function,
122
123        <STRONG>o</STRONG>   which <STRONG>ungetch</STRONG>'s a <STRONG>KEY_RESIZE</STRONG> which will be read on the next call to
124            <STRONG>wgetch</STRONG>.
125
126            The <STRONG>KEY_RESIZE</STRONG> alerts an  application  that  the  screen  size  has
127            changed,  and  that it should repaint special features such as pads
128            that cannot be done automatically.
129
130            Calling <STRONG>resizeterm</STRONG> or <STRONG>resize_term</STRONG> directly from a signal handler is
131            unsafe.   This  indirect  method  is  used to provide a safe way to
132            resize the ncurses data structures.
133
134        If the environment variables <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> are set,  this  overrides
135        the  library's  use of the window size obtained from the operating sys-
136        tem.  Thus, even if a <STRONG>SIGWINCH</STRONG> is received, no screen size  change  may
137        be recorded.
138
139
140 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
141        It is possible to resize the screen with SVr4 curses, by
142
143        <STRONG>o</STRONG>   exiting curses with <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG> and
144
145        <STRONG>o</STRONG>   resuming using <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>.
146
147        Doing that clears the screen and is visually distracting.
148
149        This  extension  of ncurses was introduced in mid-1995.  It was adopted
150        in NetBSD curses (2001) and PDCurses (2003).
151
152
153 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
154        <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>.
155
156
157 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
158        Thomas Dickey (from an equivalent function  written  in  1988  for  BSD
159        curses).
160
161
162
163                                                                 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
164 </PRE>
165 <div class="nav">
166 <ul>
167 <li><a href="#h2-NAME">NAME</a></li>
168 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
169 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
170 <ul>
171 <li><a href="#h3-resizeterm">resizeterm</a></li>
172 <li><a href="#h3-resize_term">resize_term</a></li>
173 <li><a href="#h3-is_term_resized">is_term_resized</a></li>
174 </ul>
175 </li>
176 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
177 <li><a href="#h2-NOTES">NOTES</a></li>
178 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
179 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
180 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
181 </ul>
182 </div>
183 </BODY>
184 </HTML>