libyui-ncurses
 
Loading...
Searching...
No Matches
NCPad Class Reference

#include <NCPad.h>

Inheritance diagram for NCPad:
Collaboration diagram for NCPad:

Public Member Functions

 NCPad (int lines, int cols, const NCWidget &p)
 
NCursesWindowDestwin ()
 
virtual void Destwin (NCursesWindow *dwin)
 
virtual void resize (wsze nsze)
 
virtual int resize (int lines, int columns)
 
virtual void wRecoded ()
 
virtual void setDirty ()
 
int update ()
 
virtual int setpos ()
 
virtual wpos CurPos () const
 
int ScrlTo (const wpos &newpos)
 
int ScrlLine (int line)
 Scroll to a line, keeping the column.
 
int ScrlCol (int col)
 Scroll to a column, keeping the line.
 
int ScrlDown (int lines=1)
 
int ScrlUp (int lines=1)
 
int ScrlRight (int cols=1)
 
int ScrlLeft (int cols=1)
 
int ScrlToLastLine ()
 
virtual bool handleInput (wint_t key)
 
- Public Member Functions inherited from NCursesPad
 NCursesPad (int lines, int cols)
 
int echochar (const chtype ch)
 
int refresh ()
 
int noutrefresh ()
 
int refresh (int pminrow, int pmincol, int sminrow, int smincol, int smaxrow, int smaxcol)
 
int noutrefresh (int pminrow, int pmincol, int sminrow, int smincol, int smaxrow, int smaxcol)
 
- 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)
 
virtual int mvwin (int begin_y, int begin_x)
 
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)
 
- Public Member Functions inherited from NCScrollHint
void SendSchrollCB (NCSchrollCB *dest)
 Set the receiver of callbacks to dest
 
virtual void SendHead ()
 

Protected Member Functions

int vheight () const
 
bool paging () const
 
virtual int dirtyPad ()
 
virtual int setpos (const wpos &newpos)
 Set the visible position to newpos (but clamp by maxspos), then update.
 
int adjpos (const wpos &offset)
 Adjust CurPos relatively by offset
 
virtual void updateScrollHint ()
 
virtual void directDraw (NCursesWindow &w, const wrect at, unsigned lineno)
 
- Protected Member Functions inherited from NCursesWindow
void err_handler (const char *) const THROWS(NCursesException)
 
void kill_subwindows ()
 
 NCursesWindow ()
 
- Protected Member Functions inherited from NCScrollHint
virtual void SetHead (NCursesWindow &w, unsigned ccol)
 
void VSet (unsigned total, unsigned visible, unsigned start)
 
void HSet (unsigned total, unsigned visible, unsigned start)
 
virtual void SetPadSize (wsze &minsze)
 
- Protected Member Functions inherited from NCSchrollCB
virtual void HScroll (unsigned total, unsigned visible, unsigned start)
 
virtual void VScroll (unsigned total, unsigned visible, unsigned start)
 
virtual void ScrollHead (NCursesWindow &w, unsigned ccol)
 
virtual void AdjustPadSize (wsze &minsze)
 

Protected Attributes

const NCWidgetparw
 
NCursesWindowdestwin
 Destination rectangle: (Pos is always 0, 0)
 
wrect drect
 
wrect srect
 Source rectangle: the visible part of this pad.
 
wpos maxdpos
 
wpos maxspos
 
bool dclear
 should destwin be cleared before contents is copied there
 
bool dirty
 
- Protected Attributes inherited from NCursesWindow
WINDOW * w
 
bool alloced
 
NCursesWindowpar
 
NCursesWindowsubwins
 
NCursesWindowsib
 

Additional Inherited Members

- 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 ()
 
- Static Protected Attributes inherited from NCursesWindow
static long count = 0L
 

Detailed Description

A virtual window with a real viewport (which is NCursesWindow) and a scrolling mechanism.

In the underlying C ncurses library, a pad is a virtual window without a position. Of course that is not very useful without any way to display it so there's a prefresh() function to draw a portion of that pad into a visible "viewport" window. Our NCursesPad fork just directly forwards to prefresh() without remembering the window. Upstream NCursesPad does know a viewport window and so does NCPad (destwin).

Constructor & Destructor Documentation

◆ NCPad()

NCPad::NCPad ( int lines,
int cols,
const NCWidget & p )
Parameters
p(used just for styling info, NOT sizing)

Member Function Documentation

◆ CurPos()

virtual wpos NCPad::CurPos ( ) const
inlinevirtual

Reimplemented in NCTablePadBase.

◆ Destwin()

void NCPad::Destwin ( NCursesWindow * dwin)
virtual
Parameters
dwin(not owned)

Reimplemented in NCTreePad.

◆ directDraw()

virtual void NCPad::directDraw ( NCursesWindow & w,
const wrect at,
unsigned lineno )
inlineprotectedvirtual

Directly draw a table item at a specific location.

update usually copies the visible table content from the NCursesPad to destwin. In case the NCursesPad is truncated, the visible lines are prepared immediately before they are written to destwin

See also
_vheight.

Reimplemented in NCTablePad.

◆ handleInput()

bool NCPad::handleInput ( wint_t key)
virtual

Reimplemented in NCTablePad, NCTablePadBase, and NCTreePad.

◆ paging()

bool NCPad::paging ( ) const
inlineprotected

Whether the Pad is truncated (we're paging).

◆ resize()

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

Reimplemented from NCursesWindow.

◆ setpos()

int NCPad::setpos ( const wpos & newpos)
protectedvirtual

Set the visible position to newpos (but clamp by maxspos), then update.

Reimplemented in NCTablePadBase, and NCTextPad.

◆ vheight()

int NCPad::vheight ( ) const
inlineprotected

The (virtual) height of the Pad (even if truncated).

Member Data Documentation

◆ destwin

NCursesWindow* NCPad::destwin
protected

Destination rectangle: (Pos is always 0, 0)

Where to draw us (may be nullptr, not owned)


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