2002-10-13 11:35:53 +08:00
|
|
|
<!--
|
|
|
|
|
****************************************************************************
|
2013-12-22 07:12:46 +08:00
|
|
|
* Copyright (c) 1998-2012,2013 Free Software Foundation, Inc. *
|
2002-10-13 11:35:53 +08:00
|
|
|
* *
|
|
|
|
|
* 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. *
|
|
|
|
|
****************************************************************************
|
2013-12-22 07:12:46 +08:00
|
|
|
* Author: Thomas E. Dickey 1996-on
|
|
|
|
|
* @Id: resizeterm.3x,v 1.17 2013/06/22 20:41:54 tom Exp @
|
2002-10-13 11:35:53 +08:00
|
|
|
-->
|
2015-02-15 09:42:27 +08:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
1997-05-15 12:00:00 +08:00
|
|
|
<HTML>
|
2002-10-13 11:35:53 +08:00
|
|
|
<HEAD>
|
2015-02-15 09:42:27 +08:00
|
|
|
<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">
|
2002-10-13 11:35:53 +08:00
|
|
|
<TITLE>resizeterm 3x</TITLE>
|
|
|
|
|
<link rev=made href="mailto:bug-ncurses@gnu.org">
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
|
</HEAD>
|
1999-10-24 12:32:42 +08:00
|
|
|
<BODY>
|
2002-10-13 11:35:53 +08:00
|
|
|
<H1>resizeterm 3x</H1>
|
|
|
|
|
<HR>
|
1997-05-15 12:00:00 +08:00
|
|
|
<PRE>
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
|
2004-02-09 10:15:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-NAME">NAME</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>is_term_resized</STRONG>, <STRONG>resize_term</STRONG>, <STRONG>resizeterm</STRONG> - change the
|
|
|
|
|
curses terminal size
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
1997-05-15 12:00:00 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>resize_term(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>resizeterm(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
This is an extension to the curses library. It provides
|
|
|
|
|
callers with a hook into the <STRONG>ncurses</STRONG> data to resize win-
|
1997-05-15 12:00:00 +08:00
|
|
|
dows, primarily for use by programs running in an X Window
|
2002-10-13 11:35:53 +08:00
|
|
|
terminal (e.g., xterm). The function <STRONG>resizeterm</STRONG> resizes
|
|
|
|
|
the standard and current windows to the specified dimen-
|
|
|
|
|
sions, and adjusts other bookkeeping data used by the
|
2013-12-22 07:12:46 +08:00
|
|
|
<STRONG>ncurses</STRONG> library that record the window dimensions such as
|
|
|
|
|
the <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> variables.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2013-12-22 07:12:46 +08:00
|
|
|
Most of the work is done by the inner function
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>resize_term</STRONG>. The outer function <STRONG>resizeterm</STRONG> adds bookkeep-
|
2013-12-22 07:12:46 +08:00
|
|
|
ing for the SIGWINCH handler. When resizing the windows,
|
|
|
|
|
<STRONG>resize_term</STRONG> blank-fills the areas that are extended. The
|
2002-10-13 11:35:53 +08:00
|
|
|
calling application should fill in these areas with appro-
|
2013-12-22 07:12:46 +08:00
|
|
|
priate 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 addi-
|
2002-10-13 11:35:53 +08:00
|
|
|
tional interaction with the application.
|
|
|
|
|
|
2013-12-22 07:12:46 +08:00
|
|
|
A support function <STRONG>is_term_resized</STRONG> is provided so that
|
|
|
|
|
applications can check if the <STRONG>resize_term</STRONG> function would
|
2002-10-13 11:35:53 +08:00
|
|
|
modify the window structures. It returns TRUE if the win-
|
|
|
|
|
dows would be modified, and FALSE otherwise.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
2013-12-22 07:12:46 +08:00
|
|
|
Except as noted, these functions return the integer <STRONG>ERR</STRONG>
|
|
|
|
|
upon failure and <STRONG>OK</STRONG> on success. They will fail if either
|
2002-10-13 11:35:53 +08:00
|
|
|
of the dimensions are less than or equal to zero, or if an
|
2010-08-01 08:45:28 +08:00
|
|
|
error occurs while (re)allocating memory for the windows.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
While these functions are intended to be used to support a
|
2013-12-22 07:12:46 +08:00
|
|
|
signal handler (i.e., for SIGWINCH), care should be taken
|
|
|
|
|
to avoid invoking them in a context where <STRONG>malloc</STRONG> or <STRONG>real-</STRONG>
|
|
|
|
|
<STRONG>loc</STRONG> may have been interrupted, since it uses those func-
|
2002-10-13 11:35:53 +08:00
|
|
|
tions.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
2013-12-22 07:12:46 +08:00
|
|
|
If ncurses is configured to supply its own SIGWINCH han-
|
|
|
|
|
dler, the <STRONG>resizeterm</STRONG> function <STRONG>ungetch</STRONG>'s a <STRONG>KEY_RESIZE</STRONG> which
|
|
|
|
|
will be read on the next call to <STRONG>getch</STRONG>. This is used to
|
1998-03-01 12:21:12 +08:00
|
|
|
alert an application that the screen size has changed, and
|
2013-12-22 07:12:46 +08:00
|
|
|
that it should repaint special features such as pads that
|
1998-03-01 12:21:12 +08:00
|
|
|
cannot be done automatically.
|
|
|
|
|
|
2013-12-22 07:12:46 +08:00
|
|
|
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 system. Thus, even if a SIG-
|
2013-03-10 08:35:23 +08:00
|
|
|
WINCH is received, no screen size change may be recorded.
|
2005-10-10 02:41:57 +08:00
|
|
|
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
2013-12-22 07:12:46 +08:00
|
|
|
<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>.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
|
1997-05-15 12:00:00 +08:00
|
|
|
Thomas Dickey (from an equivalent function written in 1988
|
|
|
|
|
for BSD curses).
|
|
|
|
|
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
|
1997-05-15 12:00:00 +08:00
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<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></li>
|
|
|
|
|
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
|
|
|
|
|
<li><a href="#h2-NOTES">NOTES</a></li>
|
|
|
|
|
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
|
|
|
|
|
<li><a href="#h2-AUTHOR">AUTHOR</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
1997-05-15 12:00:00 +08:00
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
