ncurses 6.0 - patch 20160326
[ncurses.git] / doc / html / man / resizeterm.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2013,2015 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * Author: Thomas E. Dickey 1996-on
30   * @Id: resizeterm.3x,v 1.21 2015/09/26 19:55:32 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>resizeterm 3x</TITLE>
38 <link rev=made href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">resizeterm 3x</H1>
43 <PRE>
44 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>                                           <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>is_term_resized</STRONG>,  <STRONG>resize_term</STRONG>,  <STRONG>resizeterm</STRONG>  -  change  the
51        curses terminal size
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57        <STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
58        <STRONG>int</STRONG> <STRONG>resize_term(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
59        <STRONG>int</STRONG> <STRONG>resizeterm(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        This is an extension to the curses library.   It  provides
64        callers  with  a hook into the <STRONG>ncurses</STRONG> data to resize win-
65        dows, primarily for use by programs running in an X Window
66        terminal (e.g., xterm).
67
68
69 </PRE><H3><a name="h3-resizeterm">resizeterm</a></H3><PRE>
70        The  function  <STRONG>resizeterm</STRONG> resizes the standard and current
71        windows to the specified  dimensions,  and  adjusts  other
72        bookkeeping  data  used by the <STRONG>ncurses</STRONG> library that record
73        the window dimensions such as the  <STRONG>LINES</STRONG>  and  <STRONG>COLS</STRONG>  vari-
74        ables.
75
76
77 </PRE><H3><a name="h3-resize_term">resize_term</a></H3><PRE>
78        Most   of   the   work  is  done  by  the  inner  function
79        <STRONG>resize_term</STRONG>.  The outer function <STRONG>resizeterm</STRONG> adds bookkeep-
80        ing  for the SIGWINCH handler.  When resizing the windows,
81        <STRONG>resize_term</STRONG> blank-fills the areas that are extended.   The
82        calling application should fill in these areas with appro-
83        priate data.  The <STRONG>resize_term</STRONG> function attempts to  resize
84        all  windows.   However,  due to the calling convention of
85        pads, it is not possible to  resize  these  without  addi-
86        tional interaction with the application.
87
88
89 </PRE><H3><a name="h3-is_term_resized">is_term_resized</a></H3><PRE>
90        A  support  function  <STRONG>is_term_resized</STRONG>  is provided so that
91        applications can check if the <STRONG>resize_term</STRONG>  function  would
92        modify the window structures.  It returns <STRONG>TRUE</STRONG> if the win-
93        dows would be modified, and <STRONG>FALSE</STRONG> otherwise.
94
95
96 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
97        Except as noted, these functions return  the  integer  <STRONG>ERR</STRONG>
98        upon  failure and <STRONG>OK</STRONG> on success.  They will fail if either
99        of the dimensions are less than or equal to zero, or if an
100        error occurs while (re)allocating memory for the windows.
101
102
103 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
104        While these functions are intended to be used to support a
105        signal handler (i.e., for SIGWINCH), care should be  taken
106        to  avoid invoking them in a context where <STRONG>malloc</STRONG> or <STRONG>real-</STRONG>
107        <STRONG>loc</STRONG> may have been interrupted, since it uses  those  func-
108        tions.
109
110        If  ncurses  is configured to supply its own SIGWINCH han-
111        dler,
112
113        <STRONG>o</STRONG>   on receipt of a SIGWINCH, the handler sets a flag
114
115        <STRONG>o</STRONG>   which is tested in <STRONG>wgetch</STRONG> and <STRONG>doupdate</STRONG>,
116
117        <STRONG>o</STRONG>   in turn, calling the <STRONG>resizeterm</STRONG> function,
118
119        <STRONG>o</STRONG>   which <STRONG>ungetch</STRONG>'s a <STRONG>KEY_RESIZE</STRONG> which will be read on the
120            next call to <STRONG>wgetch</STRONG>.
121
122            The  <STRONG>KEY_RESIZE</STRONG>  alerts an application that the screen
123            size has changed, and that it should  repaint  special
124            features  such  as  pads that cannot be done automati-
125            cally.
126
127            Calling <STRONG>resizeterm</STRONG> or <STRONG>resize_term</STRONG> directly from a sig-
128            nal  handler  is unsafe.  This indirect method is used
129            to provide a safe  way  to  resize  the  ncurses  data
130            structures.
131
132        If  the  environment  variables  <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> are set,
133        this overrides  the  library's  use  of  the  window  size
134        obtained  from the operating system.  Thus, even if a SIG-
135        WINCH is received, no screen size change may be recorded.
136
137
138 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
139        It is possible to resize the screen with SVr4 curses, by
140
141        <STRONG>o</STRONG>   exiting curses with <STRONG><A HREF="endwin.3x.html">endwin(3x)</A></STRONG> and
142
143        <STRONG>o</STRONG>   resuming using <STRONG><A HREF="refresh.3x.html">refresh(3x)</A></STRONG>.
144
145        Doing that clears the screen and is visually distracting.
146
147        This extension of ncurses was introduced in mid-1995.   It
148        was adopted in NetBSD curses (2001) and PDCurses (2003).
149
150
151 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
152        <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>.
153
154
155 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
156        Thomas Dickey (from an equivalent function written in 1988
157        for BSD curses).
158
159
160
161                                                          <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
162 </PRE>
163 <div class="nav">
164 <ul>
165 <li><a href="#h2-NAME">NAME</a></li>
166 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
167 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
168 <ul>
169 <li><a href="#h3-resizeterm">resizeterm</a></li>
170 <li><a href="#h3-resize_term">resize_term</a></li>
171 <li><a href="#h3-is_term_resized">is_term_resized</a></li>
172 </ul>
173 </li>
174 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
175 <li><a href="#h2-NOTES">NOTES</a></li>
176 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
177 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
178 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
179 </ul>
180 </div>
181 </BODY>
182 </HTML>