IlvCounterAccessor Class Reference

Defines a counter. More...

#include <ilviews/protos/useracc.h>

Inheritance diagram for IlvCounterAccessor:

Public Member Functions
	IlvCounterAccessor (const char *name, const IlvValueTypeClass *type, const char *counterValue, const char *maxValue)
	Initializes a counter accessor of name name and type type. More...
Public Member Functions inherited from IlvUserAccessor
	IlvUserAccessor (const char *name, const IlvValueTypeClass *type, IlUInt flags=0)
	Constructor. More...
virtual void	initialize (const IlvAccessorHolder *object)
	Attachment method to an IlvAccessorHolder. More...
virtual IlBoolean	isOutputValue (const IlSymbol *) const
	Queries if the accessor is an output accessor. More...
IlBoolean	isPrivate () const
	Checks the private status. More...
IlBoolean	isRuntime () const
	Checks the RunTime status. More...
void	setPrivate (IlBoolean val)
	Sets the Private flag of this accessor. More...
void	setRuntime (IlBoolean runTime)
	Sets the RunTime flag of this accessor. More...
Public Member Functions inherited from IlvAccessor
	IlvAccessor (const char *name, IlvValueTypeClass *type)
	Creates a new accessor of name name and type type.
virtual IlBoolean	changeValues (IlvAccessorHolder *object, const IlvValue *values, IlUShort count)
	Called by the method IlvAccessible::changeValues() for each IlvAccessor attached to the IlvAccessorHolder.
virtual void	getAccessors (const IlSymbol *const **accessors, const IlvValueTypeClass *const **types, IlUInt &count) const
	Returns the names and types of the values handled by this accessor. More...
const IlSymbol *	getName () const
	Returns the name of the accessor. More...
IlvValueTypeClass *	getType () const
	Returns the type of the accessor. More...
virtual IlBoolean	isOutputAccessor (IlBoolean &inputAndOutput)
	Queries if the accessor is an output accessor. More...
virtual IlShort	matchValues (const IlvAccessorHolder *object, const IlvValue *values, IlUShort count, IlvValue *matchingValues=0) const
	Returns the number of values that are handled by the accessor in the values array of length count. More...
virtual IlvValue &	queryValue (const IlvAccessorHolder *object, IlvValue &val) const
	Called by the method IlvAccessible::queryValue() for each IlvAccessor attached to the IlvAccessorHolder.
virtual void	queryValues (const IlvAccessorHolder *object, IlvValue *values, IlUShort count) const
	Called by the method IlvAccessible::queryValues() for each IlvAccessor attached to the IlvAccessorHolder.
void	setName (const IlSymbol *name)
	Sets the name of the accessor. More...

Protected Member Functions
virtual IlBoolean	changeValue (IlvAccessorHolder *, const IlvValue &)
	Called by the method IlvAccessible::changeValue() for each IlvAccessor attached to the IlvAccessorHolder.
Protected Member Functions inherited from IlvUserAccessor
virtual IlUInt	compareValues (const IlvAccessorHolder *object, const IlvAccessible *ref, IlvValue *values, IlUShort count, IlvValueArray &diffs) const
	Compares the values in ref and object and returns the differing values. More...
IlBoolean	getValue (IlvValue &val, const IlvAccessorHolder *object, IlvDisplay *display, IlvValueTypeClass *typeClass=0, IlSymbol *typeVal=0, const IlvValue *arg=0) const
	Evaluates a parameter of a user accessor. More...

Detailed Description

Defines a counter.

Library: ilvproto

The IlvCounterAccessor class lets you define a counter. Modifying the value of this accessor causes another value to be incremented or the current value to be reset to 0 (if a maximum is reached).

Warning

The undo/redo mechanism is implemented by storing attribute values before changing them, and then restoring them if the user has asked the previous operation to be undone. Because the side effect of the counter accessor is not reversible, it may affect correct behavior of undo/redo. It is not recommended to implement counters in prototypes or keep any other state information that should belong to the prototype model rather than to its presentation.

Constructor & Destructor Documentation

IlvCounterAccessor()

IlvCounterAccessor::IlvCounterAccessor	(	const char *	name,
		const IlvValueTypeClass *	type,
		const char *	counterValue,
		const char *	maxValue
	)

Initializes a counter accessor of name name and type type.

counterValue is the name of the value to be incremented. maxValue is the maximum value. maxValue 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()).