4468e1d44a4cbc48dd3d29ffdcb216b4d8397cb1
[ncurses.git] / man / panel.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: panel.3x,v 1.24 2017/11/25 20:31:13 tom Exp $
30 .TH panel 3X ""
31 .ie \n(.g .ds `` \(lq
32 .el       .ds `` ``
33 .ie \n(.g .ds '' \(rq
34 .el       .ds '' ''
35 .SH NAME
36 panel \- panel stack extension for curses
37 .SH SYNOPSIS
38 \fB#include <panel.h>\fR
39 .P
40 \fBcc [flags] sourcefiles \-lpanel \-lncurses\fR
41 .P
42 \fBPANEL *new_panel(WINDOW *win);\fR
43 .br
44 \fBint bottom_panel(PANEL *pan);\fR
45 .br
46 \fBint top_panel(PANEL *pan);\fR
47 .br
48 \fBint show_panel(PANEL *pan);\fR
49 .br
50 \fBvoid update_panels();\fR
51 .br
52 \fBint hide_panel(PANEL *pan);\fR
53 .br
54 \fBWINDOW *panel_window(const PANEL *pan);\fR
55 .br
56 \fBint replace_panel(PANEL *pan, WINDOW *window);\fR
57 .br
58 \fBint move_panel(PANEL *pan, int starty, int startx);\fR
59 .br
60 \fBint panel_hidden(const PANEL *pan);\fR
61 .br
62 \fBPANEL *panel_above(const PANEL *pan);\fR
63 .br
64 \fBPANEL *panel_below(const PANEL *pan);\fR
65 .br
66 \fBint set_panel_userptr(PANEL *pan, const void *ptr);\fR
67 .br
68 \fBconst void *panel_userptr(const PANEL *pan);\fR
69 .br
70 \fBint del_panel(PANEL *pan);\fR
71 .br
72 .SH DESCRIPTION
73 Panels are \fBcurses\fR(3X) windows with the added feature of
74 depth.  Panel functions allow the use of stacked windows and ensure
75 the proper portions of each window and the curses \fBstdscr\fR window are
76 hidden or displayed when panels are added, moved, modified or removed.
77 The set of currently visible panels is the stack of panels.  The
78 \fBstdscr\fR window is beneath all panels, and is not considered part
79 of the stack.
80 .P
81 A window is associated with every panel. The panel routines enable
82 you to create, move, hide, and show panels, as well as position a
83 panel at any desired location in the stack.
84 .P
85 Panel routines are a functional layer added to \fBcurses\fR(3X), make only
86 high-level curses calls, and work anywhere terminfo curses does.
87 .SH FUNCTIONS
88 .TP
89 .B new_panel(win)
90 allocates  a  \fBPANEL\fR structure, associates it with
91 \fBwin\fR, places the panel on the top of the stack  (causes  it
92 to  be  displayed above any other panel) and returns a
93 pointer to the new panel.
94 .TP
95 .B update_panels
96 refreshes the virtual screen to reflect the relations between the
97 panels in the stack, but does not call \fBdoupdate\fP to refresh the
98 physical screen.
99 Use this function and not \fBwrefresh\fP or \fBwnoutrefresh\fP.
100 .B update_panels
101 may be called more than once before a call to
102 \fBdoupdate\fP, but \fBdoupdate\fP is the function responsible for updating
103 the physical screen.
104 .TP
105 .B del_panel(pan)
106 removes the given panel from the  stack and deallocates the
107 \fBPANEL\fR structure (but not its associated window).
108 .TP
109 .B hide_panel(pan)
110 removes the given panel from the panel stack and thus hides it from
111 view. The \fBPANEL\fR structure is not lost, merely removed from the stack.
112 .TP
113 .B panel_hidden(pan)
114 returns \fBTRUE\fP if the panel is in the panel stack,
115 \fBFALSE\fP if it is not.
116 If the panel is a null pointer, return \fBERR\fP.
117 .TP
118 .B show_panel(pan)
119 makes a hidden panel visible by placing it on top of the panels in the
120 panel stack. See COMPATIBILITY below.
121 .TP
122 .B top_panel(pan)
123 puts the given visible panel on top of all panels in the stack.  See
124 COMPATIBILITY below.
125 .TP
126 .B bottom_panel(pan)
127 puts panel at the bottom of all panels.
128 .TP
129 .B move_panel(pan,starty,startx)
130 moves the given panel window so that its upper-left corner is at
131 \fBstarty\fR, \fBstartx\fR.  It does not change the position of the
132 panel in the stack.  Be sure to use this function, not \fBmvwin\fR,
133 to move a panel window.
134 .TP
135 .B replace_panel(pan,window)
136 replaces the current window of panel with \fBwindow\fR (useful, for
137 example if you want to resize a panel; if you're using \fBncurses\fR,
138 you can call \fBreplace_panel\fR on the output of \fBwresize\fR(3X)).
139 It does not change the position of the panel in the stack.
140 .TP
141 .B panel_above(pan)
142 returns a pointer to the panel above pan.  If the panel argument is
143 \fB(PANEL *)0\fR, it returns a pointer to the bottom panel in the stack.
144 .TP
145 .B panel_below(pan)
146 returns a pointer to the panel just below pan.  If the panel argument
147 is \fB(PANEL *)0\fR, it returns a pointer to the top panel in the stack.
148 .TP
149 .B set_panel_userptr(pan,ptr)
150 sets the panel's user pointer.
151 .TP
152 .B panel_userptr(pan)
153 returns the user pointer for a given panel.
154 .TP
155 .B panel_window(pan)
156 returns a pointer to the window of the given panel.
157 .SH DIAGNOSTICS
158 Each routine that returns a pointer returns \fBNULL\fR if an error
159 occurs. Each routine that returns an int value returns \fBOK\fR if it
160 executes successfully and \fBERR\fR if not.
161 .SH COMPATIBILITY
162 Reasonable care has been taken to  ensure  compatibility
163 with  the  native  panel facility introduced in System V (inspection of
164 the SVr4 manual pages suggests the programming interface is unchanged).
165 The \fBPANEL\fR data structures are merely  similar. The  programmer
166 is cautioned not to directly use \fBPANEL\fR fields.
167 .P
168 The functions \fBshow_panel\fR and \fBtop_panel\fR are identical
169 in this implementation, and work equally well with displayed or hidden
170 panels.  In the native System V implementation, \fBshow_panel\fR is
171 intended for making a hidden panel visible (at the top of the stack)
172 and \fBtop_panel\fR is intended for making an already-visible panel
173 move to the top of the stack. You are cautioned to use the correct
174 function to ensure compatibility with native panel libraries.
175 .SH NOTE
176 In your library list, libpanel.a should be before libncurses.a; that is,
177 you should say \*(``\-lpanel \-lncurses\*('', not the other way around
178 (which would give a link-error with static libraries).
179 .SH PORTABILITY
180 .PP
181 The panel facility was documented in SVr4.2 in
182 \fICharacter User Interface Programming (UNIX SVR4.2)\fP.
183 .PP
184 It is not part of X/Open Curses.
185 .PP
186 Aside from ncurses, only systems based on SVr4 source code,
187 e.g., Solaris provide this library.
188 .SH FILES
189 .P
190 panel.h
191 interface for the panels library
192 .P
193 libpanel.a
194 the panels library itself
195 .SH SEE ALSO
196 \fBcurses\fR(3X),
197 \fBcurs_variables\fR(3X),
198 .PP
199 This describes \fBncurses\fR
200 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
201 .SH AUTHOR
202 Originally written by Warren Tucker <wht@n4hgf.mt-park.ga.us>,
203 primarily to assist in porting u386mon to systems without a native
204 panels library.  Repackaged for ncurses by Zeyd ben-Halim.