rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvChartPanInteractor Class Reference

Associates scrolling with mouse movements. More...

#include <ilviews/charts/chartint.h>

Inheritance diagram for IlvChartPanInteractor:
IlvChartInteractor IlvInteractor

List of all members.

Public Member Functions

 IlvChartPanInteractor (IlUShort whichButton=IlvRightButton)
 Constructor.
virtual IlBoolean handleEvent (IlvGraphic *chart, IlvEvent &ev, const IlvTransformer *t=0)
 Handles events received by the interactor.

Protected Member Functions

virtual void doIt (IlvChartGraphic *chart, const IlvPoint &from, const IlvPoint &to)
 Action method to perform the scrolling.

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:
whichButton The mouse button that should be used for the interaction.

Member Function Documentation

virtual void IlvChartPanInteractor::doIt ( IlvChartGraphic chart,
const IlvPoint from,
const IlvPoint to 
) [protected, virtual]

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:
chart The considered chart.
from The point in view coordinates before the mouse motion.
to The 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:
chart The chart object that received the event.
event The received event.
t The transformer applied to the view in which the event occurred.
Returns:
IlTrue if the event was successfully handled and IlFalse otherwise.

Implements IlvChartInteractor.


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