include/nc_panel.h

   1 /****************************************************************************
   2  * Copyright (c) 1998-2009,2017 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: Juergen Pfeifer                        1997                     *
  31  *     and: Thomas E. Dickey                                                *
  32  ****************************************************************************/
  33
  34 /*
  35  * $Id: nc_panel.h,v 1.9 2017/07/22 17:06:03 tom Exp $
  36  *
  37  *      nc_panel.h
  38  *
  39  *      Headerfile to provide an interface for the panel layer into
  40  *      the SCREEN structure of the ncurses core.
  41  */
  42
  43 #ifndef NC_PANEL_H
  44 #define NC_PANEL_H 1
  45
  46 #include <ncurses_cfg.h>
  47 #include <curses.h>
  48
  49 #ifdef __cplusplus
  50 extern "C"
  51 {
  52 #endif
  53
  54   struct panel;                 /* Forward Declaration */
  55
  56   struct panelhook
  57     {
  58       struct panel *top_panel;
  59       struct panel *bottom_panel;
  60       struct panel *stdscr_pseudo_panel;
  61 #if NO_LEAKS
  62       int (*destroy) (struct panel *);
  63 #endif
  64     };
  65
  66   struct screen;                /* Forward declaration */
  67 /* Retrieve the panelhook of the specified screen */
  68   extern NCURSES_EXPORT(struct panelhook *)
  69     _nc_panelhook (void);
  70 #if NCURSES_SP_FUNCS
  71   extern NCURSES_EXPORT(struct panelhook *)
  72     NCURSES_SP_NAME(_nc_panelhook) (SCREEN *);
  73 #endif
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif
  78
  79 #endif                          /* NC_PANEL_H */