doc/html/man/panel.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
   4   * Copyright 1998-2016,2017 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.28 2020/02/02 23:34:34 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>panel 3x</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">panel 3x</H1>
  43 <PRE>
  44 <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>                                                            <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        panel - panel stack extension for curses
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;panel.h&gt;</STRONG>
  55
  56        <STRONG>cc</STRONG> <STRONG>[flags]</STRONG> <STRONG>sourcefiles</STRONG> <STRONG>-lpanel</STRONG> <STRONG>-lncurses</STRONG>
  57
  58        <STRONG>PANEL</STRONG> <STRONG>*new_panel(WINDOW</STRONG> <STRONG>*win);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>bottom_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>top_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
  61        <STRONG>int</STRONG> <STRONG>show_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
  62        <STRONG>void</STRONG> <STRONG>update_panels(void);</STRONG>
  63        <STRONG>int</STRONG> <STRONG>hide_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
  64        <STRONG>WINDOW</STRONG> <STRONG>*panel_window(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
  65        <STRONG>int</STRONG> <STRONG>replace_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*window);</STRONG>
  66        <STRONG>int</STRONG> <STRONG>move_panel(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>int</STRONG> <STRONG>starty,</STRONG> <STRONG>int</STRONG> <STRONG>startx);</STRONG>
  67        <STRONG>int</STRONG> <STRONG>panel_hidden(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
  68        <STRONG>PANEL</STRONG> <STRONG>*panel_above(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
  69        <STRONG>PANEL</STRONG> <STRONG>*panel_below(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
  70        <STRONG>int</STRONG> <STRONG>set_panel_userptr(PANEL</STRONG> <STRONG>*pan,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*ptr);</STRONG>
  71        <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*panel_userptr(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*pan);</STRONG>
  72        <STRONG>int</STRONG> <STRONG>del_panel(PANEL</STRONG> <STRONG>*pan);</STRONG>
  73
  74
  75 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  76        Panels  are  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> windows with the added feature of depth.  Panel
  77        functions allow the use of stacked windows and ensure the  proper  por-
  78        tions  of  each  window and the curses <STRONG>stdscr</STRONG> window are hidden or dis-
  79        played when panels are added, moved, modified or removed.  The  set  of
  80        currently  visible panels is the stack of panels.  The <STRONG>stdscr</STRONG> window is
  81        beneath all panels, and is not considered part of the stack.
  82
  83        A window is associated with every panel.  The panel routines enable you
  84        to  create, move, hide, and show panels, as well as position a panel at
  85        any desired location in the stack.
  86
  87        Panel routines are a functional layer added to  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,  make  only
  88        high-level curses calls, and work anywhere terminfo curses does.
  89
  90
  91 </PRE><H2><a name="h2-FUNCTIONS">FUNCTIONS</a></H2><PRE>
  92        <STRONG>new_panel(win)</STRONG>
  93               allocates   a   <STRONG>PANEL</STRONG>  structure, associates it with <STRONG>win</STRONG>, places
  94               the panel on the top of the stack  (causes  it to  be  displayed
  95               above any other panel) and returns a pointer to the new panel.
  96
  97        <STRONG>update_panels</STRONG>
  98               refreshes  the  <EM>virtual</EM>  <EM>screen</EM> to reflect the relations between
  99               the panels in the stack, but does not call <STRONG>doupdate</STRONG>  to  refresh
 100               the  <EM>physical</EM>  <EM>screen</EM>.   Use  this  function and not <STRONG>wrefresh</STRONG> or
 101               <STRONG>wnoutrefresh</STRONG>.  <STRONG>update_panels</STRONG> may be called more than once before
 102               a call to <STRONG>doupdate</STRONG>, but <STRONG>doupdate</STRONG> is the function responsible for
 103               updating the <EM>physical</EM> <EM>screen</EM>.
 104
 105        <STRONG>del_panel(pan)</STRONG>
 106               removes the given panel from  the   stack  and  deallocates  the
 107               <STRONG>PANEL</STRONG> structure (but not its associated window).
 108
 109        <STRONG>hide_panel(pan)</STRONG>
 110               removes  the  given panel from the panel stack and thus hides it
 111               from view.  The <STRONG>PANEL</STRONG> structure is not lost, merely removed from
 112               the stack.
 113
 114        <STRONG>panel_hidden(pan)</STRONG>
 115               returns  <STRONG>TRUE</STRONG> if the panel is in the panel stack, <STRONG>FALSE</STRONG> if it is
 116               not.  If the panel is a null pointer, return <STRONG>ERR</STRONG>.
 117
 118        <STRONG>show_panel(pan)</STRONG>
 119               makes a hidden panel visible by placing it on top of the  panels
 120               in the panel stack.  See COMPATIBILITY below.
 121
 122        <STRONG>top_panel(pan)</STRONG>
 123               puts  the given visible panel on top of all panels in the stack.
 124               See COMPATIBILITY below.
 125
 126        <STRONG>bottom_panel(pan)</STRONG>
 127               puts panel at the bottom of all panels.
 128
 129        <STRONG>move_panel(pan,starty,startx)</STRONG>
 130               moves the given panel window so that its upper-left corner is at
 131               <STRONG>starty</STRONG>, <STRONG>startx</STRONG>.  It does not change the position of the panel in
 132               the stack.  Be sure to use this function, not <STRONG>mvwin</STRONG>, to  move  a
 133               panel window.
 134
 135        <STRONG>replace_panel(pan,window)</STRONG>
 136               replaces  the  current  window of panel with <STRONG>window</STRONG> (useful, for
 137               example if you want to resize a panel; if you're using  <STRONG>ncurses</STRONG>,
 138               you  can  call  <STRONG>replace_panel</STRONG> on the output of <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>).  It
 139               does not change the position of the panel in the stack.
 140
 141        <STRONG>panel_above(pan)</STRONG>
 142               returns a pointer to the panel above pan.  If the panel argument
 143               is  <STRONG>(PANEL</STRONG>  <STRONG>*)0</STRONG>, it returns a pointer to the bottom panel in the
 144               stack.
 145
 146        <STRONG>panel_below(pan)</STRONG>
 147               returns a pointer to the panel just below  pan.   If  the  panel
 148               argument is <STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>, it returns a pointer to the top panel in
 149               the stack.
 150
 151        <STRONG>set_panel_userptr(pan,ptr)</STRONG>
 152               sets the panel's user pointer.
 153
 154        <STRONG>panel_userptr(pan)</STRONG>
 155               returns the user pointer for a given panel.
 156
 157        <STRONG>panel_window(pan)</STRONG>
 158               returns a pointer to the window of the given panel.
 159
 160
 161 </PRE><H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></H2><PRE>
 162        Each routine that returns a pointer returns <STRONG>NULL</STRONG> if  an  error  occurs.
 163        Each  routine  that returns an int value returns <STRONG>OK</STRONG> if it executes suc-
 164        cessfully and <STRONG>ERR</STRONG> if not.
 165
 166
 167 </PRE><H2><a name="h2-COMPATIBILITY">COMPATIBILITY</a></H2><PRE>
 168        Reasonable care has been taken  to   ensure   compatibility  with   the
 169        native   panel  facility introduced in System V (inspection of the SVr4
 170        manual pages suggests the programming  interface  is  unchanged).   The
 171        <STRONG>PANEL</STRONG>  data  structures  are  merely  similar.  The  programmer is cau-
 172        tioned not to directly use <STRONG>PANEL</STRONG> fields.
 173
 174        The functions <STRONG>show_panel</STRONG> and <STRONG>top_panel</STRONG> are identical in this  implemen-
 175        tation,  and work equally well with displayed or hidden panels.  In the
 176        native System V implementation, <STRONG>show_panel</STRONG> is  intended  for  making  a
 177        hidden  panel  visible  (at  the  top  of  the  stack) and <STRONG>top_panel</STRONG> is
 178        intended for making an already-visible panel move to  the  top  of  the
 179        stack.  You are cautioned to use the correct function to ensure compat-
 180        ibility with native panel libraries.
 181
 182
 183 </PRE><H2><a name="h2-NOTE">NOTE</a></H2><PRE>
 184        In your library list, libpanel.a should be  before  libncurses.a;  that
 185        is, you should say "-lpanel -lncurses", not the other way around (which
 186        would give a link-error with static libraries).
 187
 188
 189 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 190        The panel facility was documented in SVr4.2 in <EM>Character</EM> <EM>User</EM> <EM>Interface</EM>
 191        <EM>Programming</EM> <EM>(UNIX</EM> <EM>SVR4.2)</EM>.
 192
 193        It is not part of X/Open Curses.
 194
 195        Aside  from  ncurses,  only  systems  based  on SVr4 source code, e.g.,
 196        Solaris provide this library.
 197
 198
 199 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
 200        panel.h interface for the panels library
 201
 202        libpanel.a the panels library itself
 203
 204
 205 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 206        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>,
 207
 208        This describes <STRONG>ncurses</STRONG> version 6.2 (patch 20200212).
 209
 210
 211 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
 212        Originally written by Warren Tucker &lt;wht@n4hgf.mt-park.ga.us&gt;,  primar-
 213        ily  to  assist  in  porting u386mon to systems without a native panels
 214        library.  Repackaged for ncurses by Zeyd ben-Halim.
 215
 216
 217
 218                                                                      <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
 219 </PRE>
 220 <div class="nav">
 221 <ul>
 222 <li><a href="#h2-NAME">NAME</a></li>
 223 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 224 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 225 <li><a href="#h2-FUNCTIONS">FUNCTIONS</a></li>
 226 <li><a href="#h2-DIAGNOSTICS">DIAGNOSTICS</a></li>
 227 <li><a href="#h2-COMPATIBILITY">COMPATIBILITY</a></li>
 228 <li><a href="#h2-NOTE">NOTE</a></li>
 229 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 230 <li><a href="#h2-FILES">FILES</a></li>
 231 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 232 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
 233 </ul>
 234 </div>
 235 </BODY>
 236 </HTML>