IlvStICallbackPrecondition Class Reference

Inspector class. More...

#include <ivstudio/inspectors/precond.h>

Inheritance diagram for IlvStICallbackPrecondition:

Public Types
typedef IlBoolean(*	PreconditionValueCallback) (IlvStIProperty *prop, IlAny data, IlvStIProperty **val, IlvStIPropertyAccessor::PropertyStatus *status)

Public Member Functions
	IlvStICallbackPrecondition (IlvStIPropertyAccessor *accessor=0, PreconditionValueCallback callback=0, IlAny data=0)
	Initializes a new instance of IlvStICallbackPrecondition. More...
virtual IlBoolean	isAccessible (IlvStIProperty **=0, IlvStIPropertyAccessor::PropertyStatus *=0) const
	Returns IlTrue if the test succeeds. More...

Detailed Description

Inspector class.

Library: ivstudio

This class stores a precondition callback that is invoked from the method isAccessible(). It is used to avoid deriving the IlvStIPrecondition class when the implementation of the isAccessible() method can be easily contained in a callback of type PreconditionValueCallback.

See also

IlvStIPrecondition.

Member Typedef Documentation

PreconditionValueCallback

IlvStICallbackPrecondition::PreconditionValueCallback

Defines the format of the callback provided as an argument to the constructor of the IlvStICallbackPrecondition class. The last two parameters are set by the callback 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

prop	The property which contains the value to be tested.
data	The user information, comes from the constructor.
val	Contains the correct property when the test fails.
status	Contains the correct access right when the test fails.

Returns

IlTrue is the test succeeds and IlFalse otherwise.

Constructor & Destructor Documentation

IlvStICallbackPrecondition()

IlvStICallbackPrecondition::IlvStICallbackPrecondition	(	IlvStIPropertyAccessor *	accessor = 0,
		PreconditionValueCallback	callback = 0,
		IlAny	data = 0
	)

Initializes a new instance of IlvStICallbackPrecondition.

Parameters

accessor	The accessor which provides the value.
callback	The callback which is called by the isAccessible() method.
data	The user information.

Member Function Documentation

isAccessible()

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

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.

Implements IlvStIPrecondition.