jpayne@69: /****************************************************************************
jpayne@69:  * Copyright 2020 Thomas E. Dickey                                          *
jpayne@69:  * Copyright 1998-2009,2017 Free Software Foundation, Inc.                  *
jpayne@69:  *                                                                          *
jpayne@69:  * Permission is hereby granted, free of charge, to any person obtaining a  *
jpayne@69:  * copy of this software and associated documentation files (the            *
jpayne@69:  * "Software"), to deal in the Software without restriction, including      *
jpayne@69:  * without limitation the rights to use, copy, modify, merge, publish,      *
jpayne@69:  * distribute, distribute with modifications, sublicense, and/or sell       *
jpayne@69:  * copies of the Software, and to permit persons to whom the Software is    *
jpayne@69:  * furnished to do so, subject to the following conditions:                 *
jpayne@69:  *                                                                          *
jpayne@69:  * The above copyright notice and this permission notice shall be included  *
jpayne@69:  * in all copies or substantial portions of the Software.                   *
jpayne@69:  *                                                                          *
jpayne@69:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
jpayne@69:  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
jpayne@69:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
jpayne@69:  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
jpayne@69:  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
jpayne@69:  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
jpayne@69:  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
jpayne@69:  *                                                                          *
jpayne@69:  * Except as contained in this notice, the name(s) of the above copyright   *
jpayne@69:  * holders shall not be used in advertising or otherwise to promote the     *
jpayne@69:  * sale, use or other dealings in this Software without prior written       *
jpayne@69:  * authorization.                                                           *
jpayne@69:  ****************************************************************************/
jpayne@69: 
jpayne@69: /****************************************************************************
jpayne@69:  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995                    *
jpayne@69:  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
jpayne@69:  *     and: Juergen Pfeifer                         1996-1999,2008          *
jpayne@69:  ****************************************************************************/
jpayne@69: 
jpayne@69: /* $Id: panel.h,v 1.14 2020/07/04 20:38:43 tom Exp $ */
jpayne@69: 
jpayne@69: /* panel.h -- interface file for panels library */
jpayne@69: 
jpayne@69: #ifndef NCURSES_PANEL_H_incl
jpayne@69: #define NCURSES_PANEL_H_incl 1
jpayne@69: 
jpayne@69: #include <ncursesw/curses.h>
jpayne@69: 
jpayne@69: typedef struct panel
jpayne@69: #if !NCURSES_OPAQUE_PANEL
jpayne@69: {
jpayne@69:   WINDOW *win;
jpayne@69:   struct panel *below;
jpayne@69:   struct panel *above;
jpayne@69:   NCURSES_CONST void *user;
jpayne@69: }
jpayne@69: #endif /* !NCURSES_OPAQUE_PANEL */
jpayne@69: PANEL;
jpayne@69: 
jpayne@69: #if	defined(__cplusplus)
jpayne@69: extern "C" {
jpayne@69: #endif
jpayne@69: 
jpayne@69: #if defined(BUILDING_PANEL)
jpayne@69: # define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_EXPORT
jpayne@69: #else
jpayne@69: # define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_IMPORT
jpayne@69: #endif
jpayne@69: 
jpayne@69: #define PANEL_WRAPPED_VAR(type,name) extern PANEL_IMPEXP type NCURSES_PUBLIC_VAR(name)(void)
jpayne@69: 
jpayne@69: #define PANEL_EXPORT(type) PANEL_IMPEXP type NCURSES_API
jpayne@69: #define PANEL_EXPORT_VAR(type) PANEL_IMPEXP type
jpayne@69: 
jpayne@69: extern PANEL_EXPORT(WINDOW*) panel_window (const PANEL *);
jpayne@69: extern PANEL_EXPORT(void)    update_panels (void);
jpayne@69: extern PANEL_EXPORT(int)     hide_panel (PANEL *);
jpayne@69: extern PANEL_EXPORT(int)     show_panel (PANEL *);
jpayne@69: extern PANEL_EXPORT(int)     del_panel (PANEL *);
jpayne@69: extern PANEL_EXPORT(int)     top_panel (PANEL *);
jpayne@69: extern PANEL_EXPORT(int)     bottom_panel (PANEL *);
jpayne@69: extern PANEL_EXPORT(PANEL*)  new_panel (WINDOW *);
jpayne@69: extern PANEL_EXPORT(PANEL*)  panel_above (const PANEL *);
jpayne@69: extern PANEL_EXPORT(PANEL*)  panel_below (const PANEL *);
jpayne@69: extern PANEL_EXPORT(int)     set_panel_userptr (PANEL *, NCURSES_CONST void *);
jpayne@69: extern PANEL_EXPORT(NCURSES_CONST void*) panel_userptr (const PANEL *);
jpayne@69: extern PANEL_EXPORT(int)     move_panel (PANEL *, int, int);
jpayne@69: extern PANEL_EXPORT(int)     replace_panel (PANEL *,WINDOW *);
jpayne@69: extern PANEL_EXPORT(int)     panel_hidden (const PANEL *);
jpayne@69: 
jpayne@69: #if NCURSES_SP_FUNCS
jpayne@69: extern PANEL_EXPORT(PANEL *) ground_panel(SCREEN *);
jpayne@69: extern PANEL_EXPORT(PANEL *) ceiling_panel(SCREEN *);
jpayne@69: 
jpayne@69: extern PANEL_EXPORT(void)    NCURSES_SP_NAME(update_panels) (SCREEN*);
jpayne@69: #endif
jpayne@69: 
jpayne@69: #if	defined(__cplusplus)
jpayne@69: }
jpayne@69: #endif
jpayne@69: 
jpayne@69: #endif /* NCURSES_PANEL_H_incl */
jpayne@69: 
jpayne@69: /* end of panel.h */