rwlogo

Rogue Wave Views
Prototypes Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
List of all members | Public Member Functions
IlvEventAccessor Class Reference

Handling events behavior (usually mouse or keyboard events). More...

#include <ilviews/protos/eventacc.h>

Inheritance diagram for IlvEventAccessor:
IlvAbstractEventAccessor IlvUserAccessor IlvAccessor

Public Member Functions

 IlvEventAccessor (const char *name, const IlvValueTypeClass *type, const char *nodeName, IlvEventType eventType, IlUShort detail, IlUShort modifiers, IlvEventAccessorData whichData)
 Creates an event accessor. More...
 
virtual IlBoolean handleEvent (IlvAccessorHolder *object, IlvGraphic *g, IlvEvent &, IlvView *, IlvTransformer *t)
 Filters the events and performs the value change of the attribute (if appropriate). More...
 
- Public Member Functions inherited from IlvAbstractEventAccessor
 IlvAbstractEventAccessor (const char *name, const IlvValueTypeClass *type, const char *nodeName)
 Creates an event accessor. 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 IlSymbolgetName () const
 Returns the name of the accessor. More...
 
IlvValueTypeClassgetType () 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 IlvValuequeryValue (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...
 

Detailed Description

Handling events behavior (usually mouse or keyboard events).

Library: ilvproto

IlvEventAccessor is a subtype of the IlvAbstractEventAccessor class that handles events of a specified type. When an event is received, the attribute value is set to one of the data members of the event.

See Also
IlvEventAccessorData, IlvEvent, IlvEventType.

Constructor & Destructor Documentation

IlvEventAccessor::IlvEventAccessor ( const char *  name,
const IlvValueTypeClass type,
const char *  nodeName,
IlvEventType  eventType,
IlUShort  detail,
IlUShort  modifiers,
IlvEventAccessorData  whichData 
)

Creates an event accessor.

Parameters
nameName of the attribute that handles events.
typeType of the attribute that handles events.
nodeNameName 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.
eventTypeType of the events that must be handled (for example, IlvButtonDown).
detailCode of the events. For example IlvLeftButton, the ASCII code of the character `a', or the key code IlvReturn.
modifiersA mask specifying a combination of modifier keys that must be pressed, for example IlvCtrlModifier|IlvShiftModifier. Only the events with the specified modifiers will be handled. Use IlvAnyModifier to ignore the modifiers of the event.
whichDataSpecifies which data member of the event the accessor value will be set to.
See Also
IlvEventAccessorData, IlvEventType.

Member Function Documentation

virtual IlBoolean IlvEventAccessor::handleEvent ( IlvAccessorHolder object,
IlvGraphic g,
IlvEvent ,
IlvView ,
IlvTransformer t 
)
virtual

Filters the events and performs the value change of the attribute (if appropriate).

Filters the events according to the eventType, detail, and modifiers parameters of the constructor. Then, it calls IlvAccessible::changeValue to set the accessor value to the event data member specified by the whichData parameter.

See Also
IlvAbstractEventAccessor::handleEvent.

Reimplemented from IlvAbstractEventAccessor.


© Copyright 2015, 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.