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