ncurses 6.0 - patch 20150606
[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.19 2015/06/06 23:38:18 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>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>is_term_resized</STRONG>,  <STRONG>resize_term</STRONG>,  <STRONG>resizeterm</STRONG>  -  change  the
52        curses terminal size
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59        <STRONG>bool</STRONG> <STRONG>is_term_resized(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
60        <STRONG>int</STRONG> <STRONG>resize_term(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
61        <STRONG>int</STRONG> <STRONG>resizeterm(int</STRONG> <STRONG>lines,</STRONG> <STRONG>int</STRONG> <STRONG>columns);</STRONG>
62
63
64 </PRE>
65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
66        This is an extension to the curses library.   It  provides
67        callers  with  a hook into the <STRONG>ncurses</STRONG> data to resize win-
68        dows, primarily for use by programs running in an X Window
69        terminal (e.g., xterm).
70
71
72 </PRE>
73 <H3><a name="h3-resizeterm">resizeterm</a></H3><PRE>
74        The  function  <STRONG>resizeterm</STRONG> resizes the standard and current
75        windows to the specified  dimensions,  and  adjusts  other
76        bookkeeping  data  used by the <STRONG>ncurses</STRONG> library that record
77        the window dimensions such as the  <STRONG>LINES</STRONG>  and  <STRONG>COLS</STRONG>  vari-
78        ables.
79
80
81 </PRE>
82 <H3><a name="h3-resize_term">resize_term</a></H3><PRE>
83        Most   of   the   work  is  done  by  the  inner  function
84        <STRONG>resize_term</STRONG>.  The outer function <STRONG>resizeterm</STRONG> adds bookkeep-
85        ing  for the SIGWINCH handler.  When resizing the windows,
86        <STRONG>resize_term</STRONG> blank-fills the areas that are extended.   The
87        calling application should fill in these areas with appro-
88        priate data.  The <STRONG>resize_term</STRONG> function attempts to  resize
89        all  windows.   However,  due to the calling convention of
90        pads, it is not possible to  resize  these  without  addi-
91        tional interaction with the application.
92
93
94 </PRE>
95 <H3><a name="h3-is_term_resized">is_term_resized</a></H3><PRE>
96        A  support  function  <STRONG>is_term_resized</STRONG>  is provided so that
97        applications can check if the <STRONG>resize_term</STRONG>  function  would
98        modify the window structures.  It returns <STRONG>TRUE</STRONG> if the win-
99        dows would be modified, and <STRONG>FALSE</STRONG> otherwise.
100
101
102 </PRE>
103 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
104        Except as noted, these functions return  the  integer  <STRONG>ERR</STRONG>
105        upon  failure and <STRONG>OK</STRONG> on success.  They will fail if either
106        of the dimensions are less than or equal to zero, or if an
107        error occurs while (re)allocating memory for the windows.
108
109
110 </PRE>
111 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
112        While these functions are intended to be used to support a
113        signal handler (i.e., for SIGWINCH), care should be  taken
114        to  avoid invoking them in a context where <STRONG>malloc</STRONG> or <STRONG>real-</STRONG>
115        <STRONG>loc</STRONG> may have been interrupted, since it uses  those  func-
116        tions.
117
118        If  ncurses  is configured to supply its own SIGWINCH han-
119        dler, the <STRONG>resizeterm</STRONG> function <STRONG>ungetch</STRONG>'s a <STRONG>KEY_RESIZE</STRONG> which
120        will  be  read on the next call to <STRONG>getch</STRONG>.  This is used to
121        alert an application that the screen size has changed, and
122        that  it should repaint special features such as pads that
123        cannot be done automatically.
124
125        If the environment variables <STRONG>LINES</STRONG>  or  <STRONG>COLUMNS</STRONG>  are  set,
126        this  overrides  the  library's  use  of  the  window size
127        obtained from the operating system.  Thus, even if a  SIG-
128        WINCH is received, no screen size change may be recorded.
129
130
131 </PRE>
132 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
133        <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>.
134
135
136 </PRE>
137 <H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
138        Thomas Dickey (from an equivalent function written in 1988
139        for BSD curses).
140
141
142
143                                                          <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>
144 </PRE>
145 <div class="nav">
146 <ul>
147 <li><a href="#h2-NAME">NAME</a></li>
148 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
149 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
150 <ul>
151 <li><a href="#h3-resizeterm">resizeterm</a></li>
152 <li><a href="#h3-resize_term">resize_term</a></li>
153 <li><a href="#h3-is_term_resized">is_term_resized</a></li>
154 </ul>
155 </li>
156 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
157 <li><a href="#h2-NOTES">NOTES</a></li>
158 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
159 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
160 </ul>
161 </div>
162 </BODY>
163 </HTML>