rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Prototypes Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvAbstractEventAccessor Class Reference

Abstract class handling event behaviors, usually mouse or keyboard events. More...

#include <ilviews/protos/eventacc.h>

Inheritance diagram for IlvAbstractEventAccessor:
IlvUserAccessor IlvAccessor IlvEventAccessor IlvRotationAccessor IlvSlideXAccessor IlvSlideYAccessor

List of all members.

Public Member Functions

 IlvAbstractEventAccessor (const char *name, const IlvValueTypeClass *type, const char *nodeName)
 Creates an event accessor.
virtual IlBoolean handleEvent (IlvAccessorHolder *object, IlvGraphic *g, IlvEvent &, IlvView *, IlvTransformer *t)
 Event handling method, to be derived in subclasses.
virtual void initialize (const IlvAccessorHolder *object)
 Attachment method to an IlvAccessorHolder.

Detailed Description

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.


Constructor & Destructor Documentation

IlvAbstractEventAccessor::IlvAbstractEventAccessor ( const char *  name,
const IlvValueTypeClass type,
const char *  nodeName 
)

Creates an event accessor.

Parameters:
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.
See also:
IlvEvent, IlvEventAccessor, IlvRotationAccessor, IlvSlideXAccessor, IlvSlideYAccessor.

Member Function Documentation

virtual IlBoolean IlvAbstractEventAccessor::handleEvent ( IlvAccessorHolder object,
IlvGraphic g,
IlvEvent ,
IlvView ,
IlvTransformer t 
) [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.

Parameters:
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 IlvEventAccessor, IlvRotationAccessor, IlvSlideXAccessor, and IlvSlideYAccessor.

virtual void IlvAbstractEventAccessor::initialize ( const IlvAccessorHolder object  )  [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.

Parameters:
object The object the accessor is attached to.

Reimplemented from IlvUserAccessor.

Reimplemented in IlvRotationAccessor, IlvSlideXAccessor, and IlvSlideYAccessor.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

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