IlvStIPrecondition Class Reference

Inspector class. More...

#include <ivstudio/inspectors/precond.h>

Inheritance diagram for IlvStIPrecondition:

Public Member Functions
virtual IlBoolean	isAccessible (IlvStIProperty **props=0, IlvStIPropertyAccessor::PropertyStatus *status=0) const =0
	Returns IlTrue if the test succeeds. More...

Detailed Description

Inspector class.

Library: ivstudio

Precondition tests are used by accessors to determine whether they can access the inspected property. For example, it makes sense to access the scientific mode of a number field only if the float mode is set. An accessor to the scientific mode can run a precondition test on the float mode to know whether access is possible.

See also

IlvStICallbackPrecondition, IlvStIPreconditionValue.

Member Function Documentation

isAccessible()

virtual IlBoolean IlvStIPrecondition::isAccessible ( IlvStIProperty **  props = 0, IlvStIPropertyAccessor::PropertyStatus *  status = 0  ) const

pure virtual

Returns IlTrue if the test succeeds.

The two parameters are set by the method if the test fails. They indicate the correct value to be used in place of the tested value and the access right to this value, respectively. Setting these values is optional.

Parameters

props	Contains the correct property when the test fails.
status	Contains the correct access right when the test fails.

Returns

IlTrue if the test succeeds and IlFalse otherwise.

Implemented in IlvStICallbackPrecondition, and IlvStIPreconditionValue.