+<!--
+ ****************************************************************************
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2015,2017 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * Author: Thomas E. Dickey 1996-on
+ * @Id: resizeterm.3x,v 1.28 2020/10/17 23:55:41 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>resizeterm 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1 class="no-header">resizeterm 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<B><A HREF="resizeterm.3X.html">resizeterm(3X)</A></B> <B><A HREF="resizeterm.3X.html">resizeterm(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <B>resizeterm</B> - change the curses terminal size
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
+
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>is_term_resized</B>, <B>resize_term</B>, <B>resizeterm</B> - change the curses terminal
+ size
+
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<B>#include</B> <B><curses.h></B>
- <B>int</B> <B>resizeterm(int</B> <B>lines,</B> <B>int</B> <B>columns);</B>
+ <B>bool</B> <B>is_term_resized(int</B> <I>lines</I><B>,</B> <B>int</B> <I>columns</I><B>);</B>
+ <B>int</B> <B>resize_term(int</B> <I>lines</I><B>,</B> <B>int</B> <I>columns</I><B>);</B>
+ <B>int</B> <B>resizeterm(int</B> <I>lines</I><B>,</B> <B>int</B> <I>columns</I><B>);</B>
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- This is an extension to the curses library. It provides
- callers with a hook into the <B>ncurses</B> data to resize win-
- dows, primarily for use by programs running in an X Window
- terminal (e.g., xterm). The function <B>resizeterm</B> resizes
- the standard and current windows to the specified dimen-
- sions, and adjusts other bookkeeping data used by the
- <B>ncurses</B> library that record the window dimensions.
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ This is an extension to the curses library. It provides callers with a
+ hook into the <B>ncurses</B> data to resize windows, primarily for use by
+ programs running in an X Window terminal (e.g., xterm).
- When resizing the windows, the function blank-fills the
- areas that are extended. The calling application should
- fill in these areas with appropriate data.
- The function attempts to resize all windows. However, due
- to the calling convention of pads, it is not possible to
- resize these without additional interaction with the
- application.
+</PRE><H3><a name="h3-resizeterm">resizeterm</a></H3><PRE>
+ The function <B>resizeterm</B> resizes the standard and current windows to the
+ specified dimensions, and adjusts other bookkeeping data used by the
+ <B>ncurses</B> library that record the window dimensions such as the <B>LINES</B> and
+ <B>COLS</B> variables.
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- The function returns the integer <B>ERR</B> upon failure and <B>OK</B>
- on success. It will fail if either of the dimensions less
- than or equal to zero, or if an error occurs while
- (re)allocating memory for the windows.
+</PRE><H3><a name="h3-resize_term">resize_term</a></H3><PRE>
+ Most of the work is done by the inner function <B>resize_term</B>. The outer
+ function <B>resizeterm</B> adds bookkeeping for the <B>SIGWINCH</B> handler, as well
+ as repainting the soft-key area (see <B><A HREF="curs_slk.3X.html">slk_touch(3X)</A></B>).
+ When resizing the windows, <B>resize_term</B> blank-fills the areas that are
+ extended. The calling application should fill in these areas with
+ appropriate data.
-</PRE>
-<H2>NOTES</H2><PRE>
- While this function is intended to be used to support a
- signal handler (i.e., for SIGWINCH), care should be taken
- to avoid invoking it in a context where <B>malloc</B> or <B>realloc</B>
- may have been interrupted, since it uses those functions.
+ The <B>resize_term</B> function attempts to resize all windows. However, due
+ to the calling convention of pads, it is not possible to resize these
+ without additional interaction with the application.
- If ncurses is configured to supply its own SIGWINCH han-
- dler, the <B>resizeterm</B> function ungetch's a <B>KEY_RESIZE</B> which
- will be read on the next call to <B>getch</B>. This is used to
- alert an application that the screen size has changed, and
- that it should repaint special features such as pads that
- cannot be done automatically.
+ When resizing windows, <B>resize_term</B> recursively adjusts subwindows,
+ keeping them within the updated parent window's limits. If a top-level
+ window happens to extend to the screen's limits, then on resizing the
+ window, <B>resize_term</B> will keep the window extending to the corresponding
+ limit, regardless of whether the screen has shrunk or grown.
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <B><A HREF="wresize.3x.html">wresize(3x)</A></B>.
+</PRE><H3><a name="h3-is_term_resized">is_term_resized</a></H3><PRE>
+ A support function <B>is_term_resized</B> is provided so that applications can
+ check if the <B>resize_term</B> function would modify the window structures.
+ It returns <B>TRUE</B> if the windows would be modified, and <B>FALSE</B> otherwise.
-</PRE>
-<H2>AUTHOR</H2><PRE>
- Thomas Dickey (from an equivalent function written in 1988
- for BSD curses).
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Except as noted, these functions return the integer <B>ERR</B> upon failure
+ and <B>OK</B> on success. They will fail if either of the dimensions are less
+ than or equal to zero, or if an error occurs while (re)allocating
+ memory for the windows.
+
+
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ While these functions are intended to be used to support a signal
+ handler (i.e., for <B>SIGWINCH</B>), care should be taken to avoid invoking
+ them in a context where <B>malloc</B> or <B>realloc</B> may have been interrupted,
+ since it uses those functions.
+
+ If ncurses is configured to supply its own <B>SIGWINCH</B> handler,
+
+ <B>o</B> on receipt of a <B>SIGWINCH</B>, the handler sets a flag
+
+ <B>o</B> which is tested in <B><A HREF="curs_getch.3X.html">wgetch(3X)</A></B> and <B>doupdate</B>,
+
+ <B>o</B> in turn, calling the <B>resizeterm</B> function,
+
+ <B>o</B> which <B>ungetch</B>'s a <B>KEY_RESIZE</B> which will be read on the next call to
+ <B>wgetch</B>.
+
+ The <B>KEY_RESIZE</B> alerts an application that the screen size has
+ changed, and that it should repaint special features such as pads
+ that cannot be done automatically.
+
+ Calling <B>resizeterm</B> or <B>resize_term</B> directly from a signal handler is
+ unsafe. This indirect method is used to provide a safe way to
+ resize the ncurses data structures.
+
+ If the environment variables <B>LINES</B> or <B>COLUMNS</B> are set, this overrides
+ the library's use of the window size obtained from the operating
+ system. Thus, even if a <B>SIGWINCH</B> is received, no screen size change
+ may be recorded.
+
+
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ It is possible to resize the screen with SVr4 curses, by
+
+ <B>o</B> exiting curses with <B><A HREF="curs_initscr.3X.html">endwin(3X)</A></B> and
+
+ <B>o</B> resuming using <B><A HREF="curs_refresh.3X.html">refresh(3X)</A></B>.
+
+ Doing that clears the screen and is visually distracting.
+
+ This extension of ncurses was introduced in mid-1995. It was adopted
+ in NetBSD curses (2001) and PDCurses (2003).
+
+
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curs_getch.3X.html">curs_getch(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>, <B><A HREF="wresize.3X.html">wresize(3X)</A></B>.
+
+
+</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
+ Thomas Dickey (from an equivalent function written in 1988 for BSD
+ curses).
+ <B><A HREF="resizeterm.3X.html">resizeterm(3X)</A></B>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-resizeterm">resizeterm</a></li>
+<li><a href="#h3-resize_term">resize_term</a></li>
+<li><a href="#h3-is_term_resized">is_term_resized</a></li>
+</ul>
+</li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+<li><a href="#h2-AUTHOR">AUTHOR</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff