ncurses 6.0 - patch 20170401
[ncurses.git] / doc / html / man / panel.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: panel.3x,v 1.21 2017/02/18 16:53:23 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>panel 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">panel 3x</H1>
42 <PRE>
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><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        panel - panel stack extension for curses
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;panel.h&gt;</STRONG>
54
55        <STRONG>cc</STRONG> <STRONG>[flags]</STRONG> <STRONG>sourcefiles</STRONG> <STRONG>-lpanel</STRONG> <STRONG>-lncurses</STRONG>
56
57        <STRONG>PANEL</STRONG> <STRONG>*new_panel(WINDOW</STRONG> <STRONG>*win);</STRONG>
58        <STRONG>int</STRONG> <STRONG>bottom_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
59        <STRONG>int</STRONG> <STRONG>top_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
60        <STRONG>int</STRONG> <STRONG>show_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
61        <STRONG>void</STRONG> <STRONG>update_panels();</STRONG>
62        <STRONG>int</STRONG> <STRONG>hide_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
63        <STRONG>WINDOW</STRONG> <STRONG>*panel_window(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
64        <STRONG>int</STRONG> <STRONG>replace_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*window);</STRONG>
65        <STRONG>int</STRONG> <STRONG>move_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>int</STRONG> <STRONG>starty,</STRONG> <STRONG>int</STRONG> <STRONG>startx);</STRONG>
66        <STRONG>int</STRONG> <STRONG>panel_hidden(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
67        <STRONG>PANEL</STRONG> <STRONG>*panel_above(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
68        <STRONG>PANEL</STRONG> <STRONG>*panel_below(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
69        <STRONG>int</STRONG> <STRONG>set_panel_userptr(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*ptr);</STRONG>
70        <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*panel_userptr(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
71        <STRONG>int</STRONG> <STRONG>del_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
72
73
74 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
75        Panels  are  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>  windows with the added feature of
76        depth.  Panel functions allow the use of  stacked  windows
77        and  ensure  the  proper  portions  of each window and the
78        curses <STRONG>stdscr</STRONG> window are hidden or displayed  when  panels
79        are  added,  moved,  modified or removed.  The set of cur-
80        rently visible panels is the stack of panels.  The  <STRONG>stdscr</STRONG>
81        window  is  beneath all panels, and is not considered part
82        of the stack.
83
84        A window is associated with every panel.  The  panel  rou-
85        tines  enable  you to create, move, hide, and show panels,
86        as well as position a panel at any desired location in the
87        stack.
88
89        Panel routines are a functional layer added to <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
90        make only high-level curses calls, and work anywhere  ter-
91        minfo curses does.
92
93
94 </PRE><H2><a name="h2-FUNCTIONS">FUNCTIONS</a></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>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 <STRONG>doupdate</STRONG> to refresh the physical screen.   Use
105               this  function  and  not  <STRONG>wrefresh</STRONG> or <STRONG>wnoutrefresh</STRONG>.
106               <STRONG>update_panels</STRONG> may be called more than once before a
107               call  to  <STRONG>doupdate</STRONG>,  but  <STRONG>doupdate</STRONG>  is the function
108               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>panel_hidden(pan)</STRONG>
121               returns <STRONG>TRUE</STRONG> if the panel is in  the  panel  stack,
122               <STRONG>FALSE</STRONG>  if  it  is  not.   If  the  panel  is a null
123               pointer, return ERR.
124
125        <STRONG>show_panel(pan)</STRONG>
126               makes a hidden panel visible by placing it  on  top
127               of the panels in the panel stack. See COMPATIBILITY
128               below.
129
130        <STRONG>top_panel(pan)</STRONG>
131               puts the given visible panel on top of  all  panels
132               in the stack.  See COMPATIBILITY below.
133
134        <STRONG>bottom_panel(pan)</STRONG>
135               puts panel at the bottom of all panels.
136
137        <STRONG>move_panel(pan,starty,startx)</STRONG>
138               moves the given panel window so that its upper-left
139               corner is at <STRONG>starty</STRONG>, <STRONG>startx</STRONG>.  It  does  not  change
140               the position of the panel in the stack.  Be sure to
141               use this function, not <STRONG>mvwin</STRONG>, to move a panel  win-
142               dow.
143
144        <STRONG>replace_panel(pan,window)</STRONG>
145               replaces  the  current  window of panel with <STRONG>window</STRONG>
146               (useful, for example if you want to resize a panel;
147               if you're using <STRONG>ncurses</STRONG>, you can call <STRONG>replace_panel</STRONG>
148               on the output of <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>).  It does not  change
149               the position of the panel in the stack.
150
151        <STRONG>panel_above(pan)</STRONG>
152               returns  a  pointer to the panel above pan.  If the
153               panel argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a  pointer
154               to the bottom panel in the stack.
155
156        <STRONG>panel_below(pan)</STRONG>
157               returns  a pointer to the panel just below pan.  If
158               the panel argument is  <STRONG>(PANEL</STRONG>  <STRONG>*)0</STRONG>,  it  returns  a
159               pointer to the top panel in the stack.
160
161        <STRONG>set_panel_userptr(pan,ptr)</STRONG>
162               sets the panel's user pointer.
163
164        <STRONG>panel_userptr(pan)</STRONG>
165               returns the user pointer for a given panel.
166
167        <STRONG>panel_window(pan)</STRONG>
168               returns a pointer to the window of the given panel.
169
170
171 </PRE><H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></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><H2><a name="h2-COMPATIBILITY">COMPATIBILITY</a></H2><PRE>
178        Reasonable  care  has been taken to  ensure  compatibility
179        with  the  native  panel  facility  introduced  in  SVr3.2
180        (inspection of the SVr4 manual pages suggests the program-
181        ming interface is unchanged).  The <STRONG>PANEL</STRONG>  data  structures
182        are  merely   similar. The  programmer is cautioned not to
183        directly use <STRONG>PANEL</STRONG> fields.
184
185        The functions <STRONG>show_panel</STRONG> and <STRONG>top_panel</STRONG>  are  identical  in
186        this  implementation, and work equally well with displayed
187        or hidden panels.  In the native System V  implementation,
188        <STRONG>show_panel</STRONG>  is  intended for making a hidden panel visible
189        (at the top of the stack) and <STRONG>top_panel</STRONG>  is  intended  for
190        making  an  already-visible  panel  move to the top of the
191        stack. You are cautioned to use the  correct  function  to
192        ensure compatibility with native panel libraries.
193
194
195 </PRE><H2><a name="h2-NOTE">NOTE</a></H2><PRE>
196        In  your  library  list, libpanel.a should be before libn-
197        curses.a; that is, you should say "-lpanel -lncurses", not
198        the  other  way around (which would give a link-error with
199        static libraries).
200
201
202 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
203        panel.h interface for the panels library
204
205        libpanel.a the panels library itself
206
207
208 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
209        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,
210
211        This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20170401).
212
213
214 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></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                                                               <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
223 </PRE>
224 <div class="nav">
225 <ul>
226 <li><a href="#h2-NAME">NAME</a></li>
227 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
228 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
229 <li><a href="#h2-FUNCTIONS">FUNCTIONS</a></li>
230 <li><a href="#h2-DIAGNOSTICS">DIAGNOSTICS</a></li>
231 <li><a href="#h2-COMPATIBILITY">COMPATIBILITY</a></li>
232 <li><a href="#h2-NOTE">NOTE</a></li>
233 <li><a href="#h2-FILES">FILES</a></li>
234 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
235 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
236 </ul>
237 </div>
238 </BODY>
239 </HTML>