// * this is for making emacs happy: -*-Mode: C++;-*- | |
// vile:cppmode | |
/**************************************************************************** | |
* Copyright 2019-2020,2021 Thomas E. Dickey * | |
* Copyright 1998-2003,2005 Free Software Foundation, Inc. * | |
* * | |
* Permission is hereby granted, free of charge, to any person obtaining a * | |
* copy of this software and associated documentation files (the * | |
* "Software"), to deal in the Software without restriction, including * | |
* without limitation the rights to use, copy, modify, merge, publish, * | |
* distribute, distribute with modifications, sublicense, and/or sell * | |
* copies of the Software, and to permit persons to whom the Software is * | |
* furnished to do so, subject to the following conditions: * | |
* * | |
* The above copyright notice and this permission notice shall be included * | |
* in all copies or substantial portions of the Software. * | |
* * | |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * | |
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * | |
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * | |
* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * | |
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * | |
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * | |
* THE USE OR OTHER DEALINGS IN THE SOFTWARE. * | |
* * | |
* Except as contained in this notice, the name(s) of the above copyright * | |
* holders shall not be used in advertising or otherwise to promote the * | |
* sale, use or other dealings in this Software without prior written * | |
* authorization. * | |
****************************************************************************/ | |
/**************************************************************************** | |
* Author: Juergen Pfeifer, 1997 * | |
****************************************************************************/ | |
// $Id: cursslk.h,v 1.19 2021/04/17 18:11:08 tom Exp $ | |
class NCURSES_CXX_IMPEXP Soft_Label_Key_Set { | |
public: | |
// This inner class represents the attributes of a Soft Label Key (SLK) | |
class NCURSES_CXX_IMPEXP Soft_Label_Key { | |
friend class Soft_Label_Key_Set; | |
public: | |
typedef enum { Left=0, Center=1, Right=2 } Justification; | |
private: | |
char *label; // The Text of the Label | |
Justification format; // The Justification | |
int num; // The number of the Label | |
Soft_Label_Key() : label(NULL), format(Left), num(-1) { | |
} | |
virtual ~Soft_Label_Key() { | |
delete[] label; | |
}; | |
public: | |
// Set the text of the Label | |
Soft_Label_Key& operator=(char *text); | |
// Set the Justification of the Label | |
Soft_Label_Key& operator=(Justification just) { | |
format = just; | |
return *this; | |
} | |
// Retrieve the text of the label | |
inline char* operator()(void) const { | |
return label; | |
} | |
Soft_Label_Key& operator=(const Soft_Label_Key& rhs) | |
{ | |
if (this != &rhs) { | |
*this = rhs; | |
} | |
return *this; | |
} | |
Soft_Label_Key(const Soft_Label_Key& rhs) | |
: label(NULL), | |
format(rhs.format), | |
num(rhs.num) | |
{ | |
*this = rhs.label; | |
} | |
}; | |
public: | |
typedef enum { | |
None = -1, | |
Three_Two_Three = 0, | |
Four_Four = 1, | |
PC_Style = 2, | |
PC_Style_With_Index = 3 | |
} Label_Layout; | |
private: | |
static long count; // Number of Key Sets | |
static Label_Layout format; // Layout of the Key Sets | |
static int num_labels; // Number Of Labels in Key Sets | |
bool b_attrInit; // Are attributes initialized | |
Soft_Label_Key *slk_array; // The array of SLK's | |
// Init the Key Set | |
void init(); | |
// Activate or Deactivate Label# i, Label counting starts with 1! | |
void activate_label(int i, bool bf=TRUE); | |
// Activate of Deactivate all Labels | |
void activate_labels(bool bf); | |
protected: | |
inline void Error (const char* msg) const THROWS(NCursesException) { | |
THROW(new NCursesException (msg)); | |
} | |
// Remove SLK's from screen | |
void clear() { | |
if (ERR==::slk_clear()) | |
Error("slk_clear"); | |
} | |
// Restore them | |
void restore() { | |
if (ERR==::slk_restore()) | |
Error("slk_restore"); | |
} | |
public: | |
// Construct a Key Set, use the most comfortable layout as default. | |
// You must create a Soft_Label_Key_Set before you create any object of | |
// the NCursesWindow, NCursesPanel or derived classes. (Actually before | |
// ::initscr() is called). | |
explicit Soft_Label_Key_Set(Label_Layout fmt); | |
// This constructor assumes, that you already constructed a Key Set | |
// with a layout by the constructor above. This layout will be reused. | |
Soft_Label_Key_Set(); | |
Soft_Label_Key_Set& operator=(const Soft_Label_Key_Set& rhs) | |
{ | |
if (this != &rhs) { | |
*this = rhs; | |
init(); // allocate a new slk_array[] | |
} | |
return *this; | |
} | |
Soft_Label_Key_Set(const Soft_Label_Key_Set& rhs) | |
: b_attrInit(rhs.b_attrInit), | |
slk_array(NULL) | |
{ | |
init(); // allocate a new slk_array[] | |
} | |
virtual ~Soft_Label_Key_Set() THROWS(NCursesException); | |
// Get Label# i. Label counting starts with 1! | |
Soft_Label_Key& operator[](int i); | |
// Retrieve number of Labels | |
int labels() const; | |
// Refresh the SLK portion of the screen | |
inline void refresh() { | |
if (ERR==::slk_refresh()) | |
Error("slk_refresh"); | |
} | |
// Mark the SLK portion of the screen for refresh, defer actual refresh | |
// until next update call. | |
inline void noutrefresh() { | |
if (ERR==::slk_noutrefresh()) | |
Error("slk_noutrefresh"); | |
} | |
// Mark the whole SLK portion of the screen as modified | |
inline void touch() { | |
if (ERR==::slk_touch()) | |
Error("slk_touch"); | |
} | |
// Activate Label# i | |
inline void show(int i) { | |
activate_label(i,FALSE); | |
activate_label(i,TRUE); | |
} | |
// Hide Label# i | |
inline void hide(int i) { | |
activate_label(i,FALSE); | |
} | |
// Show all Labels | |
inline void show() { | |
activate_labels(FALSE); | |
activate_labels(TRUE); | |
} | |
// Hide all Labels | |
inline void hide() { | |
activate_labels(FALSE); | |
} | |
inline void attron(attr_t attrs) { | |
if (ERR==::slk_attron(attrs)) | |
Error("slk_attron"); | |
} | |
inline void attroff(attr_t attrs) { | |
if (ERR==::slk_attroff(attrs)) | |
Error("slk_attroff"); | |
} | |
inline void attrset(attr_t attrs) { | |
if (ERR==::slk_attrset(attrs)) | |
Error("slk_attrset"); | |
} | |
inline void color(short color_pair_number) { | |
if (ERR==::slk_color(color_pair_number)) | |
Error("slk_color"); | |
} | |
inline attr_t attr() const { | |
return ::slk_attr(); | |
} | |
}; | |