1 /****************************************************************************
2 * Copyright 2020 Thomas E. Dickey *
3 * Copyright 1998-2009,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
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 ****************************************************************************/
36 /* $Id: panel.h,v 1.14 2020/07/04 20:38:43 tom Exp $ */
38 /* panel.h -- interface file for panels library */
40 #ifndef NCURSES_PANEL_H_incl
41 #define NCURSES_PANEL_H_incl 1
46 #if !NCURSES_OPAQUE_PANEL
51 NCURSES_CONST void *user;
53 #endif /* !NCURSES_OPAQUE_PANEL */
56 #if defined(__cplusplus)
60 #if defined(BUILDING_PANEL)
61 # define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_EXPORT
63 # define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_IMPORT
66 #define PANEL_WRAPPED_VAR(type,name) extern PANEL_IMPEXP type NCURSES_PUBLIC_VAR(name)(void)
68 #define PANEL_EXPORT(type) PANEL_IMPEXP type NCURSES_API
69 #define PANEL_EXPORT_VAR(type) PANEL_IMPEXP type
71 extern PANEL_EXPORT(WINDOW*) panel_window (const PANEL *);
72 extern PANEL_EXPORT(void) update_panels (void);
73 extern PANEL_EXPORT(int) hide_panel (PANEL *);
74 extern PANEL_EXPORT(int) show_panel (PANEL *);
75 extern PANEL_EXPORT(int) del_panel (PANEL *);
76 extern PANEL_EXPORT(int) top_panel (PANEL *);
77 extern PANEL_EXPORT(int) bottom_panel (PANEL *);
78 extern PANEL_EXPORT(PANEL*) new_panel (WINDOW *);
79 extern PANEL_EXPORT(PANEL*) panel_above (const PANEL *);
80 extern PANEL_EXPORT(PANEL*) panel_below (const PANEL *);
81 extern PANEL_EXPORT(int) set_panel_userptr (PANEL *, NCURSES_CONST void *);
82 extern PANEL_EXPORT(NCURSES_CONST void*) panel_userptr (const PANEL *);
83 extern PANEL_EXPORT(int) move_panel (PANEL *, int, int);
84 extern PANEL_EXPORT(int) replace_panel (PANEL *,WINDOW *);
85 extern PANEL_EXPORT(int) panel_hidden (const PANEL *);
88 extern PANEL_EXPORT(PANEL *) ground_panel(SCREEN *);
89 extern PANEL_EXPORT(PANEL *) ceiling_panel(SCREEN *);
91 extern PANEL_EXPORT(void) NCURSES_SP_NAME(update_panels) (SCREEN*);
94 #if defined(__cplusplus)
98 #endif /* NCURSES_PANEL_H_incl */