Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Examples

YRichText Class Reference

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

#include <YRichText.h>

Inheritance diagram for YRichText:

YWidget 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

A RichText is a text area with two major differences to a Label: The amount of data it can contain is not restricted by the layout and a number of control sequences are allowed, which control the layout of the text.

Refer to the YaST2 RichText specification for details.


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

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

Implements the ui command changeWidget.

Reimplemented from YWidget.

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.

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::setRichText at the end of your own function.

virtual char* YRichText::widgetClass  )  [inline, virtual]
 

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

Reimplemented from YWidget.


Member Data Documentation

bool YRichText::autoScrollDown [protected]
 

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

YCPString YRichText::text [protected]
 

Current text of the RichText


The documentation for this class was generated from the following files:
Generated on Fri Nov 9 18:15:25 2007 for yast2-core by doxygen 1.3.6