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: 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 ****************************************************************************/
35
36/* $Id: panel.h,v 1.14 2020/07/04 20:38:43 tom Exp $ */
37
38/* panel.h -- interface file for panels library */
39
40#ifndef NCURSES_PANEL_H_incl
41#define NCURSES_PANEL_H_incl 1
42
43#include <curses.h>
44
45typedef struct panel
46#if !NCURSES_OPAQUE_PANEL
47{
48 WINDOW *win;
49 struct panel *below;
50 struct panel *above;
51 NCURSES_CONST void *user;
52}
53#endif /* !NCURSES_OPAQUE_PANEL */
54PANEL;
55
56#if defined(__cplusplus)
57extern "C" {
58#endif
59
60#if defined(BUILDING_PANEL)
61# define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_EXPORT
62#else
63# define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_IMPORT
64#endif
65
66#define PANEL_WRAPPED_VAR(type,name) extern PANEL_IMPEXP type NCURSES_PUBLIC_VAR(name)(void)
67
68#define PANEL_EXPORT(type) PANEL_IMPEXP type NCURSES_API
69#define PANEL_EXPORT_VAR(type) PANEL_IMPEXP type
70
71extern PANEL_EXPORT(WINDOW*) panel_window (const PANEL *);
72extern PANEL_EXPORT(void) update_panels (void);
73extern PANEL_EXPORT(int) hide_panel (PANEL *);
74extern PANEL_EXPORT(int) show_panel (PANEL *);
75extern PANEL_EXPORT(int) del_panel (PANEL *);
76extern PANEL_EXPORT(int) top_panel (PANEL *);
77extern PANEL_EXPORT(int) bottom_panel (PANEL *);
78extern PANEL_EXPORT(PANEL*) new_panel (WINDOW *);
79extern PANEL_EXPORT(PANEL*) panel_above (const PANEL *);
80extern PANEL_EXPORT(PANEL*) panel_below (const PANEL *);
81extern PANEL_EXPORT(int) set_panel_userptr (PANEL *, NCURSES_CONST void *);
82extern PANEL_EXPORT(NCURSES_CONST void*) panel_userptr (const PANEL *);
83extern PANEL_EXPORT(int) move_panel (PANEL *, int, int);
84extern PANEL_EXPORT(int) replace_panel (PANEL *,WINDOW *);
85extern PANEL_EXPORT(int) panel_hidden (const PANEL *);
86
87#if NCURSES_SP_FUNCS
88extern PANEL_EXPORT(PANEL *) ground_panel(SCREEN *);
89extern PANEL_EXPORT(PANEL *) ceiling_panel(SCREEN *);
90
91extern PANEL_EXPORT(void) NCURSES_SP_NAME(update_panels) (SCREEN*);
92#endif
93
94#if defined(__cplusplus)
95}
96#endif
97
98#endif /* NCURSES_PANEL_H_incl */
99
100/* end of panel.h */
101

source code of include/panel.h