source/include/panel.h

0001 /****************************************************************************
0002  * Copyright 2020 Thomas E. Dickey                                          *
0003  * Copyright 1998-2009,2017 Free Software Foundation, Inc.                  *
0004  *                                                                          *
0005  * Permission is hereby granted, free of charge, to any person obtaining a  *
0006  * copy of this software and associated documentation files (the            *
0007  * "Software"), to deal in the Software without restriction, including      *
0008  * without limitation the rights to use, copy, modify, merge, publish,      *
0009  * distribute, distribute with modifications, sublicense, and/or sell       *
0010  * copies of the Software, and to permit persons to whom the Software is    *
0011  * furnished to do so, subject to the following conditions:                 *
0012  *                                                                          *
0013  * The above copyright notice and this permission notice shall be included  *
0014  * in all copies or substantial portions of the Software.                   *
0015  *                                                                          *
0016  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
0017  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
0018  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
0019  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
0020  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
0021  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
0022  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
0023  *                                                                          *
0024  * Except as contained in this notice, the name(s) of the above copyright   *
0025  * holders shall not be used in advertising or otherwise to promote the     *
0026  * sale, use or other dealings in this Software without prior written       *
0027  * authorization.                                                           *
0028  ****************************************************************************/
0029
0030 /****************************************************************************
0031  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995                    *
0032  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
0033  *     and: Juergen Pfeifer                         1996-1999,2008          *
0034  ****************************************************************************/
0035
0036 /* $Id: panel.h,v 1.14 2020/07/04 20:38:43 tom Exp $ */
0037
0038 /* panel.h -- interface file for panels library */
0039
0040 #ifndef NCURSES_PANEL_H_incl
0041 #define NCURSES_PANEL_H_incl 1
0042
0043 #include <ncursesw/curses.h>
0044
0045 typedef struct panel
0046 #if !NCURSES_OPAQUE_PANEL
0047 {
0048   WINDOW *win;
0049   struct panel *below;
0050   struct panel *above;
0051   NCURSES_CONST void *user;
0052 }
0053 #endif /* !NCURSES_OPAQUE_PANEL */
0054 PANEL;
0055
0056 #if defined(__cplusplus)
0057 extern "C" {
0058 #endif
0059
0060 #if defined(BUILDING_PANEL)
0061 # define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_EXPORT
0062 #else
0063 # define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_IMPORT
0064 #endif
0065
0066 #define PANEL_WRAPPED_VAR(type,name) extern PANEL_IMPEXP type NCURSES_PUBLIC_VAR(name)(void)
0067
0068 #define PANEL_EXPORT(type) PANEL_IMPEXP type NCURSES_API
0069 #define PANEL_EXPORT_VAR(type) PANEL_IMPEXP type
0070
0071 extern PANEL_EXPORT(WINDOW*) panel_window (const PANEL *);
0072 extern PANEL_EXPORT(void)    update_panels (void);
0073 extern PANEL_EXPORT(int)     hide_panel (PANEL *);
0074 extern PANEL_EXPORT(int)     show_panel (PANEL *);
0075 extern PANEL_EXPORT(int)     del_panel (PANEL *);
0076 extern PANEL_EXPORT(int)     top_panel (PANEL *);
0077 extern PANEL_EXPORT(int)     bottom_panel (PANEL *);
0078 extern PANEL_EXPORT(PANEL*)  new_panel (WINDOW *);
0079 extern PANEL_EXPORT(PANEL*)  panel_above (const PANEL *);
0080 extern PANEL_EXPORT(PANEL*)  panel_below (const PANEL *);
0081 extern PANEL_EXPORT(int)     set_panel_userptr (PANEL *, NCURSES_CONST void *);
0082 extern PANEL_EXPORT(NCURSES_CONST void*) panel_userptr (const PANEL *);
0083 extern PANEL_EXPORT(int)     move_panel (PANEL *, int, int);
0084 extern PANEL_EXPORT(int)     replace_panel (PANEL *,WINDOW *);
0085 extern PANEL_EXPORT(int)     panel_hidden (const PANEL *);
0086
0087 #if NCURSES_SP_FUNCS
0088 extern PANEL_EXPORT(PANEL *) ground_panel(SCREEN *);
0089 extern PANEL_EXPORT(PANEL *) ceiling_panel(SCREEN *);
0090
0091 extern PANEL_EXPORT(void)    NCURSES_SP_NAME(update_panels) (SCREEN*);
0092 #endif
0093
0094 #if defined(__cplusplus)
0095 }
0096 #endif
0097
0098 #endif /* NCURSES_PANEL_H_incl */
0099
0100 /* end of panel.h */