ncurses 5.3
[ncurses.git] / doc / html / man / panel.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998 Free Software Foundation, Inc.                        *
5   *                                                                          *
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   ****************************************************************************
30   * @Id: panel.3x,v 1.10 2000/08/13 01:56:47 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>panel 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>panel 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43
44 </PRE>
45 <H2>NAME</H2><PRE>
46        panel - panel stack extension for curses
47
48
49 </PRE>
50 <H2>SYNOPSIS</H2><PRE>
51        <STRONG>#include</STRONG> <STRONG>&lt;panel.h&gt;</STRONG>
52
53        <STRONG>cc</STRONG> <STRONG>[flags]</STRONG> <STRONG>sourcefiles</STRONG> <STRONG>-lpanel</STRONG> <STRONG>-lncurses</STRONG>
54
55        <STRONG>PANEL</STRONG> <STRONG>*new_panel(WINDOW</STRONG> <STRONG>*win)</STRONG>
56        <STRONG>int</STRONG> <STRONG>bottom_panel(PANEL</STRONG> <STRONG>*pan)</STRONG>
57        <STRONG>int</STRONG> <STRONG>top_panel(PANEL</STRONG> <STRONG>*pan)</STRONG>
58        <STRONG>int</STRONG> <STRONG>show_panel(PANEL</STRONG> <STRONG>*pan)</STRONG>
59        <STRONG>void</STRONG> <STRONG>update_panels();</STRONG>
60        <STRONG>int</STRONG> <STRONG>hide_panel(PANEL</STRONG> <STRONG>*pan)</STRONG>
61        <STRONG>WINDOW</STRONG> <STRONG>*panel_window(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG>
62        <STRONG>int</STRONG> <STRONG>replace_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*window)</STRONG>
63        <STRONG>int</STRONG> <STRONG>move_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>int</STRONG> <STRONG>starty,</STRONG> <STRONG>int</STRONG> <STRONG>startx)</STRONG>
64        <STRONG>int</STRONG> <STRONG>panel_hidden(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG>
65        <STRONG>PANEL</STRONG> <STRONG>*panel_above(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG>
66        <STRONG>PANEL</STRONG> <STRONG>*panel_below(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG>
67        <STRONG>int</STRONG> <STRONG>set_panel_userptr(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*ptr)</STRONG>
68        <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*panel_userptr(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan)</STRONG>
69        <STRONG>int</STRONG> <STRONG>del_panel(PANEL</STRONG> <STRONG>*pan)</STRONG>
70
71
72 </PRE>
73 <H2>DESCRIPTION</H2><PRE>
74        Panels  are  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>  windows with the added feature of
75        depth.  Panel functions allow the use of  stacked  windows
76        and  ensure  the  proper  portions  of each window and the
77        curses <STRONG>stdscr</STRONG> window are hidden or displayed  when  panels
78        are  added,  moved,  modified or removed.  The set of cur-
79        rently visible panels is the stack of panels.  The  <STRONG>stdscr</STRONG>
80        window  is  beneath all panels, and is not considered part
81        of the stack.
82
83        A window is associated with every panel.  The  panel  rou-
84        tines  enable you to create, move, hides, and show panels,
85        as well as position a panel at any desired location in the
86        stack.
87
88        Panel routines are a functional layer added to <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
89        make only high-level curses calls, and work anywhere  ter-
90        minfo curses does.
91
92
93 </PRE>
94 <H2>FUNCTIONS</H2><PRE>
95        <STRONG>new_panel(win)</STRONG>
96               allocates   a   <STRONG>PANEL</STRONG> structure, associates it with
97               <STRONG>win</STRONG>, places the panel  on  the  top  of  the  stack
98               (causes   it  to   be   displayed  above  any other
99               panel) and returns a pointer to the new panel.
100
101        <STRONG>void</STRONG> <STRONG>update_panels()</STRONG>
102               refreshes the virtual screen to reflect  the  rela-
103               tions between the panels in the stack, but does not
104               call doupdate() to  refresh  the  physical  screen.
105               Use this function and not wrefresh or wnoutrefresh.
106               update_panels() may be called more than once before
107               a  call  to doupdate(), but doupdate() is the func-
108               tion responsible for updating the physical  screen.
109
110        <STRONG>del_panel(pan)</STRONG>
111               removes the given panel from the  stack and deallo-
112               cates the <STRONG>PANEL</STRONG> structure (but not  its  associated
113               window).
114
115        <STRONG>hide_panel(pan)</STRONG>
116               removes  the  given  panel from the panel stack and
117               thus hides it from view. The <STRONG>PANEL</STRONG> structure is not
118               lost, merely removed from the stack.
119
120        <STRONG>show_panel(pan)</STRONG>
121               makes  a  hidden panel visible by placing it on top
122               of the panels in the panel stack. See COMPATIBILITY
123               below.
124
125        <STRONG>top_panel(pan)</STRONG>
126               puts  the  given visible panel on top of all panels
127               in the stack.  See COMPATIBILITY below.
128
129        <STRONG>bottom_panel(pan)</STRONG>
130               puts panel at the bottom of all panels.
131
132        <STRONG>move_panel(pan,starty,startx)</STRONG>
133               moves the given panel window so that its upper-left
134               corner  is  at  <STRONG>starty</STRONG>, <STRONG>startx</STRONG>.  It does not change
135               the position of the panel in the stack.  Be sure to
136               use  this  function,  not  <STRONG>mvwin()</STRONG>, to move a panel
137               window.
138
139        <STRONG>replace_panel(pan,window)</STRONG>
140               replaces the current window of  panel  with  <STRONG>window</STRONG>
141               (useful, for example if you want to resize a panel;
142               if you're using <STRONG>ncurses</STRONG>, you can call <STRONG>replace_panel</STRONG>
143               on  the output of <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>).  It does not change
144               the position of the panel in the stack.
145
146        <STRONG>panel_above(pan)</STRONG>
147               returns a pointer to the panel above pan.   If  the
148               panel  argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a pointer
149               to the bottom panel in the stack.
150
151        <STRONG>panel_below(pan)</STRONG>
152               returns a pointer to the panel just below pan.   If
153               the  panel  argument  is  <STRONG>(PANEL</STRONG>  <STRONG>*)0</STRONG>, it returns a
154               pointer to the top panel in the stack.
155
156        <STRONG>set_panel_userptr(pan,ptr)</STRONG>
157               sets the panel's user pointer.
158
159        <STRONG>panel_userptr(pan)</STRONG>
160               returns the user pointer for a given panel.
161
162        <STRONG>panel_window(pan)</STRONG>
163               returns a pointer to the window of the given panel.
164
165
166 </PRE>
167 <H2>DIAGNOSTICS</H2><PRE>
168        Each  routine  that  returns  a pointer returns <STRONG>NULL</STRONG> if an
169        error occurs. Each  routine  that  returns  an  int  value
170        returns <STRONG>OK</STRONG> if it executes successfully and <STRONG>ERR</STRONG> if not.
171
172
173 </PRE>
174 <H2>COMPATIBILITY</H2><PRE>
175        Reasonable  care  has been taken to  ensure  compatibility
176        with  the  native  panel  facility  introduced  in  SVr3.2
177        (inspection of the SVr4 manual pages suggests the program-
178        ming interface is unchanged).  The <STRONG>PANEL</STRONG>  data  structures
179        are  merely   similar. The  programmer is cautioned not to
180        directly use <STRONG>PANEL</STRONG> fields.
181
182        The functions <STRONG>show_panel()</STRONG> and <STRONG>top_panel()</STRONG>  are  identical
183        in  this  implementation,  and work equally well with dis-
184        played or hidden panels.  In the native System V implemen-
185        tation, <STRONG>show_panel()</STRONG> is intended for making a hidden panel
186        visible (at the top  of  the  stack)  and  <STRONG>top_panel()</STRONG>  is
187        intended  for  making an already-visible panel move to the
188        top of the stack. You are cautioned  to  use  the  correct
189        function   to   ensure  compatibility  with  native  panel
190        libraries.
191
192
193 </PRE>
194 <H2>NOTE</H2><PRE>
195        In your library list, libpanel.a should  be  before  libn-
196        curses.a;  that  is,  you want to say `-lpanel -lncurses',
197        not the other way around (which  would  give  you  a  link
198        error using GNU <STRONG><A HREF="ld.1.html">ld(1)</A></STRONG> and some other linkers).
199
200
201 </PRE>
202 <H2>FILES</H2><PRE>
203        panel.h interface for the panels library
204
205        libpanel.a the panels library itself
206
207
208 </PRE>
209 <H2>SEE ALSO</H2><PRE>
210        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
211
212
213 </PRE>
214 <H2>AUTHOR</H2><PRE>
215        Originally   written   by   Warren  Tucker  &lt;wht@n4hgf.mt-
216        park.ga.us&gt;, primarily to assist  in  porting  u386mon  to
217        systems  without  a native panels library.  Repackaged for
218        ncurses by Zeyd ben-Halim.
219
220
221
222
223
224
225 </PRE>
226 <HR>
227 <ADDRESS>
228 Man(1) output converted with
229 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
230 </ADDRESS>
231 </BODY>
232 </HTML>