IlvStIValidator Class Reference

Inspector class. More...

#include <ivstudio/inspectors/inspvali.h>

Inheritance diagram for IlvStIValidator:

Public Member Functions
	IlvStIValidator (const char *name=0, IlBoolean validateOnApp=IlTrue)
	Initializes a new instance of IlvStIValidator. More...
virtual IlvStIError *	check (const IlvStIProperty *prop) const =0
	Returns an error if the value of the property is not valid. 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 is used by the accessors to test whether the values entered by the user are valid.

See also

IlvStIPropertyAccessor.

Constructor & Destructor Documentation

IlvStIValidator()

IlvStIValidator::IlvStIValidator	(	const char *	name = 0,
		IlBoolean	validateOnApp = IlTrue
	)

Initializes a new instance of IlvStIValidator.

Parameters

name	The validator name.
validateOnApp	If IlTrue, the test must be run when the user clicks on Apply. Otherwise, it must 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* IlvStIValidator::check ( const IlvStIProperty *  prop ) const

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

Implemented in IlvStIRangeValidator.

getValidateOnApply()

IlBoolean IlvStIValidator::getValidateOnApply

(

)

const

Returns the validation mode status.

Returns

IlTrue if the test must be run when the user clicks on Apply.

lock()

void IlvStIValidator::lock

(

)

Locks the validator once.

Call this method if you want this object to be shared among different objects.

setValidateOnApply()

void IlvStIValidator::setValidateOnApply

(

IlBoolean

validate

)

Sets the validation mode.

Parameters

validate

If IlTrue, the test must be run when the user clicks on Apply.

unLock()

void IlvStIValidator::unLock

(

)

Unlocks the validator once.

The accessor is destroyed when it is no longer locked.