rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Prototypes Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvMinMaxAccessor Class Reference

Modifies an attribute with respect to numerical bounds. More...

#include <ilviews/protos/condacc.h>

Inheritance diagram for IlvMinMaxAccessor:
IlvUserAccessor IlvAccessor

List of all members.

Public Member Functions

 IlvMinMaxAccessor (const char *name, const IlvValueTypeClass *type, IlvDisplay *display, const char *minimumValue, const char *maximumValue, const char *exceptValue, const char *assignedAttribute, const char *valueIfBelow, const char *valueIfInBetween, const char *valueIfAbove)
 Creates a new IlvMinMaxAccessor.

Protected Member Functions

virtual IlBoolean changeValue (IlvAccessorHolder *object, const IlvValue &val)
 Called by the method IlvAccessible::changeValue for each IlvAccessor attached to the IlvAccessorHolder.

Detailed Description

Modifies an attribute with respect to numerical bounds.

Library: ilvproto

Specialized accessor that handles values with a minimum and a maximum boundary. This accessor allows you to modify another attribute when the value goes beyond the minimum and the maximum values specified.


Constructor & Destructor Documentation

IlvMinMaxAccessor::IlvMinMaxAccessor ( const char *  name,
const IlvValueTypeClass type,
IlvDisplay display,
const char *  minimumValue,
const char *  maximumValue,
const char *  exceptValue,
const char *  assignedAttribute,
const char *  valueIfBelow,
const char *  valueIfInBetween,
const char *  valueIfAbove 
)

Creates a new IlvMinMaxAccessor.

minimumValue, maximumValue, exceptIf, valueIfBelow, valueIfInBetween, and valueIfAbove can contain a constant value, the name of another accessor, or an arithmetic expression that can contain accessor names and/or constants (see IlvUserAccessor::getValue).

Parameters:
name Name of the accessor.
type Type of the accessor. It will most likely be a numeric type, such as IlvValueIntType or IlvValueFloatType.
display Display used to initialize value types.
minimumValue Minimum bound used for the conditional assignment.
maximumValue Maximum bound used for the conditional assignment.
exceptIf Boolean value that is tested before performing the assignment. If it returns IlTrue, the conditional assignment is not performed.
assignedAttribute Attribute changed when the test is evaluated.
valueIfBelow Value assigned to assignedAttribute if the current value is below minimumValue.
valueIfInBetween Value assigned to assignedAttribute if the current value is between maximumValue and minimumValue.
valueIfAbove Value assigned to assignedAttribute if the current value is above maximumValue.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© Copyright 2012, 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.