panel.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /****************************************************************************
  2. * Copyright 2020 Thomas E. Dickey *
  3. * Copyright 1998-2009,2017 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. * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995 *
  31. * and: Eric S. Raymond <esr@snark.thyrsus.com> *
  32. * and: Juergen Pfeifer 1996-1999,2008 *
  33. ****************************************************************************/
  34. /* $Id: panel.h,v 1.14 2020/07/04 20:38:43 tom Exp $ */
  35. /* panel.h -- interface file for panels library */
  36. #ifndef NCURSES_PANEL_H_incl
  37. #define NCURSES_PANEL_H_incl 1
  38. #include <ncursesw/curses.h>
  39. typedef struct panel
  40. #if !NCURSES_OPAQUE_PANEL
  41. {
  42. WINDOW *win;
  43. struct panel *below;
  44. struct panel *above;
  45. NCURSES_CONST void *user;
  46. }
  47. #endif /* !NCURSES_OPAQUE_PANEL */
  48. PANEL;
  49. #if defined(__cplusplus)
  50. extern "C" {
  51. #endif
  52. #if defined(BUILDING_PANEL)
  53. # define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_EXPORT
  54. #else
  55. # define PANEL_IMPEXP NCURSES_EXPORT_GENERAL_IMPORT
  56. #endif
  57. #define PANEL_WRAPPED_VAR(type,name) extern PANEL_IMPEXP type NCURSES_PUBLIC_VAR(name)(void)
  58. #define PANEL_EXPORT(type) PANEL_IMPEXP type NCURSES_API
  59. #define PANEL_EXPORT_VAR(type) PANEL_IMPEXP type
  60. extern PANEL_EXPORT(WINDOW*) panel_window (const PANEL *);
  61. extern PANEL_EXPORT(void) update_panels (void);
  62. extern PANEL_EXPORT(int) hide_panel (PANEL *);
  63. extern PANEL_EXPORT(int) show_panel (PANEL *);
  64. extern PANEL_EXPORT(int) del_panel (PANEL *);
  65. extern PANEL_EXPORT(int) top_panel (PANEL *);
  66. extern PANEL_EXPORT(int) bottom_panel (PANEL *);
  67. extern PANEL_EXPORT(PANEL*) new_panel (WINDOW *);
  68. extern PANEL_EXPORT(PANEL*) panel_above (const PANEL *);
  69. extern PANEL_EXPORT(PANEL*) panel_below (const PANEL *);
  70. extern PANEL_EXPORT(int) set_panel_userptr (PANEL *, NCURSES_CONST void *);
  71. extern PANEL_EXPORT(NCURSES_CONST void*) panel_userptr (const PANEL *);
  72. extern PANEL_EXPORT(int) move_panel (PANEL *, int, int);
  73. extern PANEL_EXPORT(int) replace_panel (PANEL *,WINDOW *);
  74. extern PANEL_EXPORT(int) panel_hidden (const PANEL *);
  75. #if NCURSES_SP_FUNCS
  76. extern PANEL_EXPORT(PANEL *) ground_panel(SCREEN *);
  77. extern PANEL_EXPORT(PANEL *) ceiling_panel(SCREEN *);
  78. extern PANEL_EXPORT(void) NCURSES_SP_NAME(update_panels) (SCREEN*);
  79. #endif
  80. #if defined(__cplusplus)
  81. }
  82. #endif
  83. #endif /* NCURSES_PANEL_H_incl */
  84. /* end of panel.h */