ncurses 6.0 - patch 20170304
[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.21 2017/02/18 16:53:23 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 .ds n 5
36 .ds d @TERMINFO@
37 .SH NAME
38 panel \- panel stack extension for curses
39 .SH SYNOPSIS
40 \fB#include <panel.h>\fR
41 .P
42 \fBcc [flags] sourcefiles \-lpanel \-lncurses\fR
43 .P
44 \fBPANEL *new_panel(WINDOW *win);\fR
45 .br
46 \fBint bottom_panel(PANEL *pan);\fR
47 .br
48 \fBint top_panel(PANEL *pan);\fR
49 .br
50 \fBint show_panel(PANEL *pan);\fR
51 .br
52 \fBvoid update_panels();\fR
53 .br
54 \fBint hide_panel(PANEL *pan);\fR
55 .br
56 \fBWINDOW *panel_window(const PANEL *pan);\fR
57 .br
58 \fBint replace_panel(PANEL *pan, WINDOW *window);\fR
59 .br
60 \fBint move_panel(PANEL *pan, int starty, int startx);\fR
61 .br
62 \fBint panel_hidden(const PANEL *pan);\fR
63 .br
64 \fBPANEL *panel_above(const PANEL *pan);\fR
65 .br
66 \fBPANEL *panel_below(const PANEL *pan);\fR
67 .br
68 \fBint set_panel_userptr(PANEL *pan, const void *ptr);\fR
69 .br
70 \fBconst void *panel_userptr(const PANEL *pan);\fR
71 .br
72 \fBint del_panel(PANEL *pan);\fR
73 .br
74 .SH DESCRIPTION
75 Panels are \fBcurses\fR(3X) windows with the added feature of
76 depth.  Panel functions allow the use of stacked windows and ensure
77 the proper portions of each window and the curses \fBstdscr\fR window are
78 hidden or displayed when panels are added, moved, modified or removed.
79 The set of currently visible panels is the stack of panels.  The
80 \fBstdscr\fR window is beneath all panels, and is not considered part
81 of the stack.
82 .P
83 A window is associated with every panel. The panel routines enable
84 you to create, move, hide, and show panels, as well as position a
85 panel at any desired location in the stack.
86 .P
87 Panel routines are a functional layer added to \fBcurses\fR(3X), make only
88 high-level curses calls, and work anywhere terminfo curses does.
89 .SH FUNCTIONS
90 .TP
91 .B new_panel(win)
92 allocates  a  \fBPANEL\fR structure, associates it with
93 \fBwin\fR, places the panel on the top of the stack  (causes  it
94 to  be  displayed above any other panel) and returns a
95 pointer to the new panel.
96 .TP
97 .B update_panels
98 refreshes the virtual screen to reflect the relations between the
99 panels in the stack, but does not call \fBdoupdate\fP to refresh the
100 physical screen.
101 Use this function and not \fBwrefresh\fP or \fBwnoutrefresh\fP.
102 .B update_panels
103 may be called more than once before a call to
104 \fBdoupdate\fP, but \fBdoupdate\fP is the function responsible for updating
105 the physical screen.
106 .TP
107 .B del_panel(pan)
108 removes the given panel from the  stack and deallocates the
109 \fBPANEL\fR structure (but not its associated window).
110 .TP
111 .B hide_panel(pan)
112 removes the given panel from the panel stack and thus hides it from
113 view. The \fBPANEL\fR structure is not lost, merely removed from the stack.
114 .TP
115 .B panel_hidden(pan)
116 returns \fBTRUE\fP if the panel is in the panel stack,
117 \fBFALSE\fP if it is not.
118 If the panel is a null pointer, return ERR.
119 .TP
120 .B show_panel(pan)
121 makes a hidden panel visible by placing it on top of the panels in the
122 panel stack. See COMPATIBILITY below.
123 .TP
124 .B top_panel(pan)
125 puts the given visible panel on top of all panels in the stack.  See
126 COMPATIBILITY below.
127 .TP
128 .B bottom_panel(pan)
129 puts panel at the bottom of all panels.
130 .TP
131 .B move_panel(pan,starty,startx)
132 moves the given panel window so that its upper-left corner is at
133 \fBstarty\fR, \fBstartx\fR.  It does not change the position of the
134 panel in the stack.  Be sure to use this function, not \fBmvwin\fR,
135 to move a panel window.
136 .TP
137 .B replace_panel(pan,window)
138 replaces the current window of panel with \fBwindow\fR (useful, for
139 example if you want to resize a panel; if you're using \fBncurses\fR,
140 you can call \fBreplace_panel\fR on the output of \fBwresize\fR(3X)).
141 It does not change the position of the panel in the stack.
142 .TP
143 .B panel_above(pan)
144 returns a pointer to the panel above pan.  If the panel argument is
145 \fB(PANEL *)0\fR, it returns a pointer to the bottom panel in the stack.
146 .TP
147 .B panel_below(pan)
148 returns a pointer to the panel just below pan.  If the panel argument
149 is \fB(PANEL *)0\fR, it returns a pointer to the top panel in the stack.
150 .TP
151 .B set_panel_userptr(pan,ptr)
152 sets the panel's user pointer.
153 .TP
154 .B panel_userptr(pan)
155 returns the user pointer for a given panel.
156 .TP
157 .B panel_window(pan)
158 returns a pointer to the window of the given panel.
159 .SH DIAGNOSTICS
160 Each routine that returns a pointer returns \fBNULL\fR if an error
161 occurs. Each routine that returns an int value returns \fBOK\fR if it
162 executes successfully and \fBERR\fR if not.
163 .SH COMPATIBILITY
164 Reasonable care has been taken to  ensure  compatibility
165 with  the  native  panel facility introduced in SVr3.2 (inspection of
166 the SVr4 manual pages suggests the programming interface is unchanged).
167 The \fBPANEL\fR data structures are merely  similar. The  programmer
168 is cautioned not to directly use \fBPANEL\fR fields.
169 .P
170 The functions \fBshow_panel\fR and \fBtop_panel\fR are identical
171 in this implementation, and work equally well with displayed or hidden
172 panels.  In the native System V implementation, \fBshow_panel\fR is
173 intended for making a hidden panel visible (at the top of the stack)
174 and \fBtop_panel\fR is intended for making an already-visible panel
175 move to the top of the stack. You are cautioned to use the correct
176 function to ensure compatibility with native panel libraries.
177 .SH NOTE
178 In your library list, libpanel.a should be before libncurses.a; that is,
179 you should say \*(``\-lpanel \-lncurses\*('', not the other way around
180 (which would give a link-error with static libraries).
181 .SH FILES
182 .P
183 panel.h
184 interface for the panels library
185 .P
186 libpanel.a
187 the panels library itself
188 .SH SEE ALSO
189 \fBcurses\fR(3X),
190 \fBcurs_variables\fR(3X),
191 .PP
192 This describes \fBncurses\fR
193 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
194 .SH AUTHOR
195 Originally written by Warren Tucker <wht@n4hgf.mt-park.ga.us>,
196 primarily to assist in porting u386mon to systems without a native
197 panels library.  Repackaged for ncurses by Zeyd ben-Halim.