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