IlvChartHighlightPointInteractor Class Reference

Allows information about a data point to be displayed. More...

#include <ilviews/charts/chartint.h>

Inheritance diagram for IlvChartHighlightPointInteractor:

Public Types
typedef void(*	Action )(IlvChartGraphic *chart, IlvAbstractChartDisplayer *disp, IlvChartDataSet *dataSet, IlUInt pointIndex, IlBoolean highlight)
	Defines the type of the action to be triggered when a data point is highlighted or unhighlighted.
Public Types inherited from IlvChartDataInteractor
enum	PickingMode

Public Member Functions
	IlvChartHighlightPointInteractor ()
	Constructor. More...
virtual IlBoolean	handleEvent (IlvGraphic *chart, IlvEvent &ev, const IlvTransformer *t=0)
	Handles events received by the interactor. More...
void	setAction (Action action)
	Sets the action to be triggered when a data point is highlighted or unhighlighted. More...
Public Member Functions inherited from IlvChartDataInteractor
PickingMode	getPickingMode () const
	Returns the current picking mode of the interactor. More...
void	setPickingMode (PickingMode m)
	Sets the current picking mode of 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, IlvAbstractChartDisplayer *disp, IlvChartDataSet *dataSet, IlUInt pointIndex, IlBoolean highlight, IlvEvent &ev)
	Highlights a point. More...
Protected Member Functions inherited from IlvChartDataInteractor
	IlvChartDataInteractor ()
	Constructor. More...
IlvChartDataSet *	getHandledDataSet () const
	Returns the handled data set. More...
IlvAbstractChartDisplayer *	getHandledDisplayer () const
	Returns the chart displayer representing the handled data. More...
IlUInt	getHandledPointIndex () const
	Returns the index of the handled data point. More...
IlBoolean	isHandlingData () const
	Checks whether valid information about a data point has been stored. More...
virtual IlBoolean	queryData (IlvChartGraphic *chart, IlvPoint &evp, const IlvTransformer *t)
	Retrieves and stores information about a data point. More...
Protected Member Functions inherited from IlvChartInteractor
	IlvChartInteractor ()
	Constructor. More...

Additional Inherited Members
Static Public Member Functions inherited from IlvChartDataInteractor
static IlvDim	GetPrecision ()
	Returns the precision used to find the data point corresponding to a given screen point. More...
static void	SetPrecicion (IlvDim dim)
	Deprecated misspelling of SetPrecision()
static void	SetPrecision (IlvDim dim)
	Sets the precision used to find the data point corresponding to a given screen point. More...

Detailed Description

Allows information about a data point to be displayed.

Library: ilvcharts

This class allows the user to trigger an action whenever the mouse moves over a projected point in the data display area.

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

Constructor & Destructor Documentation

IlvChartHighlightPointInteractor::IlvChartHighlightPointInteractor

(

)

Constructor.

Initializes a new IlvChartHighlightPointInteractor object.

Member Function Documentation

virtual void IlvChartHighlightPointInteractor::doIt ( IlvChartGraphic *  chart, IlvAbstractChartDisplayer *  disp, IlvChartDataSet *  dataSet, IlUInt  pointIndex, IlBoolean  highlight, IlvEvent &  ev  )

protectedvirtual

Highlights a point.

This method is called whenever the mouse moves over new projected points. If a previous point was highlighted, this method is also called to remove the highlighting on that point. The default implementation is to call the highlight action method if it exists with the same parameters.

Parameters

chart	The considered chart.
disp	The curve displaying the highlighted point.
dataSet	The data set of the highlighted point.
pointIndex	The index of the highlighted point in the data set.
highlight	A Boolean value indicating whether the point must be highlighted (IlTrue) or not (IlFalse).
ev	An event holding the mouse cursor position.

Reimplemented in IlvChartInfoViewInteractor.

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

Reimplemented in IlvChartInfoViewInteractor.

void IlvChartHighlightPointInteractor::setAction

(

Action

action

)

Sets the action to be triggered when a data point is highlighted or unhighlighted.

Parameters

action

The action to be triggered.