rwlogo

Rogue Wave Views
Studio Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
List of all members | Public Member Functions
IlvStIPrecondition Class Referenceabstract

Inspector class. More...

#include <ivstudio/inspectors/precond.h>

Inheritance diagram for IlvStIPrecondition:
IlvStICallbackPrecondition IlvStIPreconditionValue

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

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
propsContains the correct property when the test fails.
statusContains the correct access right when the test fails.
Returns
IlTrue if the test succeeds and IlFalse otherwise.

Implemented in IlvStICallbackPrecondition, and IlvStIPreconditionValue.


© Copyright 2015, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.