panel/panel.h

   1 /****************************************************************************
   2  * Copyright 2020 Thomas E. Dickey                                          *
   3  * Copyright 1998-2009,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
  30 /****************************************************************************
  31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995                    *
  32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  33  *     and: Juergen Pfeifer                         1996-1999,2008          *
  34  ****************************************************************************/
  35
  36 /* $Id: panel.h,v 1.13 2020/02/02 23:34:34 tom Exp $ */
  37
  38 /* panel.h -- interface file for panels library */
  39
  40 #ifndef NCURSES_PANEL_H_incl
  41 #define NCURSES_PANEL_H_incl 1
  42
  43 #include <curses.h>
  44
  45 typedef struct panel
  46 #if !NCURSES_OPAQUE_PANEL
  47 {
  48   WINDOW *win;
  49   struct panel *below;
  50   struct panel *above;
  51   NCURSES_CONST void *user;
  52 }
  53 #endif /* !NCURSES_OPAQUE_PANEL */
  54 PANEL;
  55
  56 #if     defined(__cplusplus)
  57 extern "C" {
  58 #endif
  59
  60 extern NCURSES_EXPORT(WINDOW*) panel_window (const PANEL *);
  61 extern NCURSES_EXPORT(void)    update_panels (void);
  62 extern NCURSES_EXPORT(int)     hide_panel (PANEL *);
  63 extern NCURSES_EXPORT(int)     show_panel (PANEL *);
  64 extern NCURSES_EXPORT(int)     del_panel (PANEL *);
  65 extern NCURSES_EXPORT(int)     top_panel (PANEL *);
  66 extern NCURSES_EXPORT(int)     bottom_panel (PANEL *);
  67 extern NCURSES_EXPORT(PANEL*)  new_panel (WINDOW *);
  68 extern NCURSES_EXPORT(PANEL*)  panel_above (const PANEL *);
  69 extern NCURSES_EXPORT(PANEL*)  panel_below (const PANEL *);
  70 extern NCURSES_EXPORT(int)     set_panel_userptr (PANEL *, NCURSES_CONST void *);
  71 extern NCURSES_EXPORT(NCURSES_CONST void*) panel_userptr (const PANEL *);
  72 extern NCURSES_EXPORT(int)     move_panel (PANEL *, int, int);
  73 extern NCURSES_EXPORT(int)     replace_panel (PANEL *,WINDOW *);
  74 extern NCURSES_EXPORT(int)     panel_hidden (const PANEL *);
  75
  76 #if NCURSES_SP_FUNCS
  77 extern NCURSES_EXPORT(PANEL *) ground_panel(SCREEN *);
  78 extern NCURSES_EXPORT(PANEL *) ceiling_panel(SCREEN *);
  79
  80 extern NCURSES_EXPORT(void)    NCURSES_SP_NAME(update_panels) (SCREEN*);
  81 #endif
  82
  83 #if     defined(__cplusplus)
  84 }
  85 #endif
  86
  87 #endif /* NCURSES_PANEL_H_incl */
  88
  89 /* end of panel.h */