rwlogo

Rogue Wave Views
Charts Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
List of all members | Public Member Functions | Protected Member Functions
IlvChartDataListener Class Reference

Abstract base class for chart data object listeners. More...

#include <ilviews/charts/data.h>

Inherited by IlvChartGraphicDataListener.

Public Member Functions

virtual void dataAllPointsRemoved (const IlvAbstractChartData *cData, const IlvChartDataSet *dataSet)
 Performs the necessary updates when all data points are removed. More...
 
virtual void dataPointAdded (const IlvAbstractChartData *cData, const IlvChartDataSet *dataSet, IlUInt position)
 Performs the necessary updates when a data point is added. More...
 
virtual void dataPointChanged (const IlvAbstractChartData *cData, const IlvChartDataSet *dataSet, IlUInt ptidx, IlBoolean beforeChange)
 Performs the necessary updates when a data point is changed. More...
 
virtual void dataPointRemoved (const IlvAbstractChartData *cData, const IlvChartDataSet *dataSet, IlUInt ptidx)
 Performs the necessary updates when a data point is removed. More...
 
virtual void dataSetAdded (const IlvAbstractChartData *cData, IlvChartDataSet *dataSet, IlUInt position)
 Performs the necessary updates when a data set is added. More...
 
virtual void dataSetChanged (const IlvAbstractChartData *cData, IlvChartDataSet *oldSet, IlvChartDataSet *newSet)
 Performs the necessary updates when a data set is changed. More...
 
virtual void dataSetRemoved (const IlvAbstractChartData *cData, IlvChartDataSet *dataSet)
 Performs the necessary updates when a data set is removed. More...
 
virtual void endBatch (const IlvAbstractChartData *cData, const IlvChartDataSet *dataSet)
 Specifies the end of a set of modifications on a data set. More...
 
virtual void startBatch (const IlvAbstractChartData *cData, const IlvChartDataSet *dataSet)
 Specifies the beginning of a set of modifications on a data set. More...
 

Protected Member Functions

 IlvChartDataListener ()
 Constructor. More...
 

Detailed Description

Abstract base class for chart data object listeners.

Library: ilvcharts

This class is the main class used to propagate all modifications made to an IlvAbstractChartData object (or one of its derived objects) to a given object that uses it. Such is the case for all the chart graphics that use it to manage the data sets they display.

This class must be subclassed in order to specify the object to which the modifications must be propagated and to implement the changes that must be applied to the object when the IlvAbstractChartData object (or one of its derived objects) is modified. For this reason, the constructor of this class is defined as protected an instance of the class is never created directly.

See Also
IlvAbstractChartData.

Constructor & Destructor Documentation

IlvChartDataListener::IlvChartDataListener ( )
protected

Constructor.

Initializes a new IlvChartDataListener object.

Member Function Documentation

virtual void IlvChartDataListener::dataAllPointsRemoved ( const IlvAbstractChartData cData,
const IlvChartDataSet dataSet 
)
virtual

Performs the necessary updates when all data points are removed.

Performs the necessary updates to the object that uses an IlvAbstractChartData object (or one of its derived objects) when all data points are removed from the object.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that is modified.
dataSetThe data set of the cData object from which a data point is removed.
Note
This method does nothing at this level of the class hierarchy since the class does not store the object that uses the IlvAbstractChartData object (or one of its derived objects).
virtual void IlvChartDataListener::dataPointAdded ( const IlvAbstractChartData cData,
const IlvChartDataSet dataSet,
IlUInt  position 
)
virtual

Performs the necessary updates when a data point is added.

Performs the necessary updates to an object that uses an IlvAbstractChartData object (or one of its derived objects) when a data point is added to the object.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that is modified.
dataSetThe data set of the cData object in which a data point is added.
positionThe index at which the data point is added to the data set dataSet.
Note
This method does nothing at this level of the class hierarchy since the class does not store the object that uses the IlvAbstractChartData object (or one of its derived objects).
virtual void IlvChartDataListener::dataPointChanged ( const IlvAbstractChartData cData,
const IlvChartDataSet dataSet,
IlUInt  ptidx,
IlBoolean  beforeChange 
)
virtual

Performs the necessary updates when a data point is changed.

Performs the necessary updates to an object that uses an IlvAbstractChartData object (or one of its derived objects) when a data point is changed in the object.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that is modified.
dataSetThe data set of the cData object in which a data point is changed.
ptidxThe index at which the data point is changed in the data set dataSet.
beforeChangeIndicates whether the method is called before the data is changed or after it has been changed.
Note
This method does nothing at that level of the class hierarchy since the considered class does not store the object that uses the IlvAbstractChartData object (or one of its derived objects).
virtual void IlvChartDataListener::dataPointRemoved ( const IlvAbstractChartData cData,
const IlvChartDataSet dataSet,
IlUInt  ptidx 
)
virtual

Performs the necessary updates when a data point is removed.

Performs the necessary updates to the object that uses an IlvAbstractChartData object (or one of its derived objects) when a data point is removed from the object.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that is modified.
dataSetThe data set of the cData object from which a data point is removed.
ptidxThe index of the data point that is removed from the data set dataSet.
Note
This method does nothing at this level of the class hierarchy since the class does not store the object that uses the IlvAbstractChartData object (or one of its derived objects).
virtual void IlvChartDataListener::dataSetAdded ( const IlvAbstractChartData cData,
IlvChartDataSet dataSet,
IlUInt  position 
)
virtual

Performs the necessary updates when a data set is added.

Performs the necessary updates to an object that uses an IlvAbstractChartData object (or one of its derived objects) when a data set is added to the object.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that is modified.
dataSetThe data set that is added to the cData object.
positionThe index at which the data set is added to the cData object.
Note
This method does nothing at this level of the class hierarchy since the class does not store the object that uses the IlvAbstractChartData object (or one of its derived objects).
virtual void IlvChartDataListener::dataSetChanged ( const IlvAbstractChartData cData,
IlvChartDataSet oldSet,
IlvChartDataSet newSet 
)
virtual

Performs the necessary updates when a data set is changed.

Performs the necessary updates to an object that uses an IlvAbstractChartData object (or one of its derived objects) when a data set is changed in the object.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that is modified.
oldSetThe old data set before the change to the cData object.
newSetThe new data set that replaces the old data set oldSet in the cData object.
Note
This method does nothing at this level of the class hierarchy since the class does not store the object that uses the IlvAbstractChartData object (or one of its derived objects).
virtual void IlvChartDataListener::dataSetRemoved ( const IlvAbstractChartData cData,
IlvChartDataSet dataSet 
)
virtual

Performs the necessary updates when a data set is removed.

Performs the necessary updates to an object that uses an IlvAbstractChartData object (or one of its derived objects) when a data set is removed from the object.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that is modified.
dataSetThe data set that is removed from the cData object.
Note
This method does nothing at this level of the class hierarchy since the class does not store the object that uses the IlvAbstractChartData object (or one of its derived objects).
virtual void IlvChartDataListener::endBatch ( const IlvAbstractChartData cData,
const IlvChartDataSet dataSet 
)
virtual

Specifies the end of a set of modifications on a data set.

The notification of the end of the set of modifications is triggered on the data set dataSet when the IlvChartDataSet::endBatch() method is called.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that handles the data set dataSet.
dataSetThe data set of the cData object that is modified.
virtual void IlvChartDataListener::startBatch ( const IlvAbstractChartData cData,
const IlvChartDataSet dataSet 
)
virtual

Specifies the beginning of a set of modifications on a data set.

The notification of the beginning of the set of modifications is triggered on the data set dataSet when the IlvChartDataSet::startBatch() method is called.

Parameters
cDataThe IlvAbstractChartData object (or one of its derived objects) that handles the data set dataSet.
dataSetThe data set of the cData object that is modified.

© Copyright 2015, 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.