libyui
Public Member Functions

YLabel Class Reference

#include <YLabel.h>

Inheritance diagram for YLabel:
YWidget

List of all members.

Public Member Functions

 YLabel (YWidget *parent, const string &text, bool isHeading=false, bool isOutputField=false)
virtual ~YLabel ()
virtual const char * widgetClass () const
string text () const
string value () const
string label () const
virtual void setText (const string &newText)
void setValue (const string &newValue)
void setLabel (const string &newLabel)
bool isHeading () const
bool isOutputField () const
bool useBoldFont () const
virtual void setUseBoldFont (bool bold=true)
virtual bool setProperty (const string &propertyName, const YPropertyValue &val)
virtual YPropertyValue getProperty (const std::string &propertyName)
virtual const YPropertySetpropertySet ()
virtual string debugLabel () const

Detailed Description

Implementation of the Label, Heading and OutputField widgets


Constructor & Destructor Documentation

YLabel::YLabel ( YWidget parent,
const string &  text,
bool  isHeading = false,
bool  isOutputField = false 
)

Constructor.

'isHeading' indicates if this should be displayed as a Heading widget, i.e. with a bold and/or larger font. This cannot be changed after creating the widget.

'isOutputField' indicates if this should be displayed as an OutputField widget, i.e. similar to an InputField the user can't change. This cannot be changed after creating the widget.

YLabel::~YLabel ( ) [virtual]

Destructor.


Member Function Documentation

string YLabel::debugLabel ( ) const [virtual]

Returns a descriptive label of this widget instance for debugging.

Reimplemented from YWidget since a YLabel doesn't have a shortcut property.

Reimplemented from YWidget.

virtual YPropertyValue YLabel::getProperty ( const std::string &  propertyName) [virtual]

Get a property. Reimplemented from YWidget.

This method may throw exceptions, for example

  • if there is no property with that name
bool YLabel::isHeading ( ) const

Return 'true' if this is a Heading widget, i.e., it should display its text in a bold and/or larger font.

This cannot be changed after creating the widget.

bool YLabel::isOutputField ( ) const

Return 'true' if this is an OutputField widget, i.e., it should display its text similar to an InputField the user can't change.

This cannot be changed after creating the widget.

const YPropertySet & YLabel::propertySet ( ) [virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

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

Set a property. Reimplemented from YWidget.

This method may throw exceptions, for example

  • if there is no property with that name
  • if the expected type and the type mismatch
  • if the value is out of range

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 YLabel::setText ( const string &  newText) [virtual]

Set the text the widget displays.

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

void YLabel::setUseBoldFont ( bool  bold = true) [virtual]

Switch bold font on or off.

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

void YLabel::setValue ( const string &  newValue) [inline]

Aliases for setText().

string YLabel::text ( ) const

Return the text the widget displays.

bool YLabel::useBoldFont ( ) const

Return 'true' if a bold font should be used.

string YLabel::value ( ) const [inline]

Aliases for text().

const char * YLabel::widgetClass ( ) const [virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations Friends