IlvStIRangeValidator Class Reference

Inspector class. More...

#include <ivstudio/inspectors/inspvali.h>

Inheritance diagram for IlvStIRangeValidator:

Public Member Functions
	IlvStIRangeValidator (IlInt minVal=0, IlInt maxVal=0, const char *msg=0, IlBoolean validateOnApp=IlTrue)
	Initializes an instance of IlvStIRangeValidator. More...
	IlvStIRangeValidator (IlUInt minVal, IlUInt maxVal, const char *msg=0, IlBoolean validateOnApp=IlTrue)
	Initializes an instance of IlvStIRangeValidator. More...
	IlvStIRangeValidator (IlFloat minVal, IlFloat maxVal, const char *msg=0, IlBoolean validateOnApp=IlTrue)
	Initializes an instance of IlvStIRangeValidator. More...
	IlvStIRangeValidator (IlDouble minVal, IlDouble maxVal, const char *msg=0, IlBoolean validateOnApp=IlTrue)
	Initializes an instance of IlvStIRangeValidator. More...
	IlvStIRangeValidator (const ILV_TM_PREF tm *minVal, const ILV_TM_PREF tm *maxVal, const char *msg=0, IlBoolean validateOnApp=IlTrue)
	Initializes an instance of IlvStIRangeValidator. More...
virtual IlvStIError *	check (const IlvStIProperty *) const
	Returns an error if the value of the property is not valid. More...
Public Member Functions inherited from IlvStIValidator
	IlvStIValidator (const char *name=0, IlBoolean validateOnApp=IlTrue)
	Initializes an instance of IlvStIValidator. More...
IlBoolean	getValidateOnApply () const
	Returns the validation mode status. More...
void	lock ()
	Locks the validator once. More...
void	setValidateOnApply (IlBoolean validate)
	Sets the validation mode. More...
void	unLock ()
	Unlocks the validator once. More...
Public Member Functions inherited from IlvStNamedObject
const char *	getName () const
	Returns the name of the object. More...
virtual void	setName (const char *name)
	Sets the name of the object. More...

Detailed Description

Inspector class.

Library: ivstudio

This class defines a validator that tests whether a value is contained between two given values.

See Also

IlvStIPropertyAccessor.

Constructor & Destructor Documentation

IlvStIRangeValidator::IlvStIRangeValidator	(	IlInt	minVal = 0,
		IlInt	maxVal = 0,
		const char *	msg = 0,
		IlBoolean	validateOnApp = IlTrue
	)

Initializes an instance of IlvStIRangeValidator.

Parameters

minVal	The minimum value of the range.
maxVal	The maximum value of the range.
msg	The error message that is returned when the tested value is out of the specified limits. This error message can contain one or more %1, %2, and %3 substrings, which are replaced by the minimum value, the maximum value, and the tested value, respectively.
validateOnApp	If IlTrue, the test must be run when the user clicks on Apply. Otherwise, it should be run immediately after the changes have been made. This parameter is not directly used by the validator, but by the accessor that holds it.

IlvStIRangeValidator::IlvStIRangeValidator	(	IlUInt	minVal,
		IlUInt	maxVal,
		const char *	msg = 0,
		IlBoolean	validateOnApp = IlTrue
	)

Initializes an instance of IlvStIRangeValidator.

Parameters

minVal	The minimum value of the range.
maxVal	The maximum value of the range.
msg	The error message that is returned when the tested value is out of the specified limits. This error message can contain one or more %1, %2, and %3 substrings, which are replaced by the minimum value, the maximum value, and the tested value, respectively.
validateOnApp	If IlTrue, the test must be run when the user clicks on Apply. Otherwise, it should be run immediately after the changes have been made. This parameter is not directly used by the validator, but by the accessor that holds it.

IlvStIRangeValidator::IlvStIRangeValidator	(	IlFloat	minVal,
		IlFloat	maxVal,
		const char *	msg = 0,
		IlBoolean	validateOnApp = IlTrue
	)

Initializes an instance of IlvStIRangeValidator.

Parameters

minVal	The minimum value of the range.
maxVal	The maximum value of the range.
msg	The error message that is returned when the tested value is out of the specified limits. This error message can contain one or more %1, %2, and %3 substrings, which are replaced by the minimum value, the maximum value, and the tested value, respectively.
validateOnApp	If IlTrue, the test must be run when the user clicks on Apply. Otherwise, it should be run immediately after the changes have been made. This parameter is not directly used by the validator, but by the accessor that holds it.

IlvStIRangeValidator::IlvStIRangeValidator	(	IlDouble	minVal,
		IlDouble	maxVal,
		const char *	msg = 0,
		IlBoolean	validateOnApp = IlTrue
	)

Initializes an instance of IlvStIRangeValidator.

Parameters

minVal	The minimum value of the range.
maxVal	The maximum value of the range.
msg	The error message that is returned when the tested value is out of the specified limits. This error message can contain one or more %1, %2, and %3 substrings, which are replaced by the minimum value, the maximum value, and the tested value, respectively.
validateOnApp	If IlTrue, the test must be run when the user clicks on Apply. Otherwise, it should be run immediately after the changes have been made. This parameter is not directly used by the validator, but by the accessor that holds it.

IlvStIRangeValidator::IlvStIRangeValidator	(	const ILV_TM_PREF tm *	minVal,
		const ILV_TM_PREF tm *	maxVal,
		const char *	msg = 0,
		IlBoolean	validateOnApp = IlTrue
	)

Initializes an instance of IlvStIRangeValidator.

Parameters

minVal	The minimum value of the range.
maxVal	The maximum value of the range.
msg	The error message that is returned when the tested value is out of the specified limits. This error message can contain one or more %1, %2, and %3 substrings, which are replaced by the minimum value, the maximum value, and the tested value, respectively.
validateOnApp	If IlTrue, the test must be run when the user clicks on Apply. Otherwise, it should be run immediately after the changes have been made. This parameter is not directly used by the validator, but by the accessor that holds it.

Member Function Documentation

virtual IlvStIError* IlvStIRangeValidator::check ( const IlvStIProperty *  prop ) const

virtual

Returns an error if the value of the property is not valid.

Parameters

prop	The property.

Returns

An error if the value of the property is not valid.

Implements IlvStIValidator.