YIntField Class Reference

#include <YIntField.h>

Inheritance diagram for YIntField:

List of all members.

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)
string	label () const
virtual void	setLabel (const string &label)
virtual bool	setProperty (const string &propertyName, const YPropertyValue &val)
virtual YPropertyValue	getProperty (const string &propertyName)
virtual const YPropertySet &	propertySet ()
virtual string	shortcutString () const
virtual void	setShortcutString (const string &str)
const char *	userInputProperty ()
Protected Member Functions
	YIntField (YWidget *parent, const string &label, int minValue, int maxValue)
virtual void	setValueInternal (int val)=0
int	enforceRange (int val) const

---

Detailed Description

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

---

Constructor & Destructor Documentation

YIntField::YIntField	(	YWidget *	parent,
		const 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

(

)

[virtual]

Destructor.

---

Member Function Documentation

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.

YPropertyValue YIntField::getProperty

(

const string &

propertyName

)

[virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

string YIntField::label

(

)

const

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

int YIntField::maxValue

(

)

const

Return the maximum value.

int YIntField::minValue

(

)

const

Return the minimum value.

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.

void YIntField::setLabel

(

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

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.

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.

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

virtual void YIntField::setShortcutString

(

const string &

str

)

[inline, virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

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.

virtual void YIntField::setValueInternal

(

int

val

)

[protected, pure 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.

virtual string YIntField::shortcutString

(

)

const [inline, virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

const char* YIntField::userInputProperty

(

)

[inline, virtual]

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

Reimplemented from YWidget.

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.

virtual const char* YIntField::widgetClass

(

)

const [inline, virtual]

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:

• /data/gitorious.org/libyui/libyui-master/src/YIntField.h
• /data/gitorious.org/libyui/libyui-master/src/YIntField.cc