Rogue Wave Views
Charts Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvChartPanInteractor Class Reference

Associates scrolling with mouse movements. More...

#include <ilviews/charts/chartint.h>

Inheritance diagram for IlvChartPanInteractor:
IlvChartInteractor IlvInteractor

Public Member Functions

 IlvChartPanInteractor (IlUShort whichButton=IlvRightButton)
 Constructor. More...
 
virtual IlBoolean handleEvent (IlvGraphic *chart, IlvEvent &ev, const IlvTransformer *t=0)
 Handles events received by the 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...
 

Protected Member Functions

virtual void doIt (IlvChartGraphic *chart, const IlvPoint &from, const IlvPoint &to)
 Action method to perform the scrolling. More...
 
- Protected Member Functions inherited from IlvChartInteractor
 IlvChartInteractor ()
 Constructor. More...
 

Additional Inherited Members

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

Detailed Description

Associates scrolling with mouse movements.

Library: ilvcharts

This class allows the user to scroll through the charts by dragging the mouse in any direction.

The registered name of this interactor class is "ChartPan".

Constructor & Destructor Documentation

IlvChartPanInteractor::IlvChartPanInteractor ( IlUShort  whichButton = IlvRightButton)

Constructor.

Initializes a new IlvChartPanInteractor object.

Parameters
whichButtonThe mouse button that should be used for the interaction.

Member Function Documentation

virtual void IlvChartPanInteractor::doIt ( IlvChartGraphic chart,
const IlvPoint from,
const IlvPoint to 
)
protectedvirtual

Action method to perform the scrolling.

This method is called whenever the mouse is dragged to a new position. The positions before and after the movement are used to compute the corresponding translation.

Parameters
chartThe considered chart.
fromThe point in view coordinates before the mouse motion.
toThe point in view coordinates after the mouse motion.
virtual IlBoolean IlvChartPanInteractor::handleEvent ( IlvGraphic chart,
IlvEvent event,
const IlvTransformer t = 0 
)
virtual

Handles events received by the interactor.

This method is the entry point of all events dispatched to this 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 handled and IlFalse otherwise.

Implements IlvChartInteractor.


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