IlvMultipleUserAccessor Class Reference

Base class for accessors that represent several attributes. More...

#include <ilviews/protos/useracc.h>

Inheritance diagram for IlvMultipleUserAccessor:

Public Member Functions
	IlvMultipleUserAccessor (const char *name, IlUShort count, const char **names, IlvValueTypeClass **types)
	Initializes a new multiple accessor. 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.
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 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.
virtual void	getAccessors (const IlSymbol *const **, const IlvValueTypeClass *const **, IlUInt &) const
	Returns the names and types of the values handled by this accessor. More...
virtual IlShort	matchValues (const IlvAccessorHolder *, const IlvValue *, IlUShort, IlvValue *=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 *, IlvValue &) const
	Called by the method IlvAccessible::queryValue() 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

Base class for accessors that represent several attributes.

Library: ilvproto

IlvMultipleUserAccessor is used as a base class for accessors that respond to changes of several values at the same time. This class is not used directly; only its subclasses are useful to designers of prototypes.

See also

IlvMultipleAccessor, IlvXYChartAccessor.

Constructor & Destructor Documentation

IlvMultipleUserAccessor()

IlvMultipleUserAccessor::IlvMultipleUserAccessor	(	const char *	name,
		IlUShort	count,
		const char **	names,
		IlvValueTypeClass **	types
	)

Initializes a new multiple accessor.

The changeValues() and queryValues() methods of this accessor are called when several of the values specified by names and types are changed or queried in a single call to changeValues() or queryValues() on the accessor holder.

Member Function Documentation

getAccessors()

virtual void IlvMultipleUserAccessor::getAccessors ( const IlSymbol *const **  accessors, const IlvValueTypeClass *const **  types, IlUInt &  count  ) const

protectedvirtual

Returns the names and types of the values handled by this accessor.

Returns

The names and types of the values handled by this accessor. The base class implementation adds only the name and type of this accessor to the accessors and types lists, but subclasses (for example IlvMultipleAccessor) may add several names and types to signal that the accessor can respond to requests for several values.

Reimplemented from IlvAccessor.

matchValues()

virtual IlShort IlvMultipleUserAccessor::matchValues ( const IlvAccessorHolder *  object, const IlvValue *  values, IlUShort  count, IlvValue *  matchingValues = 0  ) const

protectedvirtual

Returns the number of values that are handled by the accessor in the values array of length count.

The matching values are copied to the matchingValues array, which must have a length of at least count. This method is called by the changeValue()[s]/queryValue()[s] methods of the IlvAccessorHolder class to determine which IlvAccessor objects respond to a request for a set of value names. All the accessors that return a non-null count of matching values will be called by the IlvAccessorHolder, with the matching values as arguments. The base class implementation looks for a value corresponding to the accessor name given in values and copies it to matchingValues. Subclasses of IlvAccessor (for example IlvMultipleAccessor) may match several values.

Reimplemented from IlvAccessor.