Debian Codegraph @

doc/html/man/resizeterm.3x.html

raw
1 <!--
2 ****************************************************************************
3 * Copyright 2018-2024,2025 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.65 2025/07/05 13:06:45 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 2025-07-05 ncurses 6.6 Library calls</TITLE>
39 <link rel="author" href="mailto:[email protected]">
40
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">resizeterm 3x 2025-07-05 ncurses 6.6 Library calls</H1>
44 <PRE>
45 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> Library calls <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>is_term_resized</STRONG>, <STRONG>resize_term</STRONG>, <STRONG>resizeterm</STRONG> - manage the terminal
50 dimensions understood by <EM>curses</EM>
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56 <STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <EM>lines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>columns</EM><STRONG>);</STRONG>
57 <STRONG>int</STRONG> <STRONG>resize_term(int</STRONG> <EM>lines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>columns</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>resizeterm(int</STRONG> <EM>lines</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>columns</EM><STRONG>);</STRONG>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62 This is an extension to the <EM>curses</EM> library. It provides callers with a
63 hook into the <EM>ncurses</EM> data to resize windows, primarily for use by
64 programs running in an X Window terminal (e.g., xterm) when the
65 terminal's screen size is changed by the user:
66
67 <STRONG>o</STRONG> <EM>curses</EM> windows cannot extend outside the screen. If the terminal
68 is shrunk, <EM>curses</EM> windows must be shrunk to fit.
69
70 <STRONG>o</STRONG> If the terminal is stretched, rows and/or columns can be added to
71 existing windows. The added cells should match the current
72 attributes of the windows.
73
74 If the application has not set up a handler for <EM>SIGWINCH</EM> when it
75 initializes <EM>ncurses</EM> (by calling <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG> or <STRONG><A HREF="curs_initscr.3x.html">newterm(3x)</A></STRONG>), then
76 <EM>ncurses</EM> establishes a <EM>SIGWINCH</EM> handler that notifies the library when a
77 window-resizing event has occurred. The library checks for this
78 notification
79
80 <STRONG>o</STRONG> when reading input data,
81
82 <STRONG>o</STRONG> when implicitly resuming program mode (e.g., between <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG> and
83 <STRONG><A HREF="curs_refresh.3x.html">wrefresh(3x)</A></STRONG>), and
84
85 <STRONG>o</STRONG> when explicitly resuming program mode in <STRONG><A HREF="curs_terminfo.3x.html">restartterm(3x)</A></STRONG>.
86
87 When the library has found that the terminal's window-size has changed,
88 it calls <STRONG>resizeterm</STRONG> to update its data structures.
89
90 An application which establishes its own <EM>SIGWINCH</EM> handler can call
91 <STRONG>resizeterm</STRONG>, but in that case, the library will not see <EM>SIGWINCH</EM>, and
92 proper layout will rely upon the application.
93
94
95 </PRE><H3><a name="h3-resizeterm">resizeterm</a></H3><PRE>
96 The function <STRONG>resizeterm</STRONG> resizes the standard and current windows (i.e.,
97 <STRONG>stdscr</STRONG> and <STRONG>curscr</STRONG>) to the specified dimensions, and adjusts other
98 bookkeeping data used by the <EM>ncurses</EM> library that record the window
99 dimensions such as the <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> variables.
100
101
102 </PRE><H3><a name="h3-resize_term">resize_term</a></H3><PRE>
103 Most of the work for <STRONG>resizeterm</STRONG> is done by the inner function
104 <STRONG>resize_term</STRONG>. The outer function <STRONG>resizeterm</STRONG> adds bookkeeping for the
105 <EM>SIGWINCH</EM> handler, as well as repainting the soft-key area (see
106 <STRONG><A HREF="curs_slk.3x.html">slk_touch(3x)</A></STRONG>).
107
108 The <STRONG>resize_term</STRONG> function attempts to resize all windows. This helps
109 with simple applications. However:
110
111 <STRONG>o</STRONG> It is not possible to automatically resize pads.
112
113 <STRONG>o</STRONG> Applications which have complicated layouts should check for
114 <STRONG>KEY_RESIZE</STRONG> returned from <STRONG>wgetch</STRONG>, and adjust their layout, e.g.,
115 using <STRONG>wresize</STRONG> and <STRONG>mvwin</STRONG>, or by recreating the windows.
116
117 When resizing windows, <STRONG>resize_term</STRONG> recursively adjusts subwindows,
118 keeping them within the updated parent window's limits. If a top-level
119 window happens to extend to the screen's limits, then on resizing the
120 window, <STRONG>resize_term</STRONG> will keep the window extending to the corresponding
121 limit, regardless of whether the screen has shrunk or grown.
122
123
124 </PRE><H3><a name="h3-is_term_resized">is_term_resized</a></H3><PRE>
125 A support function <STRONG>is_term_resized</STRONG> is provided so that applications can
126 check if the <STRONG>resize_term</STRONG> function would modify the window structures.
127 It returns <STRONG>TRUE</STRONG> if the windows would be modified, and <STRONG>FALSE</STRONG> otherwise.
128
129
130 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
131 Except as noted, these functions return the integer <STRONG>ERR</STRONG> upon failure
132 and <STRONG>OK</STRONG> on success. They will fail if either of the dimensions are less
133 than or equal to zero, or if an error occurs while (re)allocating
134 memory for the windows.
135
136
137 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
138 While these functions are intended to be used to support a signal
139 handler (i.e., for <EM>SIGWINCH</EM>), care should be taken to avoid invoking
140 them in a context where <STRONG>malloc</STRONG> or <STRONG>realloc</STRONG> may have been interrupted,
141 since it uses those functions.
142
143 If <EM>ncurses</EM> is configured to supply its own <EM>SIGWINCH</EM> handler,
144
145 <STRONG>o</STRONG> on receipt of a <EM>SIGWINCH</EM>, the handler sets a flag
146
147 <STRONG>o</STRONG> which is tested in <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">doupdate(3x)</A></STRONG> and <STRONG><A HREF="curs_terminfo.3x.html">restartterm(3x)</A></STRONG>,
148
149 <STRONG>o</STRONG> in turn, calling the <STRONG>resizeterm</STRONG> function,
150
151 <STRONG>o</STRONG> which <STRONG>ungetch</STRONG>'s a <STRONG>KEY_RESIZE</STRONG> which will be read on the next call to
152 <STRONG>wgetch</STRONG>.
153
154 The <STRONG>KEY_RESIZE</STRONG> alerts an application that the screen size has
155 changed, and that it should repaint special features such as pads
156 that cannot be done automatically.
157
158 Calling <STRONG>resizeterm</STRONG> or <STRONG>resize_term</STRONG> directly from a signal handler is
159 unsafe. This indirect method is used to provide a safe way to
160 resize the <EM>ncurses</EM> data structures.
161
162 If the environment variables <EM>LINES</EM> or <EM>COLUMNS</EM> are set, this overrides
163 the library's use of the window size obtained from the operating
164 system. Thus, even if a <EM>SIGWINCH</EM> is received, no screen size change
165 may be recorded.
166
167
168 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
169 It is possible to resize the screen with SVr4 <EM>curses</EM>, by
170
171 <STRONG>o</STRONG> exiting <EM>curses</EM> with <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG> and
172
173 <STRONG>o</STRONG> resuming using <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>.
174
175 Doing that clears the screen and is visually distracting.
176
177 <EM>ncurses</EM> introduced this extension in mid-1995. NetBSD <EM>curses</EM> adopted
178 it in 2001 and <EM>PDCurses</EM> in 2003.
179
180
181 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
182 Thomas Dickey (from an equivalent function written in 1988 for BSD
183 <EM>curses</EM>)
184
185
186 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
187 <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>
188
189 ncurses 6.6 2025-07-05 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
190 </PRE>
191 <div class="nav">
192 <ul>
193 <li><a href="#h2-NAME">NAME</a></li>
194 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
195 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
196 <ul>
197 <li><a href="#h3-resizeterm">resizeterm</a></li>
198 <li><a href="#h3-resize_term">resize_term</a></li>
199 <li><a href="#h3-is_term_resized">is_term_resized</a></li>
200 </ul>
201 </li>
202 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
203 <li><a href="#h2-NOTES">NOTES</a></li>
204 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
205 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
206 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
207 </ul>
208 </div>
209 </BODY>
210 </HTML>