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