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

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