1 // * This makes emacs happy -*-Mode: C++;-*-
2 /****************************************************************************
3 * Copyright (c) 1998-2014,2019 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Juergen Pfeifer, 1997 *
32 ****************************************************************************/
34 #ifndef NCURSES_CURSESP_H_incl
35 #define NCURSES_CURSESP_H_incl 1
37 // $Id: cursesp.h,v 1.32 2019/07/28 19:55:27 tom Exp $
45 class NCURSES_IMPEXP NCursesPanel
46 : public NCursesWindow
50 static NCursesPanel *dummy;
53 // This structure is used for the panel's user data field to link the
54 // PANEL* to the C++ object and to provide extra space for a user pointer.
56 void* m_user; // the pointer for the user's data
57 const NCursesPanel* m_back; // backward pointer to C++ object
58 const PANEL* m_owner; // the panel itself
61 inline UserHook *UserPointer()
63 UserHook* uptr = reinterpret_cast<UserHook*>(
64 const_cast<void *>(::panel_userptr (p)));
68 void init(); // Initialize the panel object
71 void set_user(void *user)
73 UserHook* uptr = UserPointer();
74 if (uptr != 0 && uptr->m_back==this && uptr->m_owner==p) {
78 // Set the user pointer of the panel.
82 UserHook* uptr = UserPointer();
84 if (uptr != 0 && uptr->m_back==this && uptr->m_owner==p)
85 result = uptr->m_user;
89 void OnError (int err) const THROW2(NCursesException const, NCursesPanelException)
92 THROW(new NCursesPanelException (this, err));
94 // If err is equal to the curses error indicator ERR, an error handler
97 // Get a keystroke. Default implementation calls getch()
98 virtual int getKey(void);
101 NCursesPanel(int nlines,
105 : NCursesWindow(nlines,ncols,begin_y,begin_x), p(0)
109 // Create a panel with this size starting at the requested position.
112 : NCursesWindow(::stdscr), p(0)
116 // This constructor creates the default Panel associated with the
119 NCursesPanel& operator=(const NCursesPanel& rhs)
123 NCursesWindow::operator=(rhs);
128 NCursesPanel(const NCursesPanel& rhs)
129 : NCursesWindow(rhs),
134 virtual ~NCursesPanel() THROWS(NCursesException);
136 // basic manipulation
139 OnError (::hide_panel(p));
141 // Hide the panel. It stays in the stack but becomes invisible.
145 OnError (::show_panel(p));
147 // Show the panel, i.e. make it visible.
151 OnError (::top_panel(p));
153 // Make this panel the top panel in the stack.
157 OnError (::bottom_panel(p));
159 // Make this panel the bottom panel in the stack.
160 // N.B.: The panel associated with ::stdscr is always on the bottom. So
161 // actually bottom() makes the panel the first above ::stdscr.
163 virtual int mvwin(int y, int x)
165 OnError(::move_panel(p, y, x));
169 inline bool hidden() const
171 return (::panel_hidden (p) ? TRUE : FALSE);
173 // Return TRUE if the panel is hidden, FALSE otherwise.
175 /* The functions panel_above() and panel_below() are not reflected in
176 the NCursesPanel class. The reason for this is, that we cannot
177 assume that a panel retrieved by those operations is one wrapped
178 by a C++ class. Although this situation might be handled, we also
179 need a reverse mapping from PANEL to NCursesPanel which needs some
180 redesign of the low level stuff. At the moment, we define them in the
181 interface but they will always produce an error. */
182 inline NCursesPanel& above() const
188 inline NCursesPanel& below() const
194 // Those two are rewrites of the corresponding virtual members of
196 virtual int refresh();
197 // Propagate all panel changes to the virtual screen and update the
200 virtual int noutrefresh();
201 // Propagate all panel changes to the virtual screen.
203 static void redraw();
204 // Redraw all panels.
207 virtual void frame(const char* title=NULL,
208 const char* btitle=NULL);
209 // Put a frame around the panel and put the title centered in the top line
210 // and btitle in the bottom line.
212 virtual void boldframe(const char* title=NULL,
213 const char* btitle=NULL);
214 // Same as frame(), but use highlighted attributes.
216 virtual void label(const char* topLabel,
217 const char* bottomLabel);
218 // Put the title centered in the top line and btitle in the bottom line.
220 virtual void centertext(int row,const char* label);
221 // Put the label text centered in the specified row.
224 /* We use templates to provide a typesafe mechanism to associate
225 * user data with a panel. A NCursesUserPanel<T> is a panel
226 * associated with some user data of type T.
228 template<class T> class NCursesUserPanel : public NCursesPanel
231 NCursesUserPanel (int nlines,
235 const T* p_UserData = STATIC_CAST(T*)(0))
236 : NCursesPanel (nlines, ncols, begin_y, begin_x)
239 set_user (const_cast<void *>(reinterpret_cast<const void*>
242 // This creates an user panel of the requested size with associated
243 // user data pointed to by p_UserData.
245 NCursesUserPanel(const T* p_UserData = STATIC_CAST(T*)(0)) : NCursesPanel()
248 set_user(const_cast<void *>(reinterpret_cast<const void*>(p_UserData)));
250 // This creates an user panel associated with the ::stdscr and user data
251 // pointed to by p_UserData.
253 virtual ~NCursesUserPanel() THROWS(NCursesException) {};
257 return reinterpret_cast<T*>(get_user ());
259 // Retrieve the user data associated with the panel.
261 virtual void setUserData (const T* p_UserData)
264 set_user (const_cast<void *>(reinterpret_cast<const void*>(p_UserData)));
266 // Associate the user panel with the user data pointed to by p_UserData.
269 #endif /* NCURSES_CURSESP_H_incl */