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

Public Member Functions

 NCRichText (YWidget *parent, const std::string &text, bool plainTextMode=false)
 
virtual int preferredWidth ()
 
virtual int preferredHeight ()
 
virtual void setSize (int newWidth, int newHeight)
 
virtual void setLabel (const std::string &nlabel)
 
virtual NCursesEvent wHandleInput (wint_t key)
 
virtual void setValue (const std::string &ntext) override
 
virtual void setEnabled (bool do_bv)
 
virtual bool setKeyboardFocus ()
 
virtual std::string vScrollValue () const override
 
virtual void setVScrollValue (const std::string &newValue) override
 
virtual std::string hScrollValue () const override
 
virtual void setHScrollValue (const std::string &newValue) override
 
virtual void activateLink (const std::string &url)
 
- Public Member Functions inherited from NCPadWidget
 NCPadWidget (NCWidget *myparent=0)
 
 NCPadWidget (YWidget *parent)
 
size_t Columns ()
 
void setLabel (const NClabel &nlabel)
 
- 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::StylewStyle () const
 
const NCstyle::StWidgetwidgetStyle (bool nonactive=false) const
 
const NCstyle::StWidgetframeStyle () const
 
const NCstyle::StListlistStyle () 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)
 
void DumpOn (std::ostream &str, std::string prfx) const
 
- Public Member Functions inherited from tnode< NCWidget * >
 tnode (NCWidget * v, self *p=0, bool behind=true)
 
 tnode (NCWidget * v, self &p, bool behind=true)
 
 tnode (NCWidget * v, self &p, self &s, bool behind=true)
 
void Disconnect ()
 Disconnect from the parent and siblings, but keep children.
 
bool ReparentTo (self &p, bool behind=true)
 
bool ReparentTo (self &p, self &s, bool behind=true)
 
NCWidget * & Value () const
 
NCWidget * & operator() () const
 Alias for Value.
 
selfParent ()
 
const selfParent () const
 
selfPsibling ()
 Previous sibling.
 
const selfPsibling () const
 Previous sibling.
 
selfNsibling ()
 Next sibling.
 
const selfNsibling () const
 Next sibling.
 
selfFchild ()
 First child.
 
const selfFchild () const
 First child.
 
selfLchild ()
 Last child.
 
const selfLchild () const
 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
 
bool IsDescendantOf (const self *n) const
 
selfTop ()
 Root of the tree.
 
const selfTop () const
 
selfNext (bool restart=false)
 
selfNext (self *&c, bool restart=false)
 Return Next and assign it to c.
 
const selfNext (bool restart=false) const
 
const selfNext (const self *&c, bool restart=false) const
 
selfPrev (bool restart=false)
 
selfPrev (self *&c, bool restart=false)
 Return Prev and assign it to c.
 
const selfPrev (bool restart=false) const
 
const selfPrev (const self *&c, bool restart=false) const
 

Protected Member Functions

virtual const char * location () const
 
virtual void wRedraw ()
 
virtual void wRecoded ()
 
virtual NCPadCreatePad ()
 
virtual void DrawPad ()
 
virtual void HScroll (unsigned total, unsigned visible, unsigned start) override
 
virtual void VScroll (unsigned total, unsigned visible, unsigned start) override
 
virtual bool handleInput (wint_t key)
 
- Protected Member Functions inherited from NCPadWidget
virtual NCPadmyPad () const
 
void startMultidraw ()
 
void stopMultidraw ()
 
bool inMultidraw () const
 
unsigned labelWidth () const
 
virtual void wCreate (const wrect &newrect)
 
virtual void wDelete ()
 
wsze defPadSze () const
 
void InitPad ()
 
void AdjustPad (wsze nsze)
 
void DelPad ()
 
virtual void ScrollHead (NCursesWindow &w, unsigned ccol)
 
virtual void AdjustPadSize (wsze &minsze)
 
- Protected Member Functions inherited from NCWidget
virtual void PreDisconnect ()
 
virtual void PostDisconnect ()
 
virtual void PreReparent ()
 
virtual void PostReparent ()
 
NCursesWindowParentWin ()
 
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",...)
 
NCursesErrorNCError (const char *msg="unknown error",...)
 
NCursesErrorNCError (int val, const char *msg="unknown error",...)
 

Friends

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

Additional Inherited Members

- Protected Types inherited from tnode< NCWidget * >
typedef tnode< NCWidget * > self
 
- Protected Attributes inherited from NCPadWidget
bool hasHeadline
 
bool activeLabelOnly
 
- Protected Attributes inherited from NCWidget
NCWidget *const grabedBy
 
NCursesWindowwin
 (owned)
 
wsze defsze
 
wrect framedim
 
wrect inparent
 
bool noUpdates
 
bool skipNoDimWin
 
NC::WState wstate
 
NClabelhotlabel
 
- Protected Attributes inherited from tnode< NCWidget * >
NCWidgetval
 
- Protected Attributes inherited from NCursesError
int errval_i
 
std::string errmsg_t
 

Member Function Documentation

◆ activateLink()

void NCRichText::activateLink ( const std::string & url)
virtual

Derived classes should implement this, method is used to trigger event like user has pressed the link in the RichText

◆ CreatePad()

NCPad * NCRichText::CreatePad ( )
protectedvirtual

Reimplemented from NCPadWidget.

◆ DrawPad()

void NCRichText::DrawPad ( )
protectedvirtual

Reimplemented from NCPadWidget.

◆ handleInput()

bool NCRichText::handleInput ( wint_t key)
protectedvirtual

Reimplemented from NCPadWidget.

◆ HScroll()

void NCRichText::HScroll ( unsigned total,
unsigned visible,
unsigned start )
overrideprotectedvirtual
Parameters
totalvirtual size
visiblesize of the visible part
startposition of the visible part

Reimplemented from NCPadWidget.

◆ location()

virtual const char * NCRichText::location ( ) const
inlineprotectedvirtual

Reimplemented from NCPadWidget.

◆ setEnabled()

void NCRichText::setEnabled ( bool do_bv)
virtual

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.

Reimplemented from NCPadWidget.

◆ VScroll()

void NCRichText::VScroll ( unsigned total,
unsigned visible,
unsigned start )
overrideprotectedvirtual
Parameters
totalvirtual size
visiblesize of the visible part
startposition of the visible part

Reimplemented from NCPadWidget.

◆ wHandleInput()

NCursesEvent NCRichText::wHandleInput ( wint_t key)
virtual

Reimplemented from NCWidget.

◆ wRecoded()

void NCRichText::wRecoded ( )
protectedvirtual

Reimplemented from NCPadWidget.

◆ wRedraw()

void NCRichText::wRedraw ( )
protectedvirtual

Reimplemented from NCPadWidget.


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