IlvChartHighlightPointInteractor Class Reference

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

#include <ilviews/charts/chartint.h>

Inheritance diagram for IlvChartHighlightPointInteractor:

List of all members.

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 Member Functions
	IlvChartHighlightPointInteractor ()
	Constructor.
virtual IlBoolean	handleEvent (IlvGraphic *chart, IlvEvent &ev, const IlvTransformer *t=0)
	Handles events received by the interactor.
void	setAction (Action action)
	Sets the action to be triggered when a data point is highlighted or unhighlighted.
Protected Member Functions
virtual void	doIt (IlvChartGraphic *chart, IlvAbstractChartDisplayer *disp, IlvChartDataSet *dataSet, IlUInt pointIndex, IlBoolean highlight, IlvEvent &ev)
	Highlights a point.

---

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
	)			[protected, virtual]

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.