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.
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.
§ compareValues()
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.
§ copy()
| 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. |
§ createValue()
| 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.
§ deleteValue()
| 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.
§ fromString()
| 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. |
§ Get()
Get a type instance by name.
- Parameters
-
| name | The name of the type to retrieve. |
- Returns
- The instance of the indicated type.
§ GetAll()
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_.
§ name()
| 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.
§ toString()
| 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.
© Copyright 2017, 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.
