NCPadWidget Class Reference

#include <NCPadWidget.h>

Inheritance diagram for NCPadWidget:

Collaboration diagram for NCPadWidget:

Public Member Functions
	NCPadWidget (NCWidget *myparent=0)
	NCPadWidget (YWidget *parent)
size_t	Columns ()
void	setLabel (const NClabel &nlabel)
virtual void	setEnabled (bool do_bv)
Public Member Functions inherited from NCWidget
void	grabSet (NCWidget *ngrab)
void	grabRelease (NCWidget *ograb)
	NCWidget (NCWidget *myparent)
	NCWidget (YWidget *parent=0)
bool	isValid () const
bool	winExist () const
virtual const NCstyle::Style &	wStyle () const
const NCstyle::StWidget &	widgetStyle (bool nonactive=false) const
const NCstyle::StWidget &	frameStyle () const
const NCstyle::StList &	listStyle () const
wsze	wGetDefsze () const
wrect	wGetSize () const
void	Update ()
void	Redraw (bool sub=false)
void	Recoded ()
NC::WState	GetState () const
void	SetState (const NC::WState newstate, bool force=false)
virtual bool	HasHotkey (int key)
virtual bool	HasFunctionHotkey (int key) const
virtual NCursesEvent	wHandleHotkey (wint_t key)
virtual NCursesEvent	wHandleInput (wint_t key)
void	DumpOn (std::ostream &str, std::string prfx) const
Public Member Functions inherited from tnode< NCWidget * >
void	Disconnect ()
	Disconnect from the parent and siblings, but keep children.
bool	ReparentTo (self &p, bool behind=true)
NCWidget *&	Value () const
NCWidget *&	operator() () const
	Alias for Value.
self *	Parent ()
self *	Psibling ()
	Previous sibling.
self *	Nsibling ()
	Next sibling.
self *	Fchild ()
	First child.
self *	Lchild ()
	Last child.
bool	HasParent () const
bool	HasSiblings () const
bool	HasChildren () const
bool	IsParentOf (const self &c) const
bool	IsSiblingOf (const self &s) const
bool	IsChildOf (const self &p) const
unsigned	Depth () const
	Depth: zero if no parent, otherwise 1 + parent's depth.
bool	IsDescendantOf (const self &n) const
self &	Top ()
	Root of the tree.
self *	Next (bool restart=false)
self *	Prev (bool restart=false)

Protected Member Functions
virtual NCPad *	myPad () const
void	startMultidraw ()
void	stopMultidraw ()
bool	inMultidraw () const
virtual const char *	location () const
unsigned	labelWidth () const
virtual void	wCreate (const wrect &newrect)
virtual void	wDelete ()
virtual void	wRedraw ()
virtual void	wRecoded ()
wsze	defPadSze () const
virtual NCPad *	CreatePad ()
virtual void	DrawPad ()
void	InitPad ()
void	AdjustPad (wsze nsze)
void	DelPad ()
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)
virtual bool	handleInput (wint_t key)
Protected Member Functions inherited from NCWidget
virtual void	PreDisconnect ()
virtual void	PostDisconnect ()
virtual void	PreReparent ()
virtual void	PostReparent ()
NCursesWindow *	ParentWin ()
bool	grabFocus ()
virtual void	grabNotify (NCWidget *)
virtual bool	wantFocus (NCWidget &ngrab)
void	wMoveChildTo (NCWidget &child, const wpos &newpos)
void	wRelocate (const wrect &newrect)
void	wRelocate (const wpos &newpos, const wsze &newsze)
virtual void	wMoveTo (const wpos &newpos)
virtual void	wUpdate (bool forced_br=false)
wpos	ScreenPos () const
Protected Member Functions inherited from NCursesError
	NCursesError (const char *msg="unknown error",...)
	NCursesError (int val, const char *msg="unknown error",...)
NCursesError &	NCError (const char *msg="unknown error",...)
NCursesError &	NCError (int val, const char *msg="unknown error",...)

Protected Attributes
bool	hasHeadline
bool	activeLabelOnly
Protected Attributes inherited from NCWidget
NCWidget *const	grabedBy
NCursesWindow *	win
	(owned)
wsze	defsze
wrect	framedim
wrect	inparent
bool	noUpdates
bool	skipNoDimWin
NC::WState	wstate
NClabel *	hotlabel
Protected Attributes inherited from tnode< NCWidget * >
NCWidget *	val
Protected Attributes inherited from NCursesError
int	errval_i
std::string	errmsg_t

Friends
std::ostream &	operator<< (std::ostream &str, const NCPadWidget &obj)

Additional Inherited Members
Protected Types inherited from tnode< NCWidget * >
typedef tnode< NCWidget * >	self

Detailed Description

Base class for widgets with scrollable contents

Member Function Documentation

AdjustPadSize()

void NCPadWidget::AdjustPadSize ( wsze & minsze )

protectedvirtual

Reimplemented from NCSchrollCB.

CreatePad()

NCPad * NCPadWidget::CreatePad ( )

protectedvirtual

Reimplemented in NCItemSelectorBase, NCMultiSelectionBox, NCTable, and NCTree.

DrawPad()

void NCPadWidget::DrawPad ( )

protectedvirtual

Reimplemented in NCTree.

HScroll()

void NCPadWidget::HScroll ( unsigned total, unsigned visible, unsigned start )

protectedvirtual

Parameters

total	virtual size
visible	size of the visible part
start	position of the visible part

Reimplemented from NCSchrollCB.

Reimplemented in NCRichText.

location()

virtual const char * NCPadWidget::location ( ) const

inlineprotectedvirtual

Reimplemented from NCWidget.

Reimplemented in NCTable, and NCTree.

myPad()

virtual NCPad * NCPadWidget::myPad ( ) const

inlineprotectedvirtual

Return the current pad. Make it virtual so descendant classes can narrow the return type.

Reimplemented in NCItemSelectorBase, NCMultiLineEdit, NCMultiSelectionBox, NCSelectionBox, NCTable, and NCTree.

ScrollHead()

void NCPadWidget::ScrollHead ( NCursesWindow & w, unsigned ccol )

protectedvirtual

Reimplemented from NCSchrollCB.

setEnabled()

virtual void NCPadWidget::setEnabled ( bool do_bv )

inlinevirtual

Pure virtual to make sure every widget implements it. Necessary to make sure that UI requests via YWidget::setEnabled perform, and behave the same way as direct calls to NCWidget::setEnabled.

Implements NCWidget.

Reimplemented in NCItemSelectorBase, NCLogView, NCMultiLineEdit, NCMultiSelectionBox, NCRichText, NCSelectionBox, NCTable, and NCTree.

VScroll()

void NCPadWidget::VScroll ( unsigned total, unsigned visible, unsigned start )

protectedvirtual

Parameters

total	virtual size
visible	size of the visible part
start	position of the visible part

Reimplemented from NCSchrollCB.

Reimplemented in NCRichText.

wCreate()

void NCPadWidget::wCreate ( const wrect & newrect )

protectedvirtual

Reimplemented from NCWidget.

wDelete()

void NCPadWidget::wDelete ( )

protectedvirtual

Reimplemented from NCWidget.

wRecoded()

void NCPadWidget::wRecoded ( )

protectedvirtual

Reimplemented from NCWidget.

wRedraw()

void NCPadWidget::wRedraw ( )

protectedvirtual

Reimplemented from NCWidget.

---

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

• /builddir/build/BUILD/libyui-4.6.2-build/libyui-4.6.2/libyui-ncurses/src/NCPadWidget.h
• /builddir/build/BUILD/libyui-4.6.2-build/libyui-4.6.2/libyui-ncurses/src/NCPadWidget.cc