libyui  3.4.2
YLabel Class Reference

Implementation of the Label, Heading and OutputField widgets. More...

#include <YLabel.h>

Inheritance diagram for YLabel:
YWidget

Public Member Functions

 YLabel (YWidget *parent, const std::string &text, bool isHeading=false, bool isOutputField=false)
 Constructor. More...
 
virtual ~YLabel ()
 Destructor.
 
virtual const char * widgetClass () const
 Returns a descriptive name of this widget class for logging, debugging etc. More...
 
std::string text () const
 Return the text the widget displays.
 
std::string value () const
 Aliases for text().
 
std::string label () const
 
virtual void setText (const std::string &newText)
 Set the text the widget displays. More...
 
void setValue (const std::string &newValue)
 Aliases for setText().
 
void setLabel (const std::string &newLabel)
 
bool isHeading () const
 Return 'true' if this is a Heading widget, i.e., it should display its text in a bold and/or larger font. More...
 
bool 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. More...
 
bool useBoldFont () const
 Return 'true' if a bold font should be used.
 
virtual void setUseBoldFont (bool bold=true)
 Switch bold font on or off. More...
 
virtual bool setProperty (const std::string &propertyName, const YPropertyValue &val)
 Set a property. More...
 
virtual YPropertyValue getProperty (const std::string &propertyName)
 Get a property. More...
 
virtual const YPropertySetpropertySet ()
 Return this class's property set. More...
 
virtual std::string debugLabel () const
 Returns a descriptive label of this widget instance for debugging. More...
 
- Public Member Functions inherited from YWidget
virtual ~YWidget ()
 Destructor.
 
std::string helpText () const
 Return the help text for this widget.
 
void setHelpText (const std::string &helpText)
 Set a help text for this widget. More...
 
bool hasChildren () const
 Returns 'true' if this widget has any children.
 
YWidgetfirstChild () const
 Returns the first child or 0 if there is none. More...
 
YWidgetlastChild () const
 Returns the last child or 0 if there is none.
 
YWidgetListIterator childrenBegin () const
 Return an iterator that points to the first child or to childrenEnd() if there are no children.
 
YWidgetListIterator childrenEnd () const
 Return an interator that points after the last child.
 
YWidgetListConstIterator childrenConstBegin () const
 Return a const iterator that points to the first child or to childrenEnd() if there are no children.
 
YWidgetListConstIterator childrenConstEnd () const
 Return a const interator that points after the last child.
 
YWidgetListIterator begin ()
 A helper for the range-based "for" loop. More...
 
YWidgetListIterator end ()
 A helper for the range-based "for" loop. More...
 
int childrenCount () const
 Returns the current number of children.
 
bool contains (YWidget *child) const
 Checks if 'child' is a (direct!) child of this widget.
 
virtual void addChild (YWidget *child)
 Add a new child. More...
 
virtual void removeChild (YWidget *child)
 Remove a child. More...
 
void deleteChildren ()
 Delete all children and remove them from the children manager's list.
 
YWidgetparent () const
 Return this widget's parent or 0 if it doesn't have a parent.
 
bool hasParent () const
 Return 'true' if this widget has a parent, 'false' if not.
 
void setParent (YWidget *newParent)
 Set this widget's parent.
 
YDialogfindDialog ()
 Traverse up the widget hierarchy and find the dialog this widget belongs to. More...
 
YWidgetfindWidget (YWidgetID *id, bool doThrow=true) const
 Recursively find a widget by its ID. More...
 
virtual int preferredWidth ()=0
 Preferred width of the widget. More...
 
virtual int preferredHeight ()=0
 Preferred height of the widget. More...
 
virtual int preferredSize (YUIDimension dim)
 Preferred size of the widget in the specified dimension. More...
 
virtual void setSize (int newWidth, int newHeight)=0
 Set the new size of the widget. More...
 
bool isValid () const
 Checks whether or not this object is valid. More...
 
bool beingDestroyed () const
 Check if this widget is in the process of being destroyed.
 
void * widgetRep () const
 Return a pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget.
 
void setWidgetRep (void *toolkitWidgetRep)
 Set the pointer to the underlying toolkit's (Qt, ...) widget representing this abstract UI widget. More...
 
bool hasId () const
 Returns 'true' if this widget has an ID.
 
YWidgetIDid () const
 Returns this widget's ID.
 
void setId (YWidgetID *newId_disown)
 Set this widget's ID. More...
 
virtual void setEnabled (bool enabled=true)
 Enable or disable this widget, i.e. More...
 
void setDisabled ()
 Disable this widget (overloaded for better readability).
 
virtual bool isEnabled () const
 Returns 'true' if this widget is enabled.
 
virtual bool stretchable (YUIDimension dim) const
 This is a boolean value that determines whether the widget is resizable beyond its preferred size in the specified dimension. More...
 
void setStretchable (YUIDimension dim, bool newStretch)
 Set the stretchable state to "newStretch" regardless of any hstretch or vstretch options.
 
void setDefaultStretchable (YUIDimension dim, bool newStretch)
 Set the stretchable state to "newStretch". More...
 
virtual int weight (YUIDimension dim)
 The weight is used in situations where all widgets can get their preferred size and yet space is available. More...
 
bool hasWeight (YUIDimension dim)
 Return whether or not the widget has a weight in the specified dimension.
 
void setWeight (YUIDimension dim, int weight)
 Set a weight in the specified dimension.
 
void setNotify (bool notify=true)
 Sets the Notify property.
 
bool notify () const
 Returns whether the widget will notify, i.e. More...
 
void setNotifyContextMenu (bool notifyContextMenu=true)
 Sets the notifyContextMenu property.
 
bool notifyContextMenu () const
 Returns whether the widget will send an event when the user clicks selects the context menu e.g. More...
 
bool sendKeyEvents () const
 Returns 'true' if this widget should send key events, i.e. More...
 
void setSendKeyEvents (bool doSend)
 Specify whether or not this widget should send key events.
 
bool autoShortcut () const
 Returns 'true' if a keyboard shortcut should automatically be assigned to this widget - without complaints in the log file.
 
void setAutoShortcut (bool _newAutoShortcut)
 Sets the 'autoShortcut' flag.
 
int functionKey () const
 Return a function key number that is assigned to this widget. More...
 
bool hasFunctionKey () const
 Check if a function key is assigned to this widget.
 
virtual void setFunctionKey (int fkey_no)
 Assign a function key to this widget (1 for F1, 2 for F2, etc. More...
 
virtual bool setKeyboardFocus ()
 Set the keyboard focus to this widget. More...
 
virtual std::string shortcutString () const
 Get the string of this widget that holds the keyboard shortcut, if any. More...
 
virtual void setShortcutString (const std::string &str)
 Set the string of this widget that holds the keyboard shortcut, if any. More...
 
virtual const char * userInputProperty ()
 The name of the widget property that will return user input, if there is any. More...
 
void dumpWidgetTree (int indentationLevel=0)
 Debugging function: Dump the widget tree from here on to the log file.
 
void dumpDialogWidgetTree ()
 Debugging function: Dump the widget tree from this widget's dialog parent. More...
 
void setChildrenEnabled (bool enabled)
 Enable or disable all widgets in this widget tree.
 
virtual void saveUserInput (YMacroRecorder *macroRecorder)
 Recursively save the user input of all child widgets to a macro recorder: More...
 
void * operator new (size_t size)
 Overloaded operator new to ensure widgets are always created on the heap, never on the stack. More...
 
virtual void startMultipleChanges ()
 In some UIs updating the screen content is an expensive operation. More...
 
virtual void doneMultipleChanges ()
 

Additional Inherited Members

- Protected Member Functions inherited from YWidget
 YWidget (YWidget *parent)
 Constructor.
 
YWidgetChildrenManagerchildrenManager () const
 Returns this widget's children manager.
 
void setChildrenManager (YWidgetChildrenManager *manager)
 Sets a new children manager for this widget. More...
 
void setBeingDestroyed ()
 Set the "being destroyed" flag, i.e. More...
 
void dumpWidget (YWidget *w, int indentationLevel)
 Helper function for dumpWidgetTree(): Dump one widget to the log file.
 

Detailed Description

Implementation of the Label, Heading and OutputField widgets.

Definition at line 38 of file YLabel.h.

Constructor & Destructor Documentation

◆ YLabel()

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.

Member Function Documentation

◆ debugLabel()

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.

◆ getProperty()

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.

◆ isHeading()

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.

◆ isOutputField()

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.

◆ propertySet()

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.

◆ setProperty()

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.

◆ setText()

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.

◆ setUseBoldFont()

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.

◆ widgetClass()

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: