blob: 58ad42d26efe6d24c844a71d5c6e1191d887a22a [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -04001<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05302 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -04003 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05305 * *
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 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -040030 * @Id: panel.3x,v 1.63 2024/03/16 15:35:01 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053031-->
Steve Kondikae271bc2015-11-15 02:50:53 +010032<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053033<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +010035<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
micky3879b9f5e72025-07-08 18:04:53 -040036<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37<TITLE>panel 3x 2024-03-16 ncurses 6.5 Library calls</TITLE>
38<link rel="author" href="mailto:bug-ncurses@gnu.org">
39
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053040</HEAD>
41<BODY>
micky3879b9f5e72025-07-08 18:04:53 -040042<H1 class="no-header">panel 3x 2024-03-16 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053043<PRE>
micky3879b9f5e72025-07-08 18:04:53 -040044<STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG> Library calls <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053045
46
47
48
micky3879b9f5e72025-07-08 18:04:53 -040049</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 panel - panel stack extension for <EM>curses</EM>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053051
52
micky3879b9f5e72025-07-08 18:04:53 -040053</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053054 <STRONG>#include</STRONG> <STRONG>&lt;panel.h&gt;</STRONG>
55
micky3879b9f5e72025-07-08 18:04:53 -040056 <STRONG>PANEL</STRONG> <STRONG>*new_panel(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053057
micky3879b9f5e72025-07-08 18:04:53 -040058 <STRONG>int</STRONG> <STRONG>bottom_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>top_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>show_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
61 <STRONG>void</STRONG> <STRONG>update_panels(void);</STRONG>
62 <STRONG>int</STRONG> <STRONG>hide_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
63
64 <STRONG>WINDOW</STRONG> <STRONG>*panel_window(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
65 <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>
66 <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>
67 <STRONG>int</STRONG> <STRONG>panel_hidden(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
68
69 <STRONG>PANEL</STRONG> <STRONG>*panel_above(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
70 <STRONG>PANEL</STRONG> <STRONG>*panel_below(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
71
72 <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>
73 <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*panel_userptr(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
74
75 <STRONG>int</STRONG> <STRONG>del_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
76
77 <EM>/*</EM> <EM>ncurses</EM> <EM>extensions</EM> <EM>*/</EM>
78 <STRONG>PANEL</STRONG> <STRONG>*ground_panel(SCREEN</STRONG> <STRONG>*</STRONG><EM>sp</EM><STRONG>);</STRONG>
79 <STRONG>PANEL</STRONG> <STRONG>*ceiling_panel(SCREEN</STRONG> <STRONG>*</STRONG><EM>sp</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053080
81
micky3879b9f5e72025-07-08 18:04:53 -040082</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
83 Panels are <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> windows with the added property of depth. Panel
84 functions allow the use of stacked windows and ensure that the proper
85 portions of each window and the <EM>curses</EM> <STRONG>stdscr</STRONG> window are hidden or
86 displayed when panels are added, moved, modified, or removed. The set
87 of currently visible panels is the stack of panels. The <STRONG>stdscr</STRONG> window
88 is beneath all panels, and is not considered part of the stack.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053089
micky3879b9f5e72025-07-08 18:04:53 -040090 A window is associated with each panel. The panel routines enable you
91 to create, move, hide, and show panels. You can relocate a panel to
92 any desired position in the stack.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053093
micky3879b9f5e72025-07-08 18:04:53 -040094 Panel routines are a functional layer added to <EM>curses</EM>, make only high-
95 level <EM>curses</EM> calls, and work anywhere <EM>curses</EM> does.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053096
97
micky3879b9f5e72025-07-08 18:04:53 -040098</PRE><H2><a name="h2-FUNCTIONS">FUNCTIONS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053099
micky3879b9f5e72025-07-08 18:04:53 -0400100</PRE><H3><a name="h3-bottom_panel">bottom_panel</a></H3><PRE>
101 <STRONG>bottom_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> puts panel <EM>pan</EM> at the bottom of all panels.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530102
103
micky3879b9f5e72025-07-08 18:04:53 -0400104</PRE><H3><a name="h3-ceiling_panel">ceiling_panel</a></H3><PRE>
105 <STRONG>ceiling_panel(</STRONG><EM>sp</EM><STRONG>)</STRONG> acts like <STRONG>panel_below(NULL)</STRONG> for the given <EM>SCREEN</EM> <EM>sp</EM>.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530106
107
micky3879b9f5e72025-07-08 18:04:53 -0400108</PRE><H3><a name="h3-del_panel">del_panel</a></H3><PRE>
109 <STRONG>del_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> removes the given panel <EM>pan</EM> from the stack and
110 deallocates the <EM>PANEL</EM> structure (but not its associated window).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530111
112
micky3879b9f5e72025-07-08 18:04:53 -0400113</PRE><H3><a name="h3-ground_panel">ground_panel</a></H3><PRE>
114 <STRONG>ground_panel(</STRONG><EM>sp</EM><STRONG>)</STRONG> acts like <STRONG>panel_above(NULL)</STRONG> for the given <EM>SCREEN</EM> <EM>sp</EM>.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530115
116
micky3879b9f5e72025-07-08 18:04:53 -0400117</PRE><H3><a name="h3-hide_panel">hide_panel</a></H3><PRE>
118 <STRONG>hide_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> removes the given panel <EM>pan</EM> from the panel stack and
119 thus hides it from view. The <EM>PANEL</EM> structure is not lost, merely
120 removed from the stack.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530121
122
micky3879b9f5e72025-07-08 18:04:53 -0400123</PRE><H3><a name="h3-move_panel">move_panel</a></H3><PRE>
124 <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
125 that its upper-left corner is at <EM>starty</EM>, <EM>startx</EM>. It does not change
126 the position of the panel in the stack. Be sure to use this function,
127 not <STRONG><A HREF="curs_window.3x.html">mvwin(3x)</A></STRONG>, to move a panel window.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530128
129
micky3879b9f5e72025-07-08 18:04:53 -0400130</PRE><H3><a name="h3-new_panel">new_panel</a></H3><PRE>
131 <STRONG>new_panel(</STRONG><EM>win</EM><STRONG>)</STRONG> allocates a <EM>PANEL</EM> structure, associates it with <EM>win</EM>,
132 places the panel on the top of the stack (causes it to be displayed
133 above any other panel) and returns a pointer to the new panel.
134
135
136</PRE><H3><a name="h3-panel_above">panel_above</a></H3><PRE>
137 <STRONG>panel_above(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns a pointer to the panel above <EM>pan</EM>. If the
138 panel argument is "<STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>", it returns a pointer to the bottom
139 panel in the stack.
140
141
142</PRE><H3><a name="h3-panel_below">panel_below</a></H3><PRE>
143 <STRONG>panel_below(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns a pointer to the panel just below <EM>pan</EM>. If the
144 panel argument is "<STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>", it returns a pointer to the top panel
145 in the stack.
146
147
148</PRE><H3><a name="h3-panel_hidden">panel_hidden</a></H3><PRE>
149 <STRONG>panel_hidden(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns <STRONG>FALSE</STRONG> if the panel <EM>pan</EM> is in the panel stack,
150 and <STRONG>TRUE</STRONG> if it is not. If the panel is a null pointer, it returns <STRONG>ERR</STRONG>.
151
152
153</PRE><H3><a name="h3-panel_userptr">panel_userptr</a></H3><PRE>
154 <STRONG>panel_userptr(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns the user pointer for a given panel <EM>pan</EM>.
155
156
157</PRE><H3><a name="h3-panel_window">panel_window</a></H3><PRE>
158 <STRONG>panel_window(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns a pointer to the window of the given panel
159 <EM>pan</EM>.
160
161
162</PRE><H3><a name="h3-replace_panel">replace_panel</a></H3><PRE>
163 <STRONG>replace_panel(</STRONG><EM>pan</EM><STRONG>,</STRONG> <EM>window</EM><STRONG>)</STRONG> replaces the current window of panel <EM>pan</EM>
164 with <EM>window</EM> This is useful if, for example, you want to resize a panel.
165 In <EM>ncurses</EM>, you can call <STRONG>replace_panel</STRONG> to resize a panel using a window
166 resized with <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>. It does not change the position of the panel
167 in the stack.
168
169
170</PRE><H3><a name="h3-set_panel_userptr">set_panel_userptr</a></H3><PRE>
171 <STRONG>set_panel_userptr(</STRONG><EM>pan</EM><STRONG>,</STRONG> <EM>ptr</EM><STRONG>)</STRONG> sets the panel's user pointer.
172
173
174</PRE><H3><a name="h3-show_panel">show_panel</a></H3><PRE>
175 <STRONG>show_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> makes a hidden panel visible by placing it on top of
176 the panels in the panel stack. See "PORTABILITY" below.
177
178
179</PRE><H3><a name="h3-top_panel">top_panel</a></H3><PRE>
180 <STRONG>top_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> puts the given visible panel <EM>pan</EM> on top of all panels in
181 the stack. See "PORTABILITY" below.
182
183
184</PRE><H3><a name="h3-update_panels">update_panels</a></H3><PRE>
185 <STRONG>update_panels()</STRONG> refreshes the virtual screen to reflect the relations
186 between the panels in the stack, but does not call <STRONG><A HREF="curs_refresh.3x.html">doupdate(3x)</A></STRONG> to
187 refresh the physical screen. Use this function and not <STRONG><A HREF="curs_refresh.3x.html">wrefresh(3x)</A></STRONG> or
188 <STRONG><A HREF="curs_refresh.3x.html">wnoutrefresh(3x)</A></STRONG>.
189
190 <STRONG>update_panels</STRONG> may be called more than once before a call to <STRONG>doupdate</STRONG>,
191 but <STRONG>doupdate</STRONG> is the function responsible for updating the physical
192 screen.
193
194
195</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
196 Each routine that returns a pointer returns <STRONG>NULL</STRONG> if an error occurs.
197 Each routine that returns an int value returns <STRONG>OK</STRONG> if it executes
198 successfully and <STRONG>ERR</STRONG> if not.
199
200 Except as noted, the <EM>pan</EM> and <EM>window</EM> parameters must be non-null. If
201 either is null, an error is returned.
202
203 The <STRONG>move_panel</STRONG> function uses <STRONG><A HREF="curs_window.3x.html">mvwin(3x)</A></STRONG>, and returns an error if <STRONG>mvwin</STRONG>
204 returns an error.
205
206
207</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
208 The header file <EM>panel.h</EM> itself includes the header file <EM>curses.h</EM>.
209
210
211</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
212 Reasonable care has been taken to ensure compatibility with the native
213 panel facility introduced in System V; inspection of the SVr4 manual
214 pages suggests the programming interface never changed. The <EM>PANEL</EM> data
215 structures are merely similar. The programmer is cautioned not to
216 directly use <EM>PANEL</EM> fields.
217
218 The functions <STRONG>show_panel</STRONG> and <STRONG>top_panel</STRONG> are identical in this
219 implementation, and work equally well with displayed or hidden panels.
220 In the System V implementation, <STRONG>show_panel</STRONG> is intended for making a
221 hidden panel visible (at the top of the stack) and <STRONG>top_panel</STRONG> is
222 intended for making an already-visible panel move to the top of the
223 stack. You are cautioned to use the correct function to ensure
224 compatibility with System V panel libraries.
225
226
227</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
228 A panel facility was documented in SVr4.2's <EM>Character</EM> <EM>User</EM> <EM>Interface</EM>
229 <EM>Programming</EM> document.
230
231 It is not part of X/Open Curses.
232
233 A few implementations exist:
234
235 <STRONG>o</STRONG> Systems based on SVr4 source code, such as Solaris, provide this
236 library.
237
238 <STRONG>o</STRONG> <EM>ncurses</EM> (since version 0.6 in 1993) and <EM>PDCurses</EM> (since version 2.2
239 in 1995) provide a panel library whose common ancestor is a public
240 domain implementation by Warren Tucker published in <EM>u386mon</EM> 2.20
241 (1990).
242
243 According to Tucker, the System V panel library was first released
244 in SVr3.2 (1988), and his implementation helped with a port to
245 SVr3.1 (1987).
246
247 Several developers have improved each of these; they are no longer
248 the same as Tucker's implementation.
249
250 <STRONG>o</STRONG> NetBSD 8 (2018) has a panel library begun by Valery Ushakov in
251 2015, based on the System V documentation.
252
253
254</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
255 Warren Tucker &lt;wht@n4hgf.mt-park.ga.us&gt; originally wrote this
256 implementation, primarily to assist in porting <EM>u386mon</EM> to systems
257 without a native panel library.
258
259 Zeyd ben-Halim repackaged it for <EM>ncurses</EM>.
260
261 Juergen Pfeifer and Thomas E. Dickey revised and improved the library.
262
263
264</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
265 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530266
267
268
micky3879b9f5e72025-07-08 18:04:53 -0400269ncurses 6.5 2024-03-16 <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530270</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100271<div class="nav">
272<ul>
273<li><a href="#h2-NAME">NAME</a></li>
274<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
275<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
micky3879b9f5e72025-07-08 18:04:53 -0400276<li><a href="#h2-FUNCTIONS">FUNCTIONS</a>
277<ul>
278<li><a href="#h3-bottom_panel">bottom_panel</a></li>
279<li><a href="#h3-ceiling_panel">ceiling_panel</a></li>
280<li><a href="#h3-del_panel">del_panel</a></li>
281<li><a href="#h3-ground_panel">ground_panel</a></li>
282<li><a href="#h3-hide_panel">hide_panel</a></li>
283<li><a href="#h3-move_panel">move_panel</a></li>
284<li><a href="#h3-new_panel">new_panel</a></li>
285<li><a href="#h3-panel_above">panel_above</a></li>
286<li><a href="#h3-panel_below">panel_below</a></li>
287<li><a href="#h3-panel_hidden">panel_hidden</a></li>
288<li><a href="#h3-panel_userptr">panel_userptr</a></li>
289<li><a href="#h3-panel_window">panel_window</a></li>
290<li><a href="#h3-replace_panel">replace_panel</a></li>
291<li><a href="#h3-set_panel_userptr">set_panel_userptr</a></li>
292<li><a href="#h3-show_panel">show_panel</a></li>
293<li><a href="#h3-top_panel">top_panel</a></li>
294<li><a href="#h3-update_panels">update_panels</a></li>
295</ul>
296</li>
297<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
298<li><a href="#h2-NOTES">NOTES</a></li>
299<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
300<li><a href="#h2-HISTORY">HISTORY</a></li>
301<li><a href="#h2-AUTHORS">AUTHORS</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100302<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100303</ul>
304</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530305</BODY>
306</HTML>