libyui  2.42.5
 All Classes Functions Variables Enumerations Friends
YLabel Class Reference

#include <YLabel.h>

Inheritance diagram for YLabel:
YWidget

Public Member Functions

 YLabel (YWidget *parent, const std::string &text, bool isHeading=false, bool isOutputField=false)
 
virtual ~YLabel ()
 
virtual const char * widgetClass () const
 
std::string text () const
 
std::string value () const
 
std::string label () const
 
virtual void setText (const std::string &newText)
 
void setValue (const std::string &newValue)
 
void setLabel (const std::string &newLabel)
 
bool isHeading () const
 
bool isOutputField () const
 
bool useBoldFont () const
 
virtual void setUseBoldFont (bool bold=true)
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 
virtual const YPropertySetpropertySet ()
 
virtual std::string debugLabel () const
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 
std::string helpText () const
 
void setHelpText (const std::string &helpText)
 
bool hasChildren () const
 
YWidgetfirstChild () const
 
YWidgetlastChild () const
 
YWidgetListConstIterator childrenBegin () const
 
YWidgetListConstIterator childrenEnd () const
 
int childrenCount () const
 
bool contains (YWidget *child) const
 
virtual void addChild (YWidget *child)
 
virtual void removeChild (YWidget *child)
 
void deleteChildren ()
 
YWidgetparent () const
 
bool hasParent () const
 
void setParent (YWidget *newParent)
 
YDialogfindDialog ()
 
YWidgetfindWidget (YWidgetID *id, bool doThrow=true) const
 
virtual int preferredWidth ()=0
 
virtual int preferredHeight ()=0
 
virtual int preferredSize (YUIDimension dim)
 
virtual void setSize (int newWidth, int newHeight)=0
 
bool isValid () const
 
bool beingDestroyed () const
 
void * widgetRep () const
 
void setWidgetRep (void *toolkitWidgetRep)
 
bool hasId () const
 
YWidgetIDid () const
 
void setId (YWidgetID *newId_disown)
 
virtual void setEnabled (bool enabled=true)
 
void setDisabled ()
 
virtual bool isEnabled () const
 
virtual bool stretchable (YUIDimension dim) const
 
void setStretchable (YUIDimension dim, bool newStretch)
 
void setDefaultStretchable (YUIDimension dim, bool newStretch)
 
virtual int weight (YUIDimension dim)
 
bool hasWeight (YUIDimension dim)
 
void setWeight (YUIDimension dim, int weight)
 
void setNotify (bool notify=true)
 
bool notify () const
 
void setNotifyContextMenu (bool notifyContextMenu=true)
 
bool notifyContextMenu () const
 
bool sendKeyEvents () const
 
void setSendKeyEvents (bool doSend)
 
bool autoShortcut () const
 
void setAutoShortcut (bool _newAutoShortcut)
 
int functionKey () const
 
bool hasFunctionKey () const
 
virtual void setFunctionKey (int fkey_no)
 
virtual bool setKeyboardFocus ()
 
virtual std::string shortcutString () const
 
virtual void setShortcutString (const std::string &str)
 
virtual const char * userInputProperty ()
 
void dumpWidgetTree (int indentationLevel=0)
 
void dumpDialogWidgetTree ()
 
void setChildrenEnabled (bool enabled)
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 
void * operator new (size_t size)
 
virtual void startMultipleChanges ()
 
virtual void doneMultipleChanges ()
 

Additional Inherited Members

- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 
YWidgetChildrenManagerchildrenManager () const
 
void setChildrenManager (YWidgetChildrenManager *manager)
 
void setBeingDestroyed ()
 
void dumpWidget (YWidget *w, int indentationLevel)
 

Detailed Description

Implementation of the Label, Heading and OutputField widgets

Definition at line 38 of file YLabel.h.

Constructor & Destructor Documentation

YLabel::YLabel ( YWidget parent,
const std::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.

Definition at line 56 of file YLabel.cc.

YLabel::~YLabel ( )
virtual

Destructor.

Definition at line 67 of file YLabel.cc.

Member Function Documentation

std::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.

Definition at line 164 of file YLabel.cc.

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

Reimplemented from YWidget.

Definition at line 150 of file YLabel.cc.

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.

Definition at line 85 of file YLabel.cc.

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.

Definition at line 91 of file YLabel.cc.

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.

Definition at line 110 of file YLabel.cc.

bool YLabel::setProperty ( const std::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.

Definition at line 133 of file YLabel.cc.

void YLabel::setText ( const std::string &  newText)
virtual

Set the text the widget displays.

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

Definition at line 79 of file YLabel.cc.

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.

Definition at line 103 of file YLabel.cc.

void YLabel::setValue ( const std::string &  newValue)
inline

Aliases for setText().

Definition at line 93 of file YLabel.h.

std::string YLabel::text ( ) const

Return the text the widget displays.

Definition at line 73 of file YLabel.cc.

bool YLabel::useBoldFont ( ) const

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

Definition at line 97 of file YLabel.cc.

std::string YLabel::value ( ) const
inline

Aliases for text().

Definition at line 79 of file YLabel.h.

const char * YLabel::widgetClass ( ) const
virtual

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 186 of file YLabel.cc.


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