Views
Charts Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvChartScrollInteractor Class Reference

Enables scrolling with arrow keys. More...

#include <ilviews/charts/chartint.h>

Inheritance diagram for IlvChartScrollInteractor:
IlvChartInteractor IlvInteractor

Public Member Functions

 IlvChartScrollInteractor ()
 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, IlvCoordinateInfo *coordInfo, IlDouble delta)
 Action method to perform the scrolling. More...
 
virtual IlDouble getDeltaCoordinate (const IlvChartGraphic *chart, const IlvCoordinateInfo *coordInfo, IlBoolean positive) const
 Returns the translation to apply to a given coordinate. 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

Enables scrolling with arrow keys.

Library: ilvcharts

This class scrolls the displayed data when the user press the arrow keys.

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

Constructor & Destructor Documentation

◆ IlvChartScrollInteractor()

IlvChartScrollInteractor::IlvChartScrollInteractor ( )

Constructor.

Initializes a new IlvChartScrollInteractor object.

Member Function Documentation

◆ doIt()

virtual void IlvChartScrollInteractor::doIt ( IlvChartGraphic chart,
IlvCoordinateInfo coordInfo,
IlDouble  delta 
)
protectedvirtual

Action method to perform the scrolling.

This method is called whenever an arrow key is pressed to apply the corresponding translation.

Parameters
chartThe considered chart.
coordInfoThe coordinate that must be translated.
deltaThe translation to apply.

◆ getDeltaCoordinate()

virtual IlDouble IlvChartScrollInteractor::getDeltaCoordinate ( const IlvChartGraphic chart,
const IlvCoordinateInfo coordInfo,
IlBoolean  positive 
) const
protectedvirtual

Returns the translation to apply to a given coordinate.

This method is called whenever an arrow key is pressed. It is used to compute the translation to apply to the considered coordinate. (The corresponding coordinate depends on the key that was pressed and on the projector used.) The default implementation returns one tenth of the visible data range.

Parameters
chartThe considered chart.
coordInfoThe coordinate that must be translated.
positiveA Boolean value indicating whether the translation is toward the positive value (IlTrue) or the negative value (IlFalse).
Returns
The computed translation.

◆ handleEvent()

virtual IlBoolean IlvChartScrollInteractor::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.