libyui-ncurses
Loading...
Searching...
No Matches
NCursesPanel Class Reference
Inheritance diagram for NCursesPanel:
Collaboration diagram for NCursesPanel:

Public Member Functions

 NCursesPanel (int lines, int cols, int begin_y=0, int begin_x=0)
 
 NCursesPanel ()
 
virtual int resize (int lines, int columns)
 
void hide ()
 
void show ()
 
void top ()
 
void bottom ()
 
int mvwin (int y, int x)
 
bool hidden () const
 
NCursesPanelabove () const
 
NCursesPanelbelow () const
 
PANEL * PANEL_above () const
 
PANEL * PANEL_below () const
 
int transparent (int y, int x)
 
virtual int refresh ()
 
virtual int noutrefresh ()
 
virtual void frame (const char *title=NULL, const char *btitle=NULL)
 
virtual void boldframe (const char *title=NULL, const char *btitle=NULL)
 
virtual void label (const char *topLabel, const char *bottomLabel)
 
virtual void centertext (int row, const char *label)
 
- Public Member Functions inherited from NCursesWindow
 NCursesWindow (WINDOW *window)
 
 NCursesWindow (int lines, int cols, int begin_y, int begin_x)
 
 NCursesWindow (NCursesWindow &parent, int lines, int cols, int begin_y, int begin_x, char absrel='a')
 
virtual ~NCursesWindow ()
 
NCursesWindow Clone ()
 
int colors () const
 
int height () const
 
int width () const
 
int begx () const
 
int begy () const
 
int maxx () const
 
int maxy () const
 
wsze size () const
 
wpos begpos () const
 
wpos maxpos () const
 
wrect area () const
 
short getcolor () const
 
short foreground () const
 
short background () const
 
int setpalette (short fore, short back)
 
int setcolor (short pair)
 
int mvsubwin (NCursesWindow *sub, int begin_y, int begin_x)
 
int move (int y, int x)
 
void getyx (int &y, int &x) const
 
int mvcur (int oldrow, int oldcol, int newrow, int newcol) const
 
int nodelay (bool bf)
 
int getch ()
 
int getch (int y, int x)
 
int getstr (char *str, int n=-1)
 
int getstr (int y, int x, char *str, int n=-1)
 
int instr (char *s, int n=-1)
 
int instr (int y, int x, char *s, int n=-1)
 
int addch (const char ch)
 
int addch (const chtype ch)
 
int add_attr_char (int y, int x)
 
int add_attr_char ()
 
int add_wch (const cchar_t *cch)
 
int add_wch (int y, int x, const cchar_t *cch)
 
int addch (int y, int x, const char ch)
 
int addch (int y, int x, const chtype ch)
 
int echochar (const char ch)
 
int echochar (const chtype ch)
 
int addstr (const char *str, int n=-1)
 
int addstr (int y, int x, const char *str, int n=-1)
 
int addwstr (const wchar_t *str, int n=-1)
 
int addwstr (int y, int x, const wchar_t *str, int n=-1)
 
int printw (const char *fmt,...)
 
int printw (int y, int x, const char *fmt,...)
 
chtype inch () const
 
chtype inchar () const
 
chtype inch (int y, int x)
 
chtype inchar (int y, int x)
 
int in_wchar (cchar_t *cchar)
 
int in_wchar (int y, int x, cchar_t *cchar)
 
int insch (chtype ch)
 
int insch (int y, int x, chtype ch)
 
int ins_wch (int y, int x, const cchar_t *cchar)
 
int insertln ()
 
int insdelln (int n=1)
 
int insstr (const char *s, int n=-1)
 
int insstr (int y, int x, const char *s, int n=-1)
 
int attron (chtype at)
 
int attroff (chtype at)
 
int attrset (chtype at)
 
int chgat (int n, attr_t attr, short color, const void *opts=NULL)
 
int chgat (int y, int x, int n, attr_t attr, short color, const void *opts=NULL)
 
chtype getbkgd () const
 
int bkgd (const chtype ch)
 
void bkgdset (chtype ch)
 
int box ()
 
int border (chtype left=0, chtype right=0, chtype top=0, chtype bottom=0, chtype top_left=0, chtype top_right=0, chtype bottom_left=0, chtype bottom_right=0)
 
int hline (int len, chtype ch=0)
 
int hline (int y, int x, int len, chtype ch=0)
 
int vline (int len, chtype ch=0)
 
int vline (int y, int x, int len, chtype ch=0)
 
int box (const wrect &dim)
 
int erase ()
 
int clear ()
 
int clearok (bool bf)
 
int clrtobot ()
 
int clrtoeol ()
 
int delch ()
 
int delch (int y, int x)
 
int deleteln ()
 
int scroll (int amount=1)
 
int scrollok (bool bf)
 
int setscrreg (int from, int to)
 
int idlok (bool bf)
 
void idcok (bool bf)
 
int touchwin ()
 
int untouchwin ()
 
int touchln (int s, int cnt, bool changed=TRUE)
 
bool is_wintouched () const
 
int leaveok (bool bf)
 
int redrawln (int from, int n)
 
int redrawwin ()
 
int doupdate ()
 
void syncdown ()
 
void syncup ()
 
void cursyncup ()
 
int syncok (bool bf)
 
void immedok (bool bf)
 
int keypad (bool bf)
 
int meta (bool bf)
 
int standout ()
 
int standend ()
 
int overlay (NCursesWindow &win)
 
int overwrite (NCursesWindow &win)
 
int copywin (NCursesWindow &win, int sminrow, int smincol, int dminrow, int dmincol, int dmaxrow, int dmaxcol, bool overlay=TRUE)
 
bool has_mouse () const
 
NCursesWindowchild ()
 
const NCursesWindowchild () const
 
NCursesWindowsibling ()
 
const NCursesWindowsibling () const
 
NCursesWindowparent ()
 
const NCursesWindowparent () const
 
bool isDescendant (NCursesWindow &win)
 

Static Public Member Functions

static void redraw ()
 
- Static Public Member Functions inherited from NCursesWindow
static void useColors (void)
 
static int ripoffline (int ripoff_lines, int(*init)(NCursesWindow &win))
 
static int lines ()
 
static int cols ()
 
static int tabsize ()
 
static int NumberOfColors ()
 
static int maxcoord ()
 

Protected Member Functions

void set_user (void *user)
 
void * get_user () const
 
void OnError (int err) const THROWS(NCursesPanelException)
 
- Protected Member Functions inherited from NCursesWindow
void err_handler (const char *) const THROWS(NCursesException)
 
void kill_subwindows ()
 
 NCursesWindow ()
 

Static Protected Member Functions

static const NCursesPanelget_Panel_of (const PANEL &pan)
 

Protected Attributes

PANEL * p
 
- Protected Attributes inherited from NCursesWindow
WINDOW * w
 
bool alloced
 
NCursesWindowpar
 
NCursesWindowsubwins
 
NCursesWindowsib
 

Static Protected Attributes

static NCursesPaneldummy = ( NCursesPanel* )0
 
- Static Protected Attributes inherited from NCursesWindow
static long count = 0L
 

Friends

class NCDialog
 
std::ostream & operator<< (std::ostream &Stream, const NCursesPanel &Obj_Cv)
 
std::ostream & operator<< (std::ostream &Stream, const NCursesPanel *Obj_Cv)
 

Constructor & Destructor Documentation

◆ NCursesPanel() [1/2]

NCursesPanel::NCursesPanel ( int lines,
int cols,
int begin_y = 0,
int begin_x = 0 )
inline

Create a panel with this size starting at the requested position.

◆ NCursesPanel() [2/2]

NCursesPanel::NCursesPanel ( )
inline

This constructor creates the default Panel associated with the ::stdscr window

Member Function Documentation

◆ above()

NCursesPanel & NCursesPanel::above ( ) const
inline

The functions panel_above() and panel_below() are not reflected in the NCursesPanel class. The reason for this is, that we cannot assume that a panel retrieved by those operations is one wrapped by a C++ class. Although this situation might be handled, we also need a reverse mapping from PANEL to NCursesPanel which needs some redesign of the low level stuff. At the moment, we define them in the interface but they will always produce an error.

◆ boldframe()

void NCursesPanel::boldframe ( const char * title = NULL,
const char * btitle = NULL )
virtual

Same as frame(), but use highlighted attributes.

◆ bottom()

void NCursesPanel::bottom ( )
inline

Make this panel the bottom panel in the stack. N.B.: The panel associated with ::stdscr is always on the bottom. So actually bottom() makes the panel the first above ::stdscr.

◆ centertext()

void NCursesPanel::centertext ( int row,
const char * label )
virtual

Put the label text centered in the specified row.

◆ frame()

void NCursesPanel::frame ( const char * title = NULL,
const char * btitle = NULL )
virtual

Put a frame around the panel and put the title centered in the top line and btitle in the bottom line.

◆ hidden()

bool NCursesPanel::hidden ( ) const
inline

Return TRUE if the panel is hidden, FALSE otherwise.

◆ hide()

void NCursesPanel::hide ( )
inline

Hide the panel. It stays in the stack but becomes invisible.

◆ label()

void NCursesPanel::label ( const char * topLabel,
const char * bottomLabel )
virtual

Put the title centered in the top line and btitle in the bottom line.

◆ mvwin()

int NCursesPanel::mvwin ( int begin_y,
int begin_x )
inlinevirtual

Move window to new position with the new position as top left corner. This is virtual because it is redefined in NCursesPanel.

Reimplemented from NCursesWindow.

◆ noutrefresh()

int NCursesPanel::noutrefresh ( )
virtual

Propagate all panel changes to the virtual screen.

Reimplemented from NCursesWindow.

◆ OnError()

void NCursesPanel::OnError ( int err) const
inlineprotected

If err is equal to the curses error indicator ERR, an error handler is called.

◆ redraw()

void NCursesPanel::redraw ( )
static

Redraw all panels.

◆ refresh()

int NCursesPanel::refresh ( )
virtual

Propagate all panel changes to the virtual screen and update the physical screen.

Reimplemented from NCursesWindow.

◆ resize()

virtual int NCursesPanel::resize ( int lines,
int columns )
inlinevirtual

Resize the panel window.

Reimplemented from NCursesWindow.

◆ set_user()

void NCursesPanel::set_user ( void * user)
inlineprotected

Set the user pointer of the panel.

◆ show()

void NCursesPanel::show ( )
inline

Show the panel, i.e. make it visible.

◆ top()

void NCursesPanel::top ( )
inline

Make this panel the top panel in the stack.


The documentation for this class was generated from the following files: