YRichText Class Reference

Inheritance diagram for YRichText:

List of all members.

Public Member Functions
	YRichText (YWidget *parent, const string &text, bool plainTextMode=false)
virtual	~YRichText ()
virtual const char *	widgetClass () const
virtual void	setValue (const string &newValue)
string	value () const
void	setText (const string &newText)
string	text () const
bool	plainTextMode () const
virtual void	setPlainTextMode (bool on=true)
bool	autoScrollDown () const
virtual void	setAutoScrollDown (bool on=true)
bool	shrinkable () const
void	setShrinkable (bool shrinkable=true)
virtual bool	setProperty (const string &propertyName, const YPropertyValue &val)
virtual YPropertyValue	getProperty (const string &propertyName)
virtual const YPropertySet &	propertySet ()
Protected Attributes
ImplPtr< YRichTextPrivate >	priv

---

Constructor & Destructor Documentation

YRichText::YRichText	(	YWidget *	parent,
		const string &	text,
		bool	plainTextMode = false
	)

Constructor.

'plainTextMode' indicates that the text should be treated as plain text, i.e. any HTML-like tags in the text should not be interpreted in any way.

YRichText::~YRichText

(

)

[virtual]

Destructor.

---

Member Function Documentation

bool YRichText::autoScrollDown

(

)

const

Return 'true' if this RichText widget should automatically scroll down when the text content is changed. This is useful for progress displays and log files.

YPropertyValue YRichText::getProperty

(

const string &

propertyName

)

[virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

bool YRichText::plainTextMode

(

)

const

Return 'true' if this RichText widget is in "plain text" mode, i.e. does not try to interpret RichText/HTML tags.

const YPropertySet & YRichText::propertySet

(

)

[virtual]

Return this class's property set. This also initializes the property upon the first call.

Reimplemented from YWidget.

Reimplemented from YWidget.

void YRichText::setAutoScrollDown

(

bool

on = true

)

[virtual]

Set this RichText widget's "auto scroll down" mode on or off.

Derived classes may want to reimplement this, but they should call this base class function in the new function.

void YRichText::setPlainTextMode

(

bool

on = true

)

[virtual]

Set this RichText widget's "plain text" mode on or off.

Derived classes may want to reimplement this, but they should call this base class function in the new function.

bool YRichText::setProperty	(	const string &	propertyName,
		const YPropertyValue &	val
	)		[virtual]

Set a property. Reimplemented from YWidget.

This function may throw YUIPropertyExceptions.

This function returns 'true' if the value was successfully set and 'false' if that value requires special handling (not in error cases: those are covered by exceptions).

Reimplemented from YWidget.

void YRichText::setShrinkable

(

bool

shrinkable = true

)

Make this widget shrinkable, i.e. very small in layouts.

This method is intentionally not virtual because it doesn't have any immediate effect; it is only needed in preferredWidth() / preferredHeight().

void YRichText::setText

(

const string &

newText

)

[inline]

Alias for setValue().

void YRichText::setValue

(

const string &

newValue

)

[virtual]

Change the text content of the RichText widget.

Derived classes should overwrite this function, but call this base class function in the new function.

bool YRichText::shrinkable

(

)

const

Returns 'true' if this widget is "shrinkable", i.e. it should be very small by default.

string YRichText::text

(

)

const [inline]

Alias for value().

string YRichText::value

(

)

const

Return the text content of the RichText widget.

virtual const char* YRichText::widgetClass

(

)

const [inline, virtual]

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

Reimplemented from YWidget.

---

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

• /data/gitorious.org/libyui/libyui-master/src/YRichText.h
• /data/gitorious.org/libyui/libyui-master/src/YRichText.cc