2 ****************************************************************************
3 * Copyright 2018-2019,2020 Thomas E. Dickey *
4 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: panel.3x,v 1.39 2020/02/15 21:06:40 tom Exp @
49 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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">
59 <H1 class="no-header">panel 3X</H1>
61 <B><A HREF="panel.3X.html">panel(3X)</A></B> <B><A HREF="panel.3X.html">panel(3X)</A></B>
66 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
67 panel - panel stack extension for curses
70 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
71 <B>#include</B> <B><panel.h></B>
73 <B>cc</B> <B>[flags]</B> <B>sourcefiles</B> <B>-lpanel</B> <B>-lncurses</B>
75 <B>PANEL</B> <B>*new_panel(WINDOW</B> <B>*</B><I>win</I><B>);</B>
77 <B>int</B> <B>bottom_panel(PANEL</B> <B>*</B><I>pan</I><B>);</B>
78 <B>int</B> <B>top_panel(PANEL</B> <B>*</B><I>pan</I><B>);</B>
79 <B>int</B> <B>show_panel(PANEL</B> <B>*</B><I>pan</I><B>);</B>
80 <B>void</B> <B>update_panels(void);</B>
81 <B>int</B> <B>hide_panel(PANEL</B> <B>*</B><I>pan</I><B>);</B>
83 <B>WINDOW</B> <B>*panel_window(const</B> <B>PANEL</B> <B>*</B><I>pan</I><B>);</B>
84 <B>int</B> <B>replace_panel(PANEL</B> <B>*</B><I>pan</I><B>,</B> <B>WINDOW</B> <B>*</B><I>window</I><B>);</B>
85 <B>int</B> <B>move_panel(PANEL</B> <B>*</B><I>pan</I><B>,</B> <B>int</B> <I>starty</I><B>,</B> <B>int</B> <I>startx</I><B>);</B>
86 <B>int</B> <B>panel_hidden(const</B> <B>PANEL</B> <B>*</B><I>pan</I><B>);</B>
88 <B>PANEL</B> <B>*panel_above(const</B> <B>PANEL</B> <B>*</B><I>pan</I><B>);</B>
89 <B>PANEL</B> <B>*panel_below(const</B> <B>PANEL</B> <B>*</B><I>pan</I><B>);</B>
91 <B>int</B> <B>set_panel_userptr(PANEL</B> <B>*</B><I>pan</I><B>,</B> <B>const</B> <B>void</B> <B>*</B><I>ptr</I><B>);</B>
92 <B>const</B> <B>void</B> <B>*panel_userptr(const</B> <B>PANEL</B> <B>*</B><I>pan</I><B>);</B>
94 <B>int</B> <B>del_panel(PANEL</B> <B>*</B><I>pan</I><B>);</B>
96 /* ncurses-extensions */
97 <B>PANEL</B> <B>*ground_panel(SCREEN</B> <B>*</B><I>sp</I><B>);</B>
98 <B>PANEL</B> <B>*ceiling_panel(SCREEN</B> <B>*</B><I>sp</I><B>);</B>
101 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
102 Panels are <B><A HREF="curses.3X.html">curses(3X)</A></B> windows with the added feature of depth. Panel
103 functions allow the use of stacked windows and ensure the proper
104 portions of each window and the curses <B>stdscr</B> window are hidden or
105 displayed when panels are added, moved, modified or removed. The set
106 of currently visible panels is the stack of panels. The <B>stdscr</B> window
107 is beneath all panels, and is not considered part of the stack.
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.
113 Panel routines are a functional layer added to <B><A HREF="curses.3X.html">curses(3X)</A></B>, make only
114 high-level curses calls, and work anywhere terminfo curses does.
117 </PRE><H2><a name="h2-FUNCTIONS">FUNCTIONS</a></H2><PRE>
119 </PRE><H3><a name="h3-bottom_panel">bottom_panel</a></H3><PRE>
120 <B>bottom_panel(</B><I>pan</I><B>)</B> puts panel <I>pan</I> at the bottom of all panels.
123 </PRE><H3><a name="h3-ceiling_panel">ceiling_panel</a></H3><PRE>
124 <B>ceiling_panel(</B><I>sp</I><B>)</B> acts like <B>panel_below(NULL)</B>, for the given <B>SCREEN</B> <I>sp</I>.
127 </PRE><H3><a name="h3-del_panel">del_panel</a></H3><PRE>
128 <B>del_panel(</B><I>pan</I><B>)</B> removes the given panel <I>pan</I> from the stack and
129 deallocates the <B>PANEL</B> structure (but not its associated window).
132 </PRE><H3><a name="h3-ground_panel">ground_panel</a></H3><PRE>
133 <B>ground_panel(</B><I>sp</I><B>)</B> acts like <B>panel_above(NULL)</B>, for the given <B>SCREEN</B> <I>sp</I>.
136 </PRE><H3><a name="h3-hide_panel">hide_panel</a></H3><PRE>
137 <B>hide_panel(</B><I>pan</I><B>)</B> removes the given panel <I>pan</I> from the panel stack and
138 thus hides it from view. The <B>PANEL</B> structure is not lost, merely
139 removed from the stack.
142 </PRE><H3><a name="h3-move_panel">move_panel</a></H3><PRE>
143 <B>move_panel(</B><I>pan</I><B>,</B><I>starty</I><B>,</B><I>startx</I><B>)</B> moves the given panel <I>pan</I>'s window so
144 that its upper-left corner is at <I>starty</I>, <I>startx</I>. It does not change
145 the position of the panel in the stack. Be sure to use this function,
146 not <B><A HREF="curs_window.3X.html">mvwin(3X)</A></B>, to move a panel window.
149 </PRE><H3><a name="h3-new_panel">new_panel</a></H3><PRE>
150 <B>new_panel(</B><I>win</I><B>)</B> allocates a <B>PANEL</B> structure, associates it with <I>win</I>,
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.
155 </PRE><H3><a name="h3-panel_above">panel_above</a></H3><PRE>
156 <B>panel_above(</B><I>pan</I><B>)</B> returns a pointer to the panel above <I>pan</I>. If the
157 panel argument is <B>(PANEL</B> <B>*)0</B>, it returns a pointer to the bottom panel
161 </PRE><H3><a name="h3-panel_below">panel_below</a></H3><PRE>
162 <B>panel_below(</B><I>pan</I><B>)</B> returns a pointer to the panel just below <I>pan</I>. If the
163 panel argument is <B>(PANEL</B> <B>*)0</B>, it returns a pointer to the top panel in
167 </PRE><H3><a name="h3-panel_hidden">panel_hidden</a></H3><PRE>
168 <B>panel_hidden(</B><I>pan</I><B>)</B> returns <B>TRUE</B> if the panel <I>pan</I> is in the panel stack,
169 <B>FALSE</B> if it is not. If the panel is a null pointer, return <B>ERR</B>.
172 </PRE><H3><a name="h3-panel_userptr">panel_userptr</a></H3><PRE>
173 <B>panel_userptr(</B><I>pan</I><B>)</B> returns the user pointer for a given panel <I>pan</I>.
176 </PRE><H3><a name="h3-panel_window">panel_window</a></H3><PRE>
177 <B>panel_window(</B><I>pan</I><B>)</B> returns a pointer to the window of the given panel
181 </PRE><H3><a name="h3-replace_panel">replace_panel</a></H3><PRE>
182 <B>replace_panel(</B><I>pan</I><B>,</B><I>window</I><B>)</B> replaces the current window of panel <I>pan</I> with
183 <I>window</I> This is useful, for example if you want to resize a panel. In
184 <B>ncurses</B>, you can call <B>replace_panel</B> to resize a panel using a window
185 resized with <B><A HREF="wresize.3X.html">wresize(3X)</A></B>. It does not change the position of the panel
189 </PRE><H3><a name="h3-set_panel_userptr">set_panel_userptr</a></H3><PRE>
190 <B>set_panel_userptr(</B><I>pan</I><B>,</B><I>ptr</I><B>)</B> sets the panel's user pointer.
193 </PRE><H3><a name="h3-show_panel">show_panel</a></H3><PRE>
194 <B>show_panel(</B><I>pan</I><B>)</B> makes a hidden panel visible by placing it on top of
195 the panels in the panel stack. See <B>COMPATIBILITY</B> below.
198 </PRE><H3><a name="h3-top_panel">top_panel</a></H3><PRE>
199 <B>top_panel(</B><I>pan</I><B>)</B> puts the given visible panel <I>pan</I> on top of all panels in
200 the stack. See <B>COMPATIBILITY</B> below.
203 </PRE><H3><a name="h3-update_panels">update_panels</a></H3><PRE>
204 <B>update_panels()</B> refreshes the <I>virtual</I> <I>screen</I> to reflect the relations
205 between the panels in the stack, but does not call <B><A HREF="curs_refresh.3X.html">doupdate(3X)</A></B> to
206 refresh the <I>physical</I> <I>screen</I>. Use this function and not <B><A HREF="curs_refresh.3X.html">wrefresh(3X)</A></B> or
207 <B><A HREF="curs_refresh.3X.html">wnoutrefresh(3X)</A></B>.
209 <B>update_panels</B> may be called more than once before a call to <B>doupdate</B>,
210 but <B>doupdate</B> is the function responsible for updating the <I>physical</I>
214 </PRE><H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></H2><PRE>
215 Each routine that returns a pointer returns <B>NULL</B> if an error occurs.
216 Each routine that returns an int value returns <B>OK</B> if it executes
217 successfully and <B>ERR</B> if not.
219 Except as noted, the <I>pan</I> and <I>window</I> parameters must be non-null. If
220 those are null, an error is returned.
222 The <B>move_panel</B> function uses <B><A HREF="curs_window.3X.html">mvwin(3X)</A></B>, and will return an error if
223 <B>mvwin</B> returns an error.
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 <B>PANEL</B> data structures are merely similar. The programmer is
231 cautioned not to directly use <B>PANEL</B> fields.
233 The functions <B>show_panel</B> and <B>top_panel</B> are identical in this
234 implementation, and work equally well with displayed or hidden panels.
235 In the native System V implementation, <B>show_panel</B> is intended for
236 making a hidden panel visible (at the top of the stack) and <B>top_panel</B>
237 is 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
239 compatibility with native panel libraries.
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).
248 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
249 The panel facility was documented in SVr4.2 in <I>Character</I> <I>User</I> <I>Interface</I>
250 <I>Programming</I> <I>(UNIX</I> <I>SVR4.2)</I>.
252 It is not part of X/Open Curses.
254 A few implementations exist:
256 <B>o</B> Systems based on SVr4 source code, e.g., Solaris, provide this
259 <B>o</B> <B>ncurses</B> (since version 0.6 in 1993) and <B>PDCurses</B> (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 <I>u386mon</I> 2.20
264 According to Tucker, the SystemV panel library was first released
265 in SVr3.2 (1988), and his implementation helped with a port to
268 Several developers have improved each of these; they are no longer
269 the same as Tucker's implementation.
271 <B>o</B> NetBSD 8 (2018) has a panel library begun by Valery Ushakov in
272 2015. This is based on the AT&T documentation.
275 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
276 panel.h interface for the panels library
278 libpanel.a the panels library itself
281 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
282 <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>,
284 This describes <B>ncurses</B> version 6.2 (patch 20210612).
287 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
288 Originally written by Warren Tucker <wht@n4hgf.mt-park.ga.us>,
289 primarily to assist in porting <I>u386mon</I> to systems without a native
292 Repackaged for ncurses by Zeyd ben-Halim.
294 Juergen Pfeifer and Thomas E. Dickey revised/improved the library.
298 <B><A HREF="panel.3X.html">panel(3X)</A></B>
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>
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>
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>