#include <YLabel.h>

Inheritance diagram for YLabel:

Collaboration diagram for YLabel:

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)

bool	autoWrap () const

virtual void	setAutoWrap (bool autoWrap=true)

virtual bool	setProperty (const std::string &propertyName, const YPropertyValue &val)

virtual YPropertyValue	getProperty (const std::string &propertyName)

virtual const YPropertySet &	propertySet ()

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

YWidget *	firstChild () const

YWidget *	lastChild () const

YWidgetListIterator	childrenBegin () const

YWidgetListIterator	childrenEnd () const

YWidgetListConstIterator	childrenConstBegin () const

YWidgetListConstIterator	childrenConstEnd () const

YWidgetListIterator	begin ()

YWidgetListIterator	end ()

int	childrenCount () const

bool	contains (YWidget *child) const

virtual void	addChild (YWidget *child)

virtual void	removeChild (YWidget *child)

void	deleteChildren ()

YWidget *	parent () const

bool	hasParent () const

void	setParent (YWidget *newParent)

YDialog *	findDialog ()

YWidget *	findWidget (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

YWidgetID *	id () 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)

void	operator delete (void *ptr) noexcept

virtual void	startMultipleChanges ()

virtual void	doneMultipleChanges ()

Protected Member Functions
int	layoutPass ()

Protected Member Functions inherited from YWidget
	YWidget (YWidget *parent)

YWidgetChildrenManager *	childrenManager () const

void	setChildrenManager (YWidgetChildrenManager *manager)

void	setBeingDestroyed ()

void	dumpWidget (YWidget *w, int indentationLevel)

Detailed Description

Implementation of the Label, Heading and OutputField widgets

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.

◆ ~YLabel()

YLabel::~YLabel ( )

virtual

Destructor.

Member Function Documentation

◆ autoWrap()

bool YLabel::autoWrap ( ) const

Return 'true' if automatic word wrapping is enabled.

◆ debugLabel()

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.

◆ 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.

◆ 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.

◆ 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.

◆ layoutPass()

int YLabel::layoutPass ( )

protected

Convenience method for the parent dialog's layoutPass(): Return the number of the current layout pass. 0: No layout going on right now 1: First pass 2: Second pass of a multi-pass layout

◆ 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.

◆ setAutoWrap()

void YLabel::setAutoWrap ( bool autoWrap = true )

virtual

Enable or disable automatic word wrapping.

This has implications for geometry management: An auto-wrapping label does not have any reasonable preferred size; it needs to be put into a parent widget (like a MinSize) that enforces a reasonable width. The height can be then be calculated from that width.

Changing this setting takes only effect after the next layout geometry calculation.

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

◆ 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.

◆ 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.

◆ 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.

◆ setValue()

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

inline

Aliases for setText().

◆ text()

string YLabel::text ( ) const

Return the text the widget displays.

◆ useBoldFont()

bool YLabel::useBoldFont ( ) const

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

◆ value()

std::string YLabel::value ( ) const

inline

Aliases for text().

◆ widgetClass()

const char * YLabel::widgetClass ( ) const

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:

/__w/libyui/libyui/libyui/src/YLabel.h
/__w/libyui/libyui/libyui/src/YLabel.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ YLabel()

◆ ~YLabel()

Member Function Documentation

◆ autoWrap()

◆ debugLabel()

◆ getProperty()

◆ isHeading()

◆ isOutputField()

◆ layoutPass()

◆ propertySet()

◆ setAutoWrap()

◆ setProperty()

◆ setText()

◆ setUseBoldFont()

◆ setValue()

◆ text()

◆ useBoldFont()

◆ value()

◆ widgetClass()