Views
Studio Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvStIRangeValidator Class Reference

Inspector class. More...

#include <ivstudio/inspectors/inspvali.h>

Inheritance diagram for IlvStIRangeValidator:
IlvStIValidator IlvStNamedObject

Public Member Functions

 IlvStIRangeValidator (const tm *minVal, const tm *maxVal, const char *msg=0, IlBoolean validateOnApp=IlTrue)
 Initializes a new instance of IlvStIRangeValidator. More...
 
 IlvStIRangeValidator (IlDouble minVal, IlDouble maxVal, const char *msg=0, IlBoolean validateOnApp=IlTrue)
 Initializes a new instance of IlvStIRangeValidator. More...
 
 IlvStIRangeValidator (IlFloat minVal, IlFloat maxVal, const char *msg=0, IlBoolean validateOnApp=IlTrue)
 Initializes an instance of IlvStIRangeValidator. More...
 
 IlvStIRangeValidator (IlInt minVal=0, IlInt maxVal=0, const char *msg=0, IlBoolean validateOnApp=IlTrue)
 Initializes a new instance of IlvStIRangeValidator. More...
 
 IlvStIRangeValidator (IlUInt minVal, IlUInt maxVal, const char *msg=0, IlBoolean validateOnApp=IlTrue)
 Initializes a new instance of IlvStIRangeValidator. More...
 
virtual IlvStIErrorcheck (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 a new 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() [1/5]

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

Initializes a new instance of IlvStIRangeValidator.

Parameters
minValThe minimum value of the range.
maxValThe maximum value of the range.
msgThe 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.
validateOnAppIf 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() [2/5]

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

Initializes a new instance of IlvStIRangeValidator.

Parameters
minValThe minimum value of the range.
maxValThe maximum value of the range.
msgThe 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.
validateOnAppIf 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() [3/5]

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

Initializes an instance of IlvStIRangeValidator.

Parameters
minValThe minimum value of the range.
maxValThe maximum value of the range.
msgThe 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.
validateOnAppIf 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() [4/5]

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

Initializes a new instance of IlvStIRangeValidator.

Parameters
minValThe minimum value of the range.
maxValThe maximum value of the range.
msgThe 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.
validateOnAppIf 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() [5/5]

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

Initializes a new instance of IlvStIRangeValidator.

Parameters
minValThe minimum value of the range.
maxValThe maximum value of the range.
msgThe 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.
validateOnAppIf 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

◆ check()

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

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

Parameters
propThe property.
Returns
An error if the value of the property is not valid.

Implements IlvStIValidator.