Rogue Wave Views Prototypes Package API Reference Guide |
Rogue Wave Views Documentation Home |
Format a float value into a string. More...
#include <ilviews/protos/useracc.h>
Public Member Functions | |
IlvFormatAccessor (const char *name, const IlvValueTypeClass *type, const char *formatValue, const char *maxCharsValue, const char *subacc) | |
Initializes a new formatting 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 . | |
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... | |
Format a float value into a string.
Library: ilvproto
IlvFormatAccessor
is used to format a value and then assign the formatted value to another accessor.
IlvFormatAccessor::IlvFormatAccessor | ( | const char * | name, |
const IlvValueTypeClass * | type, | ||
const char * | formatValue, | ||
const char * | maxCharsValue, | ||
const char * | subacc | ||
) |
Initializes a new formatting accessor.
When the value specified by name is changed, it is formatted using formatValue, which must contain a formatting string as defined by the printf()
C library function. The value is passed to the formatting function as a float
, so the format contained in formatValue should contain a g
or f
specifier. The formatted string is then assigned to the accessor specified by subacc. The maxCharsValue specifies the maximum length of the formatted string. If the string is longer, it is replaced by *
(star) characters. formatValue and maxCharsValue can contain a constant value, the name of another accessor, or an arithmetic expression that can contain accessor names and/or constants.
IlvUserAccessor::getValue()
. © Copyright 2016, 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.