YRichText Class Reference

Implementation of the RichText widget. Derived classes need to check opt.plainTextMode! More...

#include <YRichText.h>

Inheritance diagram for YRichText:

List of all members.

Public Member Functions
	YRichText (const YWidgetOpt &opt, YCPString text)
virtual char *	widgetClass ()
YCPValue	changeWidget (const YCPSymbol &property, const YCPValue &newvalue)
YCPValue	queryWidget (const YCPSymbol &property)
virtual void	setText (const YCPString &RichText)
YCPString	getText ()
Protected Attributes
YCPString	text
bool	autoScrollDown

---

Detailed Description

Implementation of the RichText widget. Derived classes need to check opt.plainTextMode!

RichText

• string text plainText don't interpret text as HTML autoScrollDown automatically scroll down for each text change shrinkable make the widget very small `RichText( "This is a <b>bold</b> text" )

---

Constructor & Destructor Documentation

YRichText::YRichText	(	const YWidgetOpt &	opt,
		YCPString	text
	)

Constructor

Parameters:

	text	the initial text of the RichText
	opt	the widget options

---

Member Function Documentation

virtual char* YRichText::widgetClass

(

)

[inline, virtual]

Returns a descriptive name of this widget class for logging, debugging etc.

Reimplemented from YWidget.

YCPValue YRichText::changeWidget	(	const YCPSymbol &	property,
		const YCPValue &	newvalue
	)			[virtual]

Implements the ui command changeWidget.

Reimplemented from YWidget.

YCPValue YRichText::queryWidget

(

const YCPSymbol &

property

)

[virtual]

Implements the ui command queryWidget

Reimplemented from YWidget.

void YRichText::setText

(

const YCPString &

RichText

)

[virtual]

Change the RichText text. Overload this, but call YRichText::setText at the end of your own function.

YCPString YRichText::getText

(

)

Get the current RichText text. This method cannot be overidden. The value of the RichText cannot be changed other than by calling setRichText, i.e. not by the ui. Therefore setRichText stores the current RichText in RichText.

---

Member Data Documentation

YCPString YRichText::text [protected]

Current text of the RichText

bool YRichText::autoScrollDown [protected]

Flag: Should the text automatically scroll all the way down upon text change?

---

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

• YRichText.h
• YRichText.cc

---