YIntField Class Reference

#include <YIntField.h>

Inheritance diagram for YIntField:

Collaboration diagram for YIntField:

Public Member Functions
virtual	~YIntField ()
virtual const char *	widgetClass () const
virtual int	value ()=0
void	setValue (int val)
int	minValue () const
void	setMinValue (int val)
int	maxValue () const
void	setMaxValue (int val)
std::string	label () const
virtual void	setLabel (const std::string &label)
virtual bool	setProperty (const std::string &propertyName, const YPropertyValue &val)
virtual YPropertyValue	getProperty (const std::string &propertyName)
virtual const YPropertySet &	propertySet ()
virtual std::string	shortcutString () const
virtual void	setShortcutString (const std::string &str)
const char *	userInputProperty ()
Public Member Functions inherited from YWidget
virtual	~YWidget ()
virtual std::string	debugLabel () const
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 ()
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
	YIntField (YWidget *parent, const std::string &label, int minValue, int maxValue)
virtual void	setValueInternal (int val)=0
int	enforceRange (int val) const
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

IntField: Input field for integer values. Enforces input range between a specified minimum and maximum value.

Constructor & Destructor Documentation

YIntField()

YIntField::YIntField ( YWidget * parent, const std::string & label, int minValue, int maxValue )

protected

Constructor.

Create an IntField with 'label' as the caption, and the specified minimum and maximum values.

Note that YWidgetFactory::createIntField() also has an 'initialValue' parameter that is not used here (because the current value is not stored in this base class, but in the derived class).

~YIntField()

YIntField::~YIntField ( )

virtual

Destructor.

Member Function Documentation

enforceRange()

int YIntField::enforceRange ( int val ) const

protected

Enforce 'val' to be between minValue and maxValue. Return a value that is in range. This does not change the internally stored value of this IntField in any way.

getProperty()

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

virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

label()

string YIntField::label

(

)

const

Get the label (the caption above the input field).

maxValue()

int YIntField::maxValue

(

)

const

Return the maximum value.

minValue()

int YIntField::minValue

(

)

const

Return the minimum value.

propertySet()

const YPropertySet & YIntField::propertySet ( )

virtual

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

Reimplemented from YWidget.

Reimplemented from YWidget.

setLabel()

void YIntField::setLabel ( const std::string & label )

virtual

Set the label (the caption above the input field).

Derived classes are free to reimplement this, but they should call this base class method at the end of the overloaded function.

setMaxValue()

void YIntField::setMaxValue

(

int

val

)

Set a new maximum value. If the current value is greater than that, it will be set to the new maximum.

setMinValue()

void YIntField::setMinValue

(

int

val

)

Set a new minimum value. If the current value is less than that, it will be set to the new minimum.

setProperty()

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

virtual

Set a property. Reimplemented from YWidget.

This function may throw YUIPropertyExceptions.

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.

setShortcutString()

virtual void YIntField::setShortcutString ( const std::string & str )

inlinevirtual

Set the string of this widget that holds the keyboard shortcut.

Reimplemented from YWidget.

Reimplemented from YWidget.

setValue()

void YIntField::setValue ( int val )

inline

Set the current value (the number entered by the user or set from the outside) of this IntField. This method enforces 'val to be between minValue and maxValue.

setValueInternal()

virtual void YIntField::setValueInternal ( int val )

protectedpure virtual

Set the current value (the number entered by the user or set from the outside) of this IntField. 'val' is guaranteed to be between minValue and maxValue; no further checks are required.

Derived classes are required to implement this method.

shortcutString()

virtual std::string YIntField::shortcutString ( ) const

inlinevirtual

Get the string of this widget that holds the keyboard shortcut.

Reimplemented from YWidget.

Reimplemented from YWidget.

userInputProperty()

const char * YIntField::userInputProperty ( )

inlinevirtual

The name of the widget property that will return user input. Inherited from YWidget.

Reimplemented from YWidget.

value()

virtual int YIntField::value ( )

pure virtual

Get the current value (the number entered by the user or set from the outside) of this IntField.

Derived classes are required to implement this.

widgetClass()

virtual const char * YIntField::widgetClass ( ) const

inlinevirtual

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

Reimplemented from YWidget.

Reimplemented in YSlider.

---

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

• /__w/libyui/libyui/libyui/src/YIntField.h
• /__w/libyui/libyui/libyui/src/YIntField.cc