panel/panel.h

   1 /****************************************************************************
   2  * Copyright (c) 1998-2006,2009 Free Software Foundation, Inc.              *
   3  *                                                                          *
   4  * Permission is hereby granted, free of charge, to any person obtaining a  *
   5  * copy of this software and associated documentation files (the            *
   6  * "Software"), to deal in the Software without restriction, including      *
   7  * without limitation the rights to use, copy, modify, merge, publish,      *
   8  * distribute, distribute with modifications, sublicense, and/or sell       *
   9  * copies of the Software, and to permit persons to whom the Software is    *
  10  * furnished to do so, subject to the following conditions:                 *
  11  *                                                                          *
  12  * The above copyright notice and this permission notice shall be included  *
  13  * in all copies or substantial portions of the Software.                   *
  14  *                                                                          *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22  *                                                                          *
  23  * Except as contained in this notice, the name(s) of the above copyright   *
  24  * holders shall not be used in advertising or otherwise to promote the     *
  25  * sale, use or other dealings in this Software without prior written       *
  26  * authorization.                                                           *
  27  ****************************************************************************/
  28
  29 /****************************************************************************
  30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995                    *
  31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  32  *     and: Juergen Pfeifer                         1996-1999,2008          *
  33  ****************************************************************************/
  34
  35 /* $Id: panel.h,v 1.11 2009/04/11 19:50:40 tom Exp $ */
  36
  37 /* panel.h -- interface file for panels library */
  38
  39 #ifndef NCURSES_PANEL_H_incl
  40 #define NCURSES_PANEL_H_incl 1
  41
  42 #include <curses.h>
  43
  44 typedef struct panel
  45 {
  46   WINDOW *win;
  47   struct panel *below;
  48   struct panel *above;
  49   NCURSES_CONST void *user;
  50 } PANEL;
  51
  52 #if     defined(__cplusplus)
  53 extern "C" {
  54 #endif
  55
  56 extern NCURSES_EXPORT(WINDOW*) panel_window (const PANEL *);
  57 extern NCURSES_EXPORT(void)    update_panels (void);
  58 extern NCURSES_EXPORT(int)     hide_panel (PANEL *);
  59 extern NCURSES_EXPORT(int)     show_panel (PANEL *);
  60 extern NCURSES_EXPORT(int)     del_panel (PANEL *);
  61 extern NCURSES_EXPORT(int)     top_panel (PANEL *);
  62 extern NCURSES_EXPORT(int)     bottom_panel (PANEL *);
  63 extern NCURSES_EXPORT(PANEL*)  new_panel (WINDOW *);
  64 extern NCURSES_EXPORT(PANEL*)  panel_above (const PANEL *);
  65 extern NCURSES_EXPORT(PANEL*)  panel_below (const PANEL *);
  66 extern NCURSES_EXPORT(int)     set_panel_userptr (PANEL *, NCURSES_CONST void *);
  67 extern NCURSES_EXPORT(NCURSES_CONST void*) panel_userptr (const PANEL *);
  68 extern NCURSES_EXPORT(int)     move_panel (PANEL *, int, int);
  69 extern NCURSES_EXPORT(int)     replace_panel (PANEL *,WINDOW *);
  70 extern NCURSES_EXPORT(int)     panel_hidden (const PANEL *);
  71
  72 #if NCURSES_SP_FUNCS
  73 extern NCURSES_EXPORT(PANEL *) ground_panel(SCREEN *);
  74 extern NCURSES_EXPORT(PANEL *) ceiling_panel(SCREEN *);
  75
  76 extern NCURSES_EXPORT(void)    NCURSES_SP_NAME(update_panels) (SCREEN*);
  77 #endif
  78
  79 #if     defined(__cplusplus)
  80 }
  81 #endif
  82
  83 #endif /* NCURSES_PANEL_H_incl */
  84
  85 /* end of panel.h */