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

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2022,2023 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.60 2023/12/16 21:24:43 tom Exp @
  31   * ---------
  32   * ---------
  33   * ---------
  34   * ---------
  35   * ---------
  36   * ---------
  37   * ---------
  38   * ---------
  39   * ---------
  40   * ---------
  41   * ---------
  42   * ---------
  43   * ---------
  44   * ---------
  45   * ---------
  46   * ---------
  47   * ---------
  48 -->
  49 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  50 <HTML>
  51 <HEAD>
  52 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  53 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  54 <TITLE>panel 3x 2023-12-16 ncurses 6.4 Library calls</TITLE>
  55 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  56
  57 </HEAD>
  58 <BODY>
  59 <H1 class="no-header">panel 3x 2023-12-16 ncurses 6.4 Library calls</H1>
  60 <PRE>
  61 <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>                        Library calls                       <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
  62
  63
  64
  65
  66 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  67        panel - panel stack extension for <EM>curses</EM>
  68
  69
  70 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  71        <STRONG>#include</STRONG> <STRONG>&lt;panel.h&gt;</STRONG>
  72
  73        <STRONG>PANEL</STRONG> <STRONG>*new_panel(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
  74
  75        <STRONG>int</STRONG> <STRONG>bottom_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  76        <STRONG>int</STRONG> <STRONG>top_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  77        <STRONG>int</STRONG> <STRONG>show_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  78        <STRONG>void</STRONG> <STRONG>update_panels(void);</STRONG>
  79        <STRONG>int</STRONG> <STRONG>hide_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  80
  81        <STRONG>WINDOW</STRONG> <STRONG>*panel_window(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  82        <STRONG>int</STRONG> <STRONG>replace_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>window</EM><STRONG>);</STRONG>
  83        <STRONG>int</STRONG> <STRONG>move_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>starty</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>startx</EM><STRONG>);</STRONG>
  84        <STRONG>int</STRONG> <STRONG>panel_hidden(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  85
  86        <STRONG>PANEL</STRONG> <STRONG>*panel_above(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  87        <STRONG>PANEL</STRONG> <STRONG>*panel_below(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  88
  89        <STRONG>int</STRONG> <STRONG>set_panel_userptr(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>ptr</EM><STRONG>);</STRONG>
  90        <STRONG>const</STRONG> <STRONG>void</STRONG> <STRONG>*panel_userptr(const</STRONG> <STRONG>PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  91
  92        <STRONG>int</STRONG> <STRONG>del_panel(PANEL</STRONG> <STRONG>*</STRONG><EM>pan</EM><STRONG>);</STRONG>
  93
  94        <EM>/*</EM> <EM>ncurses</EM> <EM>extensions</EM> <EM>*/</EM>
  95        <STRONG>PANEL</STRONG> <STRONG>*ground_panel(SCREEN</STRONG> <STRONG>*</STRONG><EM>sp</EM><STRONG>);</STRONG>
  96        <STRONG>PANEL</STRONG> <STRONG>*ceiling_panel(SCREEN</STRONG> <STRONG>*</STRONG><EM>sp</EM><STRONG>);</STRONG>
  97
  98
  99 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 100        Panels  are <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> windows with the added property of depth.  Panel
 101        functions allow the use of stacked windows and ensure that  the  proper
 102        portions  of  each  window  and  the <EM>curses</EM> <STRONG>stdscr</STRONG> window are hidden or
 103        displayed when panels are added, moved, modified, or removed.  The  set
 104        of  currently visible panels is the stack of panels.  The <STRONG>stdscr</STRONG> window
 105        is beneath all panels, and is not considered part of the stack.
 106
 107        A window is associated with each panel.  The panel routines enable  you
 108        to  create,  move,  hide, and show panels.  You can relocate a panel to
 109        any desired position in the stack.
 110
 111        Panel routines are a functional layer added to <EM>curses</EM>, make only  high-
 112        level <EM>curses</EM> calls, and work anywhere <EM>curses</EM> does.
 113
 114
 115 </PRE><H2><a name="h2-FUNCTIONS">FUNCTIONS</a></H2><PRE>
 116
 117 </PRE><H3><a name="h3-bottom_panel">bottom_panel</a></H3><PRE>
 118        <STRONG>bottom_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> puts panel <EM>pan</EM> at the bottom of all panels.
 119
 120
 121 </PRE><H3><a name="h3-ceiling_panel">ceiling_panel</a></H3><PRE>
 122        <STRONG>ceiling_panel(</STRONG><EM>sp</EM><STRONG>)</STRONG> acts like <STRONG>panel_below(NULL)</STRONG> for the given <EM>SCREEN</EM> <EM>sp</EM>.
 123
 124
 125 </PRE><H3><a name="h3-del_panel">del_panel</a></H3><PRE>
 126        <STRONG>del_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG>   removes  the  given  panel  <EM>pan</EM>  from  the  stack  and
 127        deallocates the <EM>PANEL</EM> structure (but not its associated window).
 128
 129
 130 </PRE><H3><a name="h3-ground_panel">ground_panel</a></H3><PRE>
 131        <STRONG>ground_panel(</STRONG><EM>sp</EM><STRONG>)</STRONG> acts like <STRONG>panel_above(NULL)</STRONG> for the given <EM>SCREEN</EM> <EM>sp</EM>.
 132
 133
 134 </PRE><H3><a name="h3-hide_panel">hide_panel</a></H3><PRE>
 135        <STRONG>hide_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> removes the given panel <EM>pan</EM> from the  panel  stack  and
 136        thus  hides  it  from  view.   The  <EM>PANEL</EM> structure is not lost, merely
 137        removed from the stack.
 138
 139
 140 </PRE><H3><a name="h3-move_panel">move_panel</a></H3><PRE>
 141        <STRONG>move_panel(</STRONG><EM>pan</EM><STRONG>,</STRONG> <EM>starty</EM><STRONG>,</STRONG> <EM>startx</EM><STRONG>)</STRONG> moves the given panel <EM>pan</EM>'s  window  so
 142        that  its  upper-left  corner is at <EM>starty</EM>, <EM>startx</EM>.  It does not change
 143        the position of the panel in the stack.  Be sure to use this  function,
 144        not <STRONG><A HREF="curs_window.3x.html">mvwin(3x)</A></STRONG>, to move a panel window.
 145
 146
 147 </PRE><H3><a name="h3-new_panel">new_panel</a></H3><PRE>
 148        <STRONG>new_panel(</STRONG><EM>win</EM><STRONG>)</STRONG>  allocates  a  <EM>PANEL</EM>  structure, associates it with <EM>win</EM>,
 149        places the panel on the top of the stack (causes  it  to  be  displayed
 150        above any other panel) and returns a pointer to the new panel.
 151
 152
 153 </PRE><H3><a name="h3-panel_above">panel_above</a></H3><PRE>
 154        <STRONG>panel_above(</STRONG><EM>pan</EM><STRONG>)</STRONG>  returns  a  pointer  to  the panel above <EM>pan</EM>.  If the
 155        panel argument is "<STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>", it returns  a  pointer  to  the  bottom
 156        panel in the stack.
 157
 158
 159 </PRE><H3><a name="h3-panel_below">panel_below</a></H3><PRE>
 160        <STRONG>panel_below(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns a pointer to the panel just below <EM>pan</EM>.  If the
 161        panel argument is "<STRONG>(PANEL</STRONG> <STRONG>*)0</STRONG>", it returns a pointer to the  top  panel
 162        in the stack.
 163
 164
 165 </PRE><H3><a name="h3-panel_hidden">panel_hidden</a></H3><PRE>
 166        <STRONG>panel_hidden(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns <STRONG>FALSE</STRONG> if the panel <EM>pan</EM> is in the panel stack,
 167        and <STRONG>TRUE</STRONG> if it is not.  If the panel is a null pointer, it returns <STRONG>ERR</STRONG>.
 168
 169
 170 </PRE><H3><a name="h3-panel_userptr">panel_userptr</a></H3><PRE>
 171        <STRONG>panel_userptr(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns the user pointer for a given panel <EM>pan</EM>.
 172
 173
 174 </PRE><H3><a name="h3-panel_window">panel_window</a></H3><PRE>
 175        <STRONG>panel_window(</STRONG><EM>pan</EM><STRONG>)</STRONG> returns a pointer to the window of  the  given  panel
 176        <EM>pan</EM>.
 177
 178
 179 </PRE><H3><a name="h3-replace_panel">replace_panel</a></H3><PRE>
 180        <STRONG>replace_panel(</STRONG><EM>pan</EM><STRONG>,</STRONG>  <EM>window</EM><STRONG>)</STRONG>  replaces  the  current window of panel <EM>pan</EM>
 181        with <EM>window</EM> This is useful if, for example, you want to resize a panel.
 182        In <EM>ncurses</EM>, you can call <STRONG>replace_panel</STRONG> to resize a panel using a window
 183        resized with <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.  It does not change the position of the panel
 184        in the stack.
 185
 186
 187 </PRE><H3><a name="h3-set_panel_userptr">set_panel_userptr</a></H3><PRE>
 188        <STRONG>set_panel_userptr(</STRONG><EM>pan</EM><STRONG>,</STRONG> <EM>ptr</EM><STRONG>)</STRONG> sets the panel's user pointer.
 189
 190
 191 </PRE><H3><a name="h3-show_panel">show_panel</a></H3><PRE>
 192        <STRONG>show_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG>  makes  a  hidden panel visible by placing it on top of
 193        the panels in the panel stack.  See "PORTABILITY" below.
 194
 195
 196 </PRE><H3><a name="h3-top_panel">top_panel</a></H3><PRE>
 197        <STRONG>top_panel(</STRONG><EM>pan</EM><STRONG>)</STRONG> puts the given visible panel <EM>pan</EM> on top of all panels in
 198        the stack.  See "PORTABILITY" below.
 199
 200
 201 </PRE><H3><a name="h3-update_panels">update_panels</a></H3><PRE>
 202        <STRONG>update_panels()</STRONG>  refreshes  the virtual screen to reflect the relations
 203        between the panels in the stack, but  does  not  call  <STRONG><A HREF="curs_refresh.3x.html">doupdate(3x)</A></STRONG>  to
 204        refresh the physical screen.  Use this function and not <STRONG><A HREF="curs_refresh.3x.html">wrefresh(3x)</A></STRONG> or
 205        <STRONG><A HREF="curs_refresh.3x.html">wnoutrefresh(3x)</A></STRONG>.
 206
 207        <STRONG>update_panels</STRONG> may be called more than once before a call  to  <STRONG>doupdate</STRONG>,
 208        but  <STRONG>doupdate</STRONG>  is  the  function  responsible for updating the physical
 209        screen.
 210
 211
 212 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 213        Each routine that returns a pointer returns <STRONG>NULL</STRONG> if  an  error  occurs.
 214        Each  routine  that  returns  an  int  value  returns <STRONG>OK</STRONG> if it executes
 215        successfully and <STRONG>ERR</STRONG> if not.
 216
 217        Except as noted, the <EM>pan</EM> and <EM>window</EM> parameters must  be  non-null.   If
 218        either is null, an error is returned.
 219
 220        The  <STRONG>move_panel</STRONG>  function uses <STRONG><A HREF="curs_window.3x.html">mvwin(3x)</A></STRONG>, and returns an error if <STRONG>mvwin</STRONG>
 221        returns an error.
 222
 223
 224 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 225        The header file <EM>panel.h</EM> itself includes the header file <EM>curses.h</EM>.
 226
 227
 228 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 229        Reasonable care has been taken to ensure compatibility with the  native
 230        panel  facility  introduced  in System V; inspection of the SVr4 manual
 231        pages suggests the programming interface never changed.  The <EM>PANEL</EM> data
 232        structures  are  merely  similar.   The  programmer is cautioned not to
 233        directly use <EM>PANEL</EM> fields.
 234
 235        The  functions  <STRONG>show_panel</STRONG>  and  <STRONG>top_panel</STRONG>  are   identical   in   this
 236        implementation,  and work equally well with displayed or hidden panels.
 237        In the System V implementation, <STRONG>show_panel</STRONG> is  intended  for  making  a
 238        hidden  panel  visible  (at  the  top  of  the  stack) and <STRONG>top_panel</STRONG> is
 239        intended for making an already-visible panel move to  the  top  of  the
 240        stack.   You  are  cautioned  to  use  the  correct  function to ensure
 241        compatibility with System V panel libraries.
 242
 243
 244 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
 245        A panel facility was documented in SVr4.2's  <EM>Character</EM>  <EM>User</EM>  <EM>Interface</EM>
 246        <EM>Programming</EM> document.
 247
 248        It is not part of X/Open Curses.
 249
 250        A few implementations exist:
 251
 252        <STRONG>o</STRONG>   Systems  based  on  SVr4 source code, such as Solaris, provide this
 253            library.
 254
 255        <STRONG>o</STRONG>   <EM>ncurses</EM> (since version 0.6 in 1993) and <EM>PDCurses</EM> (since version 2.2
 256            in  1995) provide a panel library whose common ancestor is a public
 257            domain implementation by Warren Tucker published  in  <EM>u386mon</EM>  2.20
 258            (1990).
 259
 260            According  to Tucker, the System V panel library was first released
 261            in SVr3.2 (1988), and his implementation  helped  with  a  port  to
 262            SVr3.1 (1987).
 263
 264            Several  developers have improved each of these; they are no longer
 265            the same as Tucker's implementation.
 266
 267        <STRONG>o</STRONG>   NetBSD 8 (2018) has a panel library  begun  by  Valery  Ushakov  in
 268            2015, based on the System V documentation.
 269
 270
 271 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 272        Warren   Tucker   &lt;wht@n4hgf.mt-park.ga.us&gt;   originally   wrote   this
 273        implementation, primarily to  assist  in  porting  <EM>u386mon</EM>  to  systems
 274        without a native panel library.
 275
 276        Zeyd ben-Halim repackaged it for <EM>ncurses</EM>.
 277
 278        Juergen Pfeifer and Thomas E. Dickey revised and improved the library.
 279
 280
 281 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 282        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
 283
 284
 285
 286 ncurses 6.4                       2023-12-16                         <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG>
 287 </PRE>
 288 <div class="nav">
 289 <ul>
 290 <li><a href="#h2-NAME">NAME</a></li>
 291 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 292 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 293 <li><a href="#h2-FUNCTIONS">FUNCTIONS</a>
 294 <ul>
 295 <li><a href="#h3-bottom_panel">bottom_panel</a></li>
 296 <li><a href="#h3-ceiling_panel">ceiling_panel</a></li>
 297 <li><a href="#h3-del_panel">del_panel</a></li>
 298 <li><a href="#h3-ground_panel">ground_panel</a></li>
 299 <li><a href="#h3-hide_panel">hide_panel</a></li>
 300 <li><a href="#h3-move_panel">move_panel</a></li>
 301 <li><a href="#h3-new_panel">new_panel</a></li>
 302 <li><a href="#h3-panel_above">panel_above</a></li>
 303 <li><a href="#h3-panel_below">panel_below</a></li>
 304 <li><a href="#h3-panel_hidden">panel_hidden</a></li>
 305 <li><a href="#h3-panel_userptr">panel_userptr</a></li>
 306 <li><a href="#h3-panel_window">panel_window</a></li>
 307 <li><a href="#h3-replace_panel">replace_panel</a></li>
 308 <li><a href="#h3-set_panel_userptr">set_panel_userptr</a></li>
 309 <li><a href="#h3-show_panel">show_panel</a></li>
 310 <li><a href="#h3-top_panel">top_panel</a></li>
 311 <li><a href="#h3-update_panels">update_panels</a></li>
 312 </ul>
 313 </li>
 314 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 315 <li><a href="#h2-NOTES">NOTES</a></li>
 316 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 317 <li><a href="#h2-HISTORY">HISTORY</a></li>
 318 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 319 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 320 </ul>
 321 </div>
 322 </BODY>
 323 </HTML>