IlvValueTypeClass Class Reference

Base class for value types. More...

#include <ilviews/base/value.h>

Inherited by IlvValueAntialiasingModeTypeClass, IlvValueAnyTypeClass, IlvValueArcModeTypeClass, IlvValueBitmapTypeClass, IlvValueBooleanTypeClass, IlvValueDirectionTypeClass, IlvValueDoubleTypeClass, IlvValueEnumTypeClass, IlvValueFillRuleTypeClass, IlvValueFillStyleTypeClass, IlvValueFloatArrayTypeClass, IlvValueFloatTypeClass, IlvValueInterfaceTypeClass, IlvValueIntTypeClass, IlvValueMethodTypeClass, IlvValueNoTypeClass, IlvValueNullTypeClass, IlvValuePointArrayTypeClass, IlvValueResourceTypeClass, IlvValueStringArrayTypeClass, IlvValueStringTypeClass, IlvValueTimeTypeClass, IlvValueUIntArrayTypeClass, and IlvValueUIntTypeClass.

Public Member Functions
virtual IlInt	compareValues (const IlvValue &v1, const IlvValue &v2) const
	Compares two values. More...
virtual void	copy (IlvValue &dest, const IlvValue &src) const
	Copies a value. More...
virtual IlvValue *	createValue (const char *name=0) const
	Creates a new value for this type. More...
virtual void	deleteValue (IlvValue &value) const
	Deletes the internals of a value. More...
virtual IlBoolean	fromString (IlvValue &value, const char *string, IlAny arg=0) const
	Converts a string to a value of this type. More...
virtual const char *	name () const
	Retrieves the name of this type. More...
virtual const char *	toString (const IlvValue &value) const
	Creates a textual representation of a value of this type. More...

Static Public Member Functions
static IlvValueTypeClass *	Get (const char *name)
	Get a type instance by name. More...
static IlvValueTypeClass **	GetAll (IlUInt &count)
	Get all registered types. More...

Detailed Description

Base class for value types.

Library: xviews or winviews or mviews (mutually exclusive)

This class handles the types that instances of IlvValue can hold.
There are several predefined subtypes of IlvValueTypeClass that let you manipulate all the basic types regularly used in Rogue Wave Views.
There is a unique instance of a type, and this instance is shared by all instances of IlvValue that have this type.

Member Function Documentation

virtual IlInt IlvValueTypeClass::compareValues ( const IlvValue &  v1, const IlvValue &  v2  ) const

virtual

Compares two values.

Both value must have the type this.

Parameters

v1	The first value to compare.
v2	The second value to compare.

Returns

IlTrue if v1 and v2 are identical from this type's perspective.

virtual void IlvValueTypeClass::copy ( IlvValue &  dest, const IlvValue &  src  ) const

virtual

Copies a value.

Parameters

dest	The destination value object that is set to a copy of src.
src	The source value.

virtual IlvValue* IlvValueTypeClass::createValue ( const char *  name = 0 ) const

virtual

Creates a new value for this type.

Parameters

name	The name of the value to be created.

Returns

A new instance of IlvValue with the indicated name.

virtual void IlvValueTypeClass::deleteValue ( IlvValue &  value ) const

virtual

Deletes the internals of a value.

If this type has stored information that needs cleanup, this member function is meant to do the job.

virtual IlBoolean IlvValueTypeClass::fromString ( IlvValue &  value, const char *  string, IlAny  arg = 0  ) const

virtual

Converts a string to a value of this type.

Parameters

value	The value that is set from a conversion of string.
string	The input string to be converted.
arg	An argument that may be necessary for the conversion to succeed.

static IlvValueTypeClass* IlvValueTypeClass::Get ( const char *  name )

static

Get a type instance by name.

Parameters

name	The name of the type to retrieve.

Returns

The instance of the indicated type.

static IlvValueTypeClass** IlvValueTypeClass::GetAll ( IlUInt &  count )

static

Get all registered types.

Parameters

count

Is set to the number of returned types.

Returns

An array of count type instances. You must never modify or delete this array. This array is managed by an IlPoolOf_ILVOPENPAR_Pointer_ILVCLOSEPAR_.

virtual const char* IlvValueTypeClass::name ( ) const

virtual

Retrieves the name of this type.

Returns

The name of this type. You must never delete or modify this string.

virtual const char* IlvValueTypeClass::toString ( const IlvValue &  value ) const

virtual

Creates a textual representation of a value of this type.

Parameters

value

The value whose textual representation is requested.

Returns

A textual representation of value. You must never delete or modify this string.