Lines Matching full:panel
30 .\" $Id: panel.3x,v 1.63 2024/03/16 15:35:01 tom Exp $
31 .TH panel 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
48 panel \-
49 panel stack extension for \fIcurses\fP
52 \fB#include <panel.h>
54 \fBPANEL *new_panel(WINDOW *\fIwin\fP);
56 \fBint bottom_panel(PANEL *\fIpan\fP);
57 \fBint top_panel(PANEL *\fIpan\fP);
58 \fBint show_panel(PANEL *\fIpan\fP);
60 \fBint hide_panel(PANEL *\fIpan\fP);
62 \fBWINDOW *panel_window(const PANEL *\fIpan\fP);
63 \fBint replace_panel(PANEL *\fIpan\fP, WINDOW *\fIwindow\fP);
64 \fBint move_panel(PANEL *\fIpan\fP, int \fIstarty\fP, int \fIstartx\fP);
65 \fBint panel_hidden(const PANEL *\fIpan\fP);
67 \fBPANEL *panel_above(const PANEL *\fIpan\fP);
68 \fBPANEL *panel_below(const PANEL *\fIpan\fP);
70 \fBint set_panel_userptr(PANEL *\fIpan\fP, const void *\fIptr\fP);
71 \fBconst void *panel_userptr(const PANEL *\fIpan\fP);
73 \fBint del_panel(PANEL *\fIpan\fP);
76 \fBPANEL *ground_panel(SCREEN *\fIsp\fP);
77 \fBPANEL *ceiling_panel(SCREEN *\fIsp\fP);
82 Panel functions allow the use of stacked windows and ensure that the
93 A window is associated with each panel.
94 The panel routines enable you to create,
98 You can relocate a panel to any desired position in the stack.
100 Panel routines are a functional layer added to \fIcurses\fP,
107 puts panel \fIpan\fP at the bottom of all panels.
116 removes the given panel \fIpan\fP from the stack and deallocates the
117 \fI\%PANEL\fP structure (but not its associated window).
126 removes the given panel \fIpan\fP from the panel stack
128 The \fI\%PANEL\fP structure is not lost,
133 moves the given panel \fIpan\fP's window so that its upper-left corner
137 It does not change the position of the panel in the stack.
140 to move a panel window.
143 \fB\%new_panel(\fIwin\fB)\fR allocates a \fI\%PANEL\fR structure,
145 places the panel on the top of the stack
146 (causes it to be displayed above any other panel)
147 and returns a pointer to the new panel.
151 returns a pointer to the panel above \fIpan\fP.
152 If the panel argument is
153 \*(``\fB(PANEL *)0\fP\*('',
154 it returns a pointer to the bottom panel in the stack.
158 returns a pointer to the panel just below \fIpan\fP.
159 If the panel argument is
160 \*(``\fB(PANEL *)0\fP\*('',
161 it returns a pointer to the top panel in the stack.
165 returns \fBFALSE\fP if the panel \fIpan\fP is in the panel stack,
167 If the panel is a null pointer,
172 returns the user pointer for a given panel \fIpan\fP.
176 returns a pointer to the window of the given panel \fIpan\fP.
180 replaces the current window of panel \fIpan\fP with \fIwindow\fP
183 you want to resize a panel.
186 to resize a panel using a window resized with \fB\%wresize\fP(3X).
187 It does not change the position of the panel in the stack.
191 sets the panel's user pointer.
195 makes a hidden panel visible by placing it on top of the panels in the
196 panel stack.
201 puts the given visible panel \fIpan\fP on top of all panels in the
231 The header file \fI\%panel.h\fP itself includes the header file
235 with the native panel facility introduced in System\ V;
238 The \fI\%PANEL\fP data structures are merely similar.
239 The programmer is cautioned not to directly use \fI\%PANEL\fP fields.
245 \fB\%show_panel\fP is intended for making a hidden panel visible
247 and \fB\%top_panel\fP is intended for making an already-visible panel
250 function to ensure compatibility with System\ V panel libraries.
252 A panel facility was documented in SVr4.2's
265 provide a panel library whose common ancestor
270 the System\ V panel library was first released in SVr3.2 (1988),
277 has a panel library begun by Valery Ushakov in 2015,
283 native panel library.