ncurses 6.2 - patch 20201017
[ncurses.git] / doc / html / man / panel.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: panel.3x,v 1.39 2020/02/15 21:06:40 tom Exp @
31   * ---------
32   * ---------
33   * ---------
34   * ---------
35   * ---------
36   * ---------
37   * ---------
38   * ---------
39   * ---------
40   * ---------
41   * ---------
42   * ---------
43   * ---------
44   * ---------
45   * ---------
46   * ---------
47   * ---------
48 -->
49 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
50 <HTML>
51 <HEAD>
52 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
53 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
54 <TITLE>panel 3x</TITLE>
55 <link rel="author" href="mailto:bug-ncurses@gnu.org">
56 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
57 </HEAD>
58 <BODY>
59 <H1 class="no-header">panel 3x</H1>
60 <PRE>
61 <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>                                                            <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
62
63
64
65
66 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
67        panel - panel stack extension for curses
68
69
70 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
71        <STRONG>#include</STRONG> <STRONG>&lt;panel.h&gt;</STRONG>
72
73        <STRONG>cc</STRONG> <STRONG>[flags]</STRONG> <STRONG>sourcefiles</STRONG> <STRONG>-lpanel</STRONG> <STRONG>-lncurses</STRONG>
74
75        <STRONG>PANEL</STRONG> <STRONG>*new_panel(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
76
77        <STRONG>int</STRONG> <STRONG>bottom_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
78        <STRONG>int</STRONG> <STRONG>top_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
79        <STRONG>int</STRONG> <STRONG>show_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
80        <STRONG>void</STRONG> <STRONG>update_panels(void);</STRONG>
81        <STRONG>int</STRONG> <STRONG>hide_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
82
83        <STRONG>WINDOW</STRONG> <STRONG>*panel_window(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
84        <STRONG>int</STRONG> <STRONG>replace_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>window</EM><STRONG>);</STRONG>
85        <STRONG>int</STRONG> <STRONG>move_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>starty</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>startx</EM><STRONG>);</STRONG>
86        <STRONG>int</STRONG> <STRONG>panel_hidden(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
87
88        <STRONG>PANEL</STRONG> <STRONG>*panel_above(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
89        <STRONG>PANEL</STRONG> <STRONG>*panel_below(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
90
91        <STRONG>int</STRONG> <STRONG>set_panel_userptr(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>ptr</EM><STRONG>);</STRONG>
92        <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*panel_userptr(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
93
94        <STRONG>int</STRONG> <STRONG>del_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
95
96        /* ncurses-extensions */
97        <STRONG>PANEL</STRONG> <STRONG>*ground_panel(SCREEN</STRONG> <STRONG>*</STRONG><EM>sp</EM><STRONG>);</STRONG>
98        <STRONG>PANEL</STRONG> <STRONG>*ceiling_panel(SCREEN</STRONG> <STRONG>*</STRONG><EM>sp</EM><STRONG>);</STRONG>
99
100
101 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
102        Panels  are  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> windows with the added feature of depth.  Panel
103        functions allow the use of stacked windows and ensure the  proper  por-
104        tions  of  each  window and the curses <STRONG>stdscr</STRONG> window are hidden or dis-
105        played when panels are added, moved, modified or removed.  The  set  of
106        currently  visible panels is the stack of panels.  The <STRONG>stdscr</STRONG> window is
107        beneath all panels, and is not considered part of the stack.
108
109        A window is associated with every panel.  The panel routines enable you
110        to  create, move, hide, and show panels, as well as position a panel at
111        any desired location in the stack.
112
113        Panel routines are a functional layer added to  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,  make  only
114        high-level curses calls, and work anywhere terminfo curses does.
115
116
117 </PRE><H2><a name="h2-FUNCTIONS">FUNCTIONS</a></H2><PRE>
118
119 </PRE><H3><a name="h3-bottom_panel">bottom_panel</a></H3><PRE>
120        <STRONG>bottom_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> puts panel <EM>pan</EM> at the bottom of all panels.
121
122
123 </PRE><H3><a name="h3-ceiling_panel">ceiling_panel</a></H3><PRE>
124        <STRONG>ceiling_panel(</STRONG><EM>sp</EM><STRONG>)</STRONG> acts like <STRONG>panel_below(NULL)</STRONG>, for the given <STRONG>SCREEN</STRONG> <EM>sp</EM>.
125
126
127 </PRE><H3><a name="h3-del_panel">del_panel</a></H3><PRE>
128        <STRONG>del_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG>  removes the given panel <EM>pan</EM> from the  stack and deallo-
129        cates the <STRONG>PANEL</STRONG> structure (but not its associated window).
130
131
132 </PRE><H3><a name="h3-ground_panel">ground_panel</a></H3><PRE>
133        <STRONG>ground_panel(</STRONG><EM>sp</EM><STRONG>)</STRONG> acts like <STRONG>panel_above(NULL)</STRONG>, for the given <STRONG>SCREEN</STRONG> <EM>sp</EM>.
134
135
136 </PRE><H3><a name="h3-hide_panel">hide_panel</a></H3><PRE>
137        <STRONG>hide_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> removes the given panel <EM>pan</EM> from the  panel  stack  and
138        thus  hides  it  from  view.   The  <STRONG>PANEL</STRONG> structure is not lost, merely
139        removed from the stack.
140
141
142 </PRE><H3><a name="h3-move_panel">move_panel</a></H3><PRE>
143        <STRONG>move_panel(</STRONG><EM>pan</EM><STRONG>,</STRONG><EM>starty</EM><STRONG>,</STRONG><EM>startx</EM><STRONG>)</STRONG> moves the given  panel  <EM>pan</EM>'s  window  so
144        that  its  upper-left  corner is at <EM>starty</EM>, <EM>startx</EM>.  It does not change
145        the position of the panel in the stack.  Be sure to use this  function,
146        not <STRONG><A HREF="curs_window.3x.html">mvwin(3x)</A></STRONG>, to move a panel window.
147
148
149 </PRE><H3><a name="h3-new_panel">new_panel</a></H3><PRE>
150        <STRONG>new_panel(</STRONG><EM>win</EM><STRONG>)</STRONG>  allocates   a  <STRONG>PANEL</STRONG> structure, associates it with <EM>win</EM>,
151        places the panel on the top of the stack (causes  it to  be   displayed
152        above any other panel) and returns a pointer to the new panel.
153
154
155 </PRE><H3><a name="h3-panel_above">panel_above</a></H3><PRE>
156        <STRONG>panel_above(</STRONG><EM>pan</EM><STRONG>)</STRONG>  returns  a  pointer  to  the panel above <EM>pan</EM>.  If the
157        panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a pointer to the bottom  panel
158        in the stack.
159
160
161 </PRE><H3><a name="h3-panel_below">panel_below</a></H3><PRE>
162        <STRONG>panel_below(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns a pointer to the panel just below <EM>pan</EM>.  If the
163        panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a pointer to the top panel  in
164        the stack.
165
166
167 </PRE><H3><a name="h3-panel_hidden">panel_hidden</a></H3><PRE>
168        <STRONG>panel_hidden(</STRONG><EM>pan</EM><STRONG>)</STRONG>  returns <STRONG>TRUE</STRONG> if the panel <EM>pan</EM> is in the panel stack,
169        <STRONG>FALSE</STRONG> if it is not.  If the panel is a null pointer, return <STRONG>ERR</STRONG>.
170
171
172 </PRE><H3><a name="h3-panel_userptr">panel_userptr</a></H3><PRE>
173        <STRONG>panel_userptr(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns the user pointer for a given panel <EM>pan</EM>.
174
175
176 </PRE><H3><a name="h3-panel_window">panel_window</a></H3><PRE>
177        <STRONG>panel_window(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns a pointer to the window of  the  given  panel
178        <EM>pan</EM>.
179
180
181 </PRE><H3><a name="h3-replace_panel">replace_panel</a></H3><PRE>
182        <STRONG>replace_panel(</STRONG><EM>pan</EM><STRONG>,</STRONG><EM>window</EM><STRONG>)</STRONG> replaces the current window of panel <EM>pan</EM> with
183        <EM>window</EM> This is useful, for example if you want to resize a  panel.   In
184        <STRONG>ncurses</STRONG>,  you  can  call <STRONG>replace_panel</STRONG> to resize a panel using a window
185        resized with <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.  It does not change the position of the panel
186        in the stack.
187
188
189 </PRE><H3><a name="h3-set_panel_userptr">set_panel_userptr</a></H3><PRE>
190        <STRONG>set_panel_userptr(</STRONG><EM>pan</EM><STRONG>,</STRONG><EM>ptr</EM><STRONG>)</STRONG> sets the panel's user pointer.
191
192
193 </PRE><H3><a name="h3-show_panel">show_panel</a></H3><PRE>
194        <STRONG>show_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG>  makes  a  hidden panel visible by placing it on top of
195        the panels in the panel stack.  See <STRONG>COMPATIBILITY</STRONG> below.
196
197
198 </PRE><H3><a name="h3-top_panel">top_panel</a></H3><PRE>
199        <STRONG>top_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> puts the given visible panel <EM>pan</EM> on top of all panels in
200        the stack.  See <STRONG>COMPATIBILITY</STRONG> below.
201
202
203 </PRE><H3><a name="h3-update_panels">update_panels</a></H3><PRE>
204        <STRONG>update_panels()</STRONG>  refreshes  the <EM>virtual</EM> <EM>screen</EM> to reflect the relations
205        between the panels in the stack, but  does  not  call  <STRONG><A HREF="curs_refresh.3x.html">doupdate(3x)</A></STRONG>  to
206        refresh the <EM>physical</EM> <EM>screen</EM>.  Use this function and not <STRONG><A HREF="curs_refresh.3x.html">wrefresh(3x)</A></STRONG> or
207        <STRONG><A HREF="curs_refresh.3x.html">wnoutrefresh(3x)</A></STRONG>.
208
209        <STRONG>update_panels</STRONG> may be called more than once before a call  to  <STRONG>doupdate</STRONG>,
210        but  <STRONG>doupdate</STRONG>  is  the  function  responsible for updating the <EM>physical</EM>
211        <EM>screen</EM>.
212
213
214 </PRE><H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></H2><PRE>
215        Each routine that returns a pointer returns <STRONG>NULL</STRONG> if  an  error  occurs.
216        Each  routine  that returns an int value returns <STRONG>OK</STRONG> if it executes suc-
217        cessfully and <STRONG>ERR</STRONG> if not.
218
219        Except as noted, the <EM>pan</EM> and <EM>window</EM> parameters must  be  non-null.   If
220        those are null, an error is returned.
221
222        The  <STRONG>move_panel</STRONG>  function  uses  <STRONG><A HREF="curs_window.3x.html">mvwin(3x)</A></STRONG>, and will return an error if
223        <STRONG>mvwin</STRONG> returns an error.
224
225
226 </PRE><H2><a name="h2-COMPATIBILITY">COMPATIBILITY</a></H2><PRE>
227        Reasonable care has been taken  to   ensure   compatibility  with   the
228        native   panel  facility introduced in System V (inspection of the SVr4
229        manual pages suggests the programming  interface  is  unchanged).   The
230        <STRONG>PANEL</STRONG>  data  structures  are  merely  similar.  The  programmer is cau-
231        tioned not to directly use <STRONG>PANEL</STRONG> fields.
232
233        The functions <STRONG>show_panel</STRONG> and <STRONG>top_panel</STRONG> are identical in this  implemen-
234        tation,  and work equally well with displayed or hidden panels.  In the
235        native System V implementation, <STRONG>show_panel</STRONG> is  intended  for  making  a
236        hidden  panel  visible  (at  the  top  of  the  stack) and <STRONG>top_panel</STRONG> is
237        intended for making an already-visible panel move to  the  top  of  the
238        stack.  You are cautioned to use the correct function to ensure compat-
239        ibility with native panel libraries.
240
241
242 </PRE><H2><a name="h2-NOTE">NOTE</a></H2><PRE>
243        In your library list, libpanel.a should be  before  libncurses.a;  that
244        is, you should say "-lpanel -lncurses", not the other way around (which
245        would give a link-error with static libraries).
246
247
248 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
249        The panel facility was documented in SVr4.2 in <EM>Character</EM> <EM>User</EM> <EM>Interface</EM>
250        <EM>Programming</EM> <EM>(UNIX</EM> <EM>SVR4.2)</EM>.
251
252        It is not part of X/Open Curses.
253
254        A few implementations exist:
255
256        <STRONG>o</STRONG>   Systems  based  on  SVr4  source  code, e.g., Solaris, provide this
257            library.
258
259        <STRONG>o</STRONG>   <STRONG>ncurses</STRONG> (since version 0.6 in 1993) and <STRONG>PDCurses</STRONG> (since version 2.2
260            in 1995) provide a panel library whose common ancestor was a public
261            domain implementation by Warren Tucker published  in  <EM>u386mon</EM>  2.20
262            (1990).
263
264            According  to  Tucker, the SystemV panel library was first released
265            in SVr3.2 (1988), and his implementation  helped  with  a  port  to
266            SVr3.1 (1987).
267
268            Several  developers have improved each of these; they are no longer
269            the same as Tucker's implementation.
270
271        <STRONG>o</STRONG>   NetBSD 8 (2018) has a panel library  begun  by  Valery  Ushakov  in
272            2015.  This is based on the AT&amp;T documentation.
273
274
275 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
276        panel.h interface for the panels library
277
278        libpanel.a the panels library itself
279
280
281 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
282        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,
283
284        This describes <STRONG>ncurses</STRONG> version 6.2 (patch 20201017).
285
286
287 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
288        Originally  written by Warren Tucker &lt;wht@n4hgf.mt-park.ga.us&gt;, primar-
289        ily to assist in porting <EM>u386mon</EM> to systems  without  a  native  panels
290        library.
291
292        Repackaged for ncurses by Zeyd ben-Halim.
293
294        Juergen Pfeifer and Thomas E. Dickey revised/improved the library.
295
296
297
298                                                                      <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
299 </PRE>
300 <div class="nav">
301 <ul>
302 <li><a href="#h2-NAME">NAME</a></li>
303 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
304 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
305 <li><a href="#h2-FUNCTIONS">FUNCTIONS</a>
306 <ul>
307 <li><a href="#h3-bottom_panel">bottom_panel</a></li>
308 <li><a href="#h3-ceiling_panel">ceiling_panel</a></li>
309 <li><a href="#h3-del_panel">del_panel</a></li>
310 <li><a href="#h3-ground_panel">ground_panel</a></li>
311 <li><a href="#h3-hide_panel">hide_panel</a></li>
312 <li><a href="#h3-move_panel">move_panel</a></li>
313 <li><a href="#h3-new_panel">new_panel</a></li>
314 <li><a href="#h3-panel_above">panel_above</a></li>
315 <li><a href="#h3-panel_below">panel_below</a></li>
316 <li><a href="#h3-panel_hidden">panel_hidden</a></li>
317 <li><a href="#h3-panel_userptr">panel_userptr</a></li>
318 <li><a href="#h3-panel_window">panel_window</a></li>
319 <li><a href="#h3-replace_panel">replace_panel</a></li>
320 <li><a href="#h3-set_panel_userptr">set_panel_userptr</a></li>
321 <li><a href="#h3-show_panel">show_panel</a></li>
322 <li><a href="#h3-top_panel">top_panel</a></li>
323 <li><a href="#h3-update_panels">update_panels</a></li>
324 </ul>
325 </li>
326 <li><a href="#h2-DIAGNOSTICS">DIAGNOSTICS</a></li>
327 <li><a href="#h2-COMPATIBILITY">COMPATIBILITY</a></li>
328 <li><a href="#h2-NOTE">NOTE</a></li>
329 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
330 <li><a href="#h2-FILES">FILES</a></li>
331 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
332 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
333 </ul>
334 </div>
335 </BODY>
336 </HTML>