libyui  3.0.10
YIntField Class Reference

#include <YIntField.h>

Inheritance diagram for YIntField:
Collaboration 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)
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 YPropertySetpropertySet ()
virtual std::string shortcutString () const
virtual void setShortcutString (const std::string &str)
const char * userInputProperty ()

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

Detailed Description

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

Definition at line 38 of file YIntField.h.


Constructor & Destructor Documentation

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

Definition at line 50 of file YIntField.cc.

Here is the call graph for this function:

YIntField::~YIntField ( ) [virtual]

Destructor.

Definition at line 64 of file YIntField.cc.


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.

Definition at line 71 of file YIntField.cc.

Here is the call graph for this function:

YPropertyValue YIntField::getProperty ( const std::string &  propertyName) [virtual]

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

Definition at line 181 of file YIntField.cc.

Here is the call graph for this function:

std::string YIntField::label ( ) const

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

Definition at line 124 of file YIntField.cc.

int YIntField::maxValue ( ) const

Return the maximum value.

Definition at line 104 of file YIntField.cc.

int YIntField::minValue ( ) const

Return the minimum value.

Definition at line 84 of file YIntField.cc.

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.

Definition at line 139 of file YIntField.cc.

Here is the call graph for this function:

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.

Definition at line 131 of file YIntField.cc.

Here is the call graph for this 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.

Definition at line 111 of file YIntField.cc.

Here is the call graph for this function:

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.

Definition at line 91 of file YIntField.cc.

Here is the call graph for this function:

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.

Definition at line 163 of file YIntField.cc.

Here is the call graph for this function:

virtual void YIntField::setShortcutString ( const std::string &  str) [inline, virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 179 of file YIntField.h.

Here is the call graph for this function:

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.

Definition at line 81 of file YIntField.h.

Here is the call graph for this function:

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 std::string YIntField::shortcutString ( ) const [inline, virtual]

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

Reimplemented from YWidget.

Reimplemented from YWidget.

Definition at line 172 of file YIntField.h.

Here is the call graph for this function:

const char* YIntField::userInputProperty ( ) [inline, virtual]

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

Reimplemented from YWidget.

Definition at line 186 of file YIntField.h.

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.

Definition at line 66 of file YIntField.h.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations Friends