xref: /openbsd/lib/libpanel/panel.h (revision 09467b48)
1 /*	$OpenBSD: panel.h,v 1.8 2015/01/23 22:48:51 krw Exp $	*/
2 /****************************************************************************
3  * Copyright (c) 1998-2001,2006 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  ****************************************************************************/
34 
35 /* $Id: panel.h,v 1.8 2015/01/23 22:48:51 krw Exp $ */
36 
37 /* panel.h -- interface file for panels library */
38 
39 #ifndef NCURSES_PANEL_H_incl
40 #define NCURSES_PANEL_H_incl 1
41 
42 #include <curses.h>
43 
44 typedef struct panel
45 {
46   WINDOW *win;
47   struct panel *below;
48   struct panel *above;
49   NCURSES_CONST void *user;
50 } PANEL;
51 
52 #if	defined(__cplusplus)
53 extern "C" {
54 #endif
55 
56 extern NCURSES_EXPORT(WINDOW*) panel_window (const PANEL *);
57 extern NCURSES_EXPORT(void)    update_panels (void);
58 extern NCURSES_EXPORT(int)     hide_panel (PANEL *);
59 extern NCURSES_EXPORT(int)     show_panel (PANEL *);
60 extern NCURSES_EXPORT(int)     del_panel (PANEL *);
61 extern NCURSES_EXPORT(int)     top_panel (PANEL *);
62 extern NCURSES_EXPORT(int)     bottom_panel (PANEL *);
63 extern NCURSES_EXPORT(PANEL*)  new_panel (WINDOW *);
64 extern NCURSES_EXPORT(PANEL*)  panel_above (const PANEL *);
65 extern NCURSES_EXPORT(PANEL*)  panel_below (const PANEL *);
66 extern NCURSES_EXPORT(int)     set_panel_userptr (PANEL *, NCURSES_CONST void *);
67 extern NCURSES_EXPORT(NCURSES_CONST void*) panel_userptr (const PANEL *);
68 extern NCURSES_EXPORT(int)     move_panel (PANEL *, int, int);
69 extern NCURSES_EXPORT(int)     replace_panel (PANEL *,WINDOW *);
70 extern NCURSES_EXPORT(int)     panel_hidden (const PANEL *);
71 
72 #if	defined(__cplusplus)
73 }
74 #endif
75 
76 #endif /* NCURSES_PANEL_H_incl */
77 
78 /* end of panel.h */
79