Rogue Wave Views Prototypes Package API Reference Guide |
Rogue Wave Views Documentation Home |
Allows user actions that trigger a callback to, in turn, set an attribute. More...
#include <ilviews/protos/callbacc.h>
Public Member Functions | |
IlvCallbackAccessor (const char *name, const IlvValueTypeClass *type, const char *nodename, const char *callback, const char *queryacc) | |
Creates a callback accessor. More... | |
virtual IlBoolean | isOutputValue (const IlSymbol *name) const |
Queries if the accessor is an output accessor. More... | |
Public Member Functions inherited from IlvUserAccessor | |
IlvUserAccessor (const char *name, const IlvValueTypeClass *type, IlUInt flags=0) | |
Constructor. 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 | changeValue (IlvAccessorHolder *object, const IlvValue &val) |
Called by the method IlvAccessible::changeValue() for each IlvAccessor attached to the IlvAccessorHolder . | |
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 void | initialize (const IlvAccessorHolder *object) |
Attachment method to an IlvAccessorHolder . More... | |
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... | |
Allows user actions that trigger a callback to, in turn, set an attribute.
Library: ilvproto
This class lets you define a notifying attribute (also called output value) for your group. This notifying value is triggered when the callback of one of the graphic objects of the prototype is executed.
IlvCallbackAccessor::IlvCallbackAccessor | ( | const char * | name, |
const IlvValueTypeClass * | type, | ||
const char * | nodename, | ||
const char * | callback, | ||
const char * | queryacc | ||
) |
Creates a callback accessor.
name | Name of the attribute. |
type | Type of the attribute. Used only for initialization purposes. |
nodename | Name of the graphic node that defines the callback, or "[All Nodes]" if the accessor is to be called for all callbacks triggered by all nodes. |
callback | The name of the callback (usually "Generic"). |
queryacc | Value that will be queried and copied to the output value. This can be an expression. |
|
protectedvirtual |
Attachment method to an IlvAccessorHolder
.
This method is called when the accessor object is attached to a group. You can redefine it in subclasses of IlvUserAccessor
to perform any kind of initialization.
object | The object the accessor is attached to. |
Reimplemented from IlvUserAccessor.
Queries if the accessor is an output accessor.
IlTrue
if the accessor is an output accessor, and IlFalse
otherwise. Reimplemented from IlvUserAccessor.
© 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.