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