panel.h revision 56639
1/****************************************************************************
2 * Copyright (c) 1998 Free Software Foundation, Inc.                        *
3 *                                                                          *
4 * Permission is hereby granted, free of charge, to any person obtaining a  *
5 * copy of this software and associated documentation files (the            *
6 * "Software"), to deal in the Software without restriction, including      *
7 * without limitation the rights to use, copy, modify, merge, publish,      *
8 * distribute, distribute with modifications, sublicense, and/or sell       *
9 * copies of the Software, and to permit persons to whom the Software is    *
10 * furnished to do so, subject to the following conditions:                 *
11 *                                                                          *
12 * The above copyright notice and this permission notice shall be included  *
13 * in all copies or substantial portions of the Software.                   *
14 *                                                                          *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 *                                                                          *
23 * Except as contained in this notice, the name(s) of the above copyright   *
24 * holders shall not be used in advertising or otherwise to promote the     *
25 * sale, use or other dealings in this Software without prior written       *
26 * authorization.                                                           *
27 ****************************************************************************/
28
29/****************************************************************************
30 *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995                    *
31 *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32 ****************************************************************************/
33
34/* panel.h -- interface file for panels library */
35
36#ifndef _PANEL_H
37#define _PANEL_H
38
39#include <curses.h>
40
41typedef struct panel
42{
43  WINDOW *win;
44  struct panel *below;
45  struct panel *above;
46  NCURSES_CONST void *user;
47} PANEL;
48
49#if	defined(__cplusplus)
50extern "C" {
51#endif
52
53extern  WINDOW* panel_window(const PANEL *);
54extern  void    update_panels(void);
55extern  int     hide_panel(PANEL *);
56extern  int     show_panel(PANEL *);
57extern  int     del_panel(PANEL *);
58extern  int     top_panel(PANEL *);
59extern  int     bottom_panel(PANEL *);
60extern  PANEL*  new_panel(WINDOW *);
61extern  PANEL*  panel_above(const PANEL *);
62extern  PANEL*  panel_below(const PANEL *);
63extern  int     set_panel_userptr(PANEL *, NCURSES_CONST void *);
64extern  NCURSES_CONST void* panel_userptr(const PANEL *);
65extern  int     move_panel(PANEL *, int, int);
66extern  int     replace_panel(PANEL *,WINDOW *);
67extern	int     panel_hidden(const PANEL *);
68
69#if	defined(__cplusplus)
70}
71#endif
72
73#endif /* _PANEL_H */
74
75/* end of panel.h */
76