xref: /openbsd/lib/libcurses/nc_panel.h (revision c7ef0cfc)
1 /* $OpenBSD: nc_panel.h,v 1.5 2023/10/17 09:52:08 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright 2020 Thomas E. Dickey                                          *
5  * Copyright 1998-2009,2017 Free Software Foundation, Inc.                  *
6  *                                                                          *
7  * Permission is hereby granted, free of charge, to any person obtaining a  *
8  * copy of this software and associated documentation files (the            *
9  * "Software"), to deal in the Software without restriction, including      *
10  * without limitation the rights to use, copy, modify, merge, publish,      *
11  * distribute, distribute with modifications, sublicense, and/or sell       *
12  * copies of the Software, and to permit persons to whom the Software is    *
13  * furnished to do so, subject to the following conditions:                 *
14  *                                                                          *
15  * The above copyright notice and this permission notice shall be included  *
16  * in all copies or substantial portions of the Software.                   *
17  *                                                                          *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25  *                                                                          *
26  * Except as contained in this notice, the name(s) of the above copyright   *
27  * holders shall not be used in advertising or otherwise to promote the     *
28  * sale, use or other dealings in this Software without prior written       *
29  * authorization.                                                           *
30  ****************************************************************************/
31 
32 /****************************************************************************
33  *  Author: Juergen Pfeifer                        1997                     *
34  *     and: Thomas E. Dickey                                                *
35  ****************************************************************************/
36 
37 /*
38  * $Id: nc_panel.h,v 1.5 2023/10/17 09:52:08 nicm Exp $
39  *
40  *	nc_panel.h
41  *
42  *	Headerfile to provide an interface for the panel layer into
43  *      the SCREEN structure of the ncurses core.
44  */
45 
46 #ifndef NC_PANEL_H
47 #define NC_PANEL_H 1
48 
49 #include <ncurses_cfg.h>
50 #include <curses.h>
51 
52 #ifdef __cplusplus
53 extern "C"
54 {
55 #endif
56 
57   struct panel;			/* Forward Declaration */
58 
59   struct panelhook
60     {
61       struct panel *top_panel;
62       struct panel *bottom_panel;
63       struct panel *stdscr_pseudo_panel;
64 #if NO_LEAKS
65       int (*destroy) (struct panel *);
66 #endif
67     };
68 
69   struct screen;		/* Forward declaration */
70 /* Retrieve the panelhook of the specified screen */
71   extern NCURSES_EXPORT(struct panelhook *)
72     _nc_panelhook (void);
73 #if NCURSES_SP_FUNCS
74   extern NCURSES_EXPORT(struct panelhook *)
75     NCURSES_SP_NAME(_nc_panelhook) (SCREEN *);
76 #endif
77 
78 #ifdef __cplusplus
79 }
80 #endif
81 
82 #endif				/* NC_PANEL_H */
83