<!--
****************************************************************************
- * Copyright (c) 1998-2015,2017 Free Software Foundation, Inc. *
+ * 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 *
* authorization. *
****************************************************************************
* Author: Thomas E. Dickey 1996-on
- * @Id: resizeterm.3x,v 1.22 2017/01/07 19:25:15 tom Exp @
+ * @Id: resizeterm.3x,v 1.27 2020/02/02 23:34:34 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 http://invisible-island.net/scripts/readme.html#others_scripts">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
<TITLE>resizeterm 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
</PRE><H3><a name="h3-resize_term">resize_term</a></H3><PRE>
Most of the work is done by the inner function <STRONG>resize_term</STRONG>. The outer
- function <STRONG>resizeterm</STRONG> adds bookkeeping for the SIGWINCH handler. When
- resizing the windows, <STRONG>resize_term</STRONG> blank-fills the areas that are
+ function <STRONG>resizeterm</STRONG> adds bookkeeping for the <STRONG>SIGWINCH</STRONG> handler, as well
+ as repainting the soft-key area (see <STRONG><A HREF="slk_touch.3x.html">slk_touch(3x)</A></STRONG>).
+
+ When resizing the windows, <STRONG>resize_term</STRONG> blank-fills the areas that are
extended. The calling application should fill in these areas with
- appropriate data. The <STRONG>resize_term</STRONG> function attempts to resize all win-
- dows. However, due to the calling convention of pads, it is not possi-
- ble to resize these without additional interaction with the applica-
- tion.
+ appropriate data.
+
+ The <STRONG>resize_term</STRONG> 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.
+
+ When resizing windows, <STRONG>resize_term</STRONG> 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, <STRONG>resize_term</STRONG> will keep the window extending to the corresponding
+ limit, regardless of whether the screen has shrunk or grown.
</PRE><H3><a name="h3-is_term_resized">is_term_resized</a></H3><PRE>
A support function <STRONG>is_term_resized</STRONG> is provided so that applications can
- check if the <STRONG>resize_term</STRONG> function would modify the window structures.
+ check if the <STRONG>resize_term</STRONG> function would modify the window structures.
It returns <STRONG>TRUE</STRONG> if the windows would be modified, and <STRONG>FALSE</STRONG> otherwise.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- Except as noted, these functions return the integer <STRONG>ERR</STRONG> upon failure
+ Except as noted, these functions return the integer <STRONG>ERR</STRONG> upon failure
and <STRONG>OK</STRONG> 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 mem-
+ than or equal to zero, or if an error occurs while (re)allocating mem-
ory 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 han-
- dler (i.e., for SIGWINCH), care should be taken to avoid invoking them
- in a context where <STRONG>malloc</STRONG> or <STRONG>realloc</STRONG> may have been interrupted, since
+ While these functions are intended to be used to support a signal han-
+ dler (i.e., for <STRONG>SIGWINCH</STRONG>), care should be taken to avoid invoking them
+ in a context where <STRONG>malloc</STRONG> or <STRONG>realloc</STRONG> may have been interrupted, since
it uses those functions.
- If ncurses is configured to supply its own SIGWINCH handler,
+ If ncurses is configured to supply its own <STRONG>SIGWINCH</STRONG> handler,
- <STRONG>o</STRONG> on receipt of a SIGWINCH, the handler sets a flag
+ <STRONG>o</STRONG> on receipt of a <STRONG>SIGWINCH</STRONG>, the handler sets a flag
<STRONG>o</STRONG> which is tested in <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG> and <STRONG>doupdate</STRONG>,
<STRONG>o</STRONG> which <STRONG>ungetch</STRONG>'s a <STRONG>KEY_RESIZE</STRONG> which will be read on the next call to
<STRONG>wgetch</STRONG>.
- The <STRONG>KEY_RESIZE</STRONG> alerts an application that the screen size has
- changed, and that it should repaint special features such as pads
+ The <STRONG>KEY_RESIZE</STRONG> 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 <STRONG>resizeterm</STRONG> or <STRONG>resize_term</STRONG> directly from a signal handler is
- unsafe. This indirect method is used to provide a safe way to
+ unsafe. This indirect method is used to provide a safe way to
resize the ncurses data structures.
- If the environment variables <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> are set, this overrides
- the library's use of the window size obtained from the operating sys-
- tem. Thus, even if a SIGWINCH is received, no screen size change may
+ If the environment variables <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> are set, this overrides
+ the library's use of the window size obtained from the operating sys-
+ tem. Thus, even if a <STRONG>SIGWINCH</STRONG> is received, no screen size change may
be recorded.
Doing that clears the screen and is visually distracting.
- This extension of ncurses was introduced in mid-1995. It was adopted
+ This extension of ncurses was introduced in mid-1995. It was adopted
in NetBSD curses (2001) and PDCurses (2003).
</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
- Thomas Dickey (from an equivalent function written in 1988 for BSD
+ Thomas Dickey (from an equivalent function written in 1988 for BSD
curses).
projects / ncurses.git / blobdiff