rwlogo

Rogue Wave Views
Charts 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
IlvChartInteractorDispatcher Class Reference

Handles event dispatching to a set of chart interactors. More...

#include <ilviews/charts/chartint.h>

Inheritance diagram for IlvChartInteractorDispatcher:
IlvChartInteractor IlvInteractor

Public Member Functions

 IlvChartInteractorDispatcher ()
 Constructor. More...
 
virtual void abort (IlvGraphic *chart)
 Aborts event dispatching. More...
 
virtual IlBoolean handleEvent (IlvGraphic *chart, IlvEvent &event, const IlvTransformer *t=0)
 Dispatches the event to the appropriate interactor. More...
 
- Public Member Functions inherited from IlvChartInteractor
virtual void endSequence (IlvChartGraphic *chart, const IlvEvent &event, const IlvTransformer *t)
 Performs the actions needed when an interactor leaves an event sequence. More...
 
IlBoolean isShared () const
 Indicates whether the current object is a shared instance. More...
 
virtual IlBoolean isShowingAbscissaCursor () const
 Indicates whether the interactor uses a cursor on the abscissa. More...
 
virtual IlBoolean isShowingOrdinateCursor () const
 Indicates whether the interactor uses a cursor on the ordinate. More...
 
virtual void startSequence (IlvChartGraphic *chart, const IlvEvent &event, const IlvTransformer *t)
 Performs the actions needed when an interactor enters an event sequence. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvChartInteractor
static IlvChartInteractorGet (const char *name)
 Returns a shared interactor instance. More...
 
- Protected Member Functions inherited from IlvChartInteractor
 IlvChartInteractor ()
 Constructor. More...
 

Detailed Description

Handles event dispatching to a set of chart interactors.

Library: ilvcharts

This class implements the event dispatching mechanism between several chart interactors. Each interactive chart object is associated with an IlvChartInteractorManager instance that stores a list of chart interactors. This model lets you define exactly the set of behaviors you want to associate with a chart graphic representation. The purpose of the dispatcher is to route the events received by the chart to the appropriate interactor. To do this, the event is sent sequentially to each interactor in the manager until one of them successfully handles it. When an interactor successfully handles an IlvButtonDown event, it is considered as the active interactor until an IlvButtonUp event is received by the dispatcher. The active interactor takes priority over all other interactors.

Unlike all other IlvChartInteractor subclasses, instances of this class are not added to an interactor manager. Instead, such interactors are set directly on the chart object with the IlvGraphic::setInteractor(IlvInteractor*) method.

Constructor & Destructor Documentation

IlvChartInteractorDispatcher::IlvChartInteractorDispatcher ( )

Constructor.

Initializes a new IlvChartInteractorDispatcher object.

Member Function Documentation

virtual void IlvChartInteractorDispatcher::abort ( IlvGraphic chart)
virtual

Aborts event dispatching.

This method is called by the IlvChartInteractorDispatcher::handleEvent method when the escape key is pressed. The default implementation calls the abort method of the active interactor if it exists.

Parameters
chartThe chart that currently receives events.
virtual IlBoolean IlvChartInteractorDispatcher::handleEvent ( IlvGraphic chart,
IlvEvent event,
const IlvTransformer t = 0 
)
virtual

Dispatches the event to the appropriate interactor.

Parameters
chartThe chart object that received the event.
eventThe received event.
tThe transformer applied to the view in which the event occurred.
Returns
IlTrue if the event was successfully dispatched and IlFalse otherwise.

Implements IlvChartInteractor.


© 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.