-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2013,2015 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * Author: Thomas E. Dickey 1996,1997,2002
- * @Id: resizeterm.3x,v 1.10 2003/10/25 20:41:08 tom Exp @
+ * Author: Thomas E. Dickey 1996-on
+ * @Id: resizeterm.3x,v 1.18 2015/04/11 10:23:49 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">
<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>
<BODY>
-<H1>resizeterm 3x</H1>
-<HR>
+<H1 class="no-header">resizeterm 3x</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
-<STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
+<STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
</PRE>
+<H2>
<a name="h2-NAME">NAME</a></H2><PRE>
<STRONG>is_term_resized</STRONG>, <STRONG>resize_term</STRONG>, <STRONG>resizeterm</STRONG> - change the
curses terminal size
</PRE>
+<H2>
<a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
<STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
</PRE>
-<H2>
DESCRIPTION</H2><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 <STRONG>ncurses</STRONG> data to resize win-
dows, primarily for use by programs running in an X Window
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
- <STRONG>ncurses</STRONG> library that record the window dimensions.
+ <STRONG>ncurses</STRONG> library that record the window dimensions such as
+ the <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> variables.
- Most of the work is done by the inner function
+ Most of the work is done by the inner function
<STRONG>resize_term</STRONG>. The outer function <STRONG>resizeterm</STRONG> adds bookkeep-
- ing for the SIGWINCH handler. When resizing the windows,
- <STRONG>resize_term</STRONG> blank-fills the areas that are extended. The
+ ing for the SIGWINCH handler. When resizing the windows,
+ <STRONG>resize_term</STRONG> blank-fills the areas that are extended. The
calling application should fill in these areas with appro-
- 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-
+ 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-
tional interaction with the application.
- 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. It returns TRUE if the win-
- dows would be modified, and FALSE otherwise.
+ 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. It returns <STRONG>TRUE</STRONG> if the win-
+ dows would be modified, and <STRONG>FALSE</STRONG> otherwise.
</PRE>
-<H2>
RETURN VALUE</H2><PRE>
- Except as notes, these function return the integer <STRONG>ERR</STRONG>
- upon failure and <STRONG>OK</STRONG> on success. They will fail if either
+<H2>
<a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ 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 memory for the windows.
+ 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 SIGWINCH), care should be taken
to avoid invoking them in a context where <STRONG>malloc</STRONG> or <STRONG>real-</STRONG>
tions.
If ncurses is configured to supply its own SIGWINCH han-
- dler, the <STRONG>resizeterm</STRONG> function ungetch's a <STRONG>KEY_RESIZE</STRONG> which
+ 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
alert an application that the screen size has changed, and
that it should repaint special features such as pads that
cannot be done automatically.
+ 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-
+ WINCH is received, no screen size change may be recorded.
+
</PRE>
- <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.
+<H2>
<a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <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>.
</PRE>
+<H2>
<a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
Thomas Dickey (from an equivalent function written in 1988
for BSD curses).
- <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
+
<STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
</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></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>
</BODY>
</HTML>
projects / ncurses.git / blobdiff