Rogue Wave Views Prototypes Package API Reference Guide |
Rogue Wave Views Documentation Home |
Abstract class handling event behaviors, usually mouse or keyboard events. More...
#include <ilviews/protos/eventacc.h>
Public Member Functions | |
IlvAbstractEventAccessor (const char *name, const IlvValueTypeClass *type, const char *nodeName) | |
Creates an event accessor. More... | |
virtual IlBoolean | handleEvent (IlvAccessorHolder *object, IlvGraphic *g, IlvEvent &event, IlvView *view, IlvTransformer *t) |
Event handling method, to be derived in subclasses. More... | |
virtual void | initialize (const IlvAccessorHolder *object) |
Attachment method to an IlvAccessorHolder . More... | |
Public Member Functions inherited from IlvUserAccessor | |
IlvUserAccessor (const char *name, const IlvValueTypeClass *type, IlUInt flags=0) | |
Constructor. 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 | 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... | |
Additional Inherited Members | |
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... | |
Abstract class handling event behaviors, usually mouse or keyboard events.
Library: ilvproto
Allows you to catch user events on specified nodes of a group in order to trigger behaviors. It is the superclass of IlvEventAccessor
, IlvRotationAccessor
, IlvSlideXAccessor
, and IlvSlideYAccessor
. You will not use this class directly, unless you need to define a new user accessor subclass that handles user events.
IlvAbstractEventAccessor::IlvAbstractEventAccessor | ( | const char * | name, |
const IlvValueTypeClass * | type, | ||
const char * | nodeName | ||
) |
Creates an event accessor.
name | Name of the attribute that will be triggered when an event of the appropriate type is received. |
type | Type of the accessor. Used only for initialization purposes. |
nodeName | Name of the node for which events are handled. If nodeName is "[All nodes]" , the accessor handles user events received by any node of the group to which it is attached. If nodeName is the name of a subgroup, the accessor handles events received by any node of the subgroup. |
|
virtual |
Event handling method, to be derived in subclasses.
Called for every event received by one of the nodes specified by the nodeName argument of the constructor. It must be redefined by subclasses to implement the effect of the accessor.
object | Group to which the accessor is attached. |
g | Graphic object that received the event. |
event | Event received. |
view | View in which the event was received. |
t | Transformer associated with the view, or 0 if the view has no transformer. |
Reimplemented in IlvSlideYAccessor, IlvSlideXAccessor, IlvEventAccessor, and IlvRotationAccessor.
|
virtual |
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.
Reimplemented in IlvSlideYAccessor, IlvSlideXAccessor, and IlvRotationAccessor.
© 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.