Rogue Wave Views
Charts Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvChartDataSetListener Class Reference

Abstract base class for data set listeners. More...

#include <ilviews/charts/data.h>

Inherited by IlvBubbleDSLst.

Public Member Functions

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

Protected Member Functions

 IlvChartDataSetListener ()
 Initializes a new IlvChartDataSetListener object.
 

Detailed Description

Abstract base class for data set listeners.

Library: ilvcharts
This class is the main class used to propagate all modifications that are made to a data set to a given object that uses the data set. Such is the case for all the instances of subclasses of IlvAbstractChartData that share the data set.

This class must be subclassed in order to specify the object to which the modifications of the data set must be propagated and to implement the changes that must be applied to the object when the data set is modified. For this reason, the constructor of this class is defined as protected since an instance of this class is never created directly.

See also
IlvChartDataSet.

Member Function Documentation

§ dataAllPointsRemoved()

virtual void IlvChartDataSetListener::dataAllPointsRemoved ( const IlvChartDataSet dataSet)
virtual

Performs the necessary updates when all data points are removed.

Performs the required updates for the object that uses a data set when all data points are removed from the data set.

Parameters
dataSetThe data set that is modified.
Note
This method does nothing at this level of the class hierarchy since this class does not store the object that uses the data set.

§ dataPointAdded()

virtual void IlvChartDataSetListener::dataPointAdded ( const IlvChartDataSet dataSet,
IlUInt  ptidx 
)
virtual

Performs the necessary updates when a data point is added.

Performs the updates needed for an object that uses a data set when a data point is added to this data set.

Parameters
dataSetThe data set that is modified.
ptidxThe 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 data set.

§ dataPointChanged()

virtual void IlvChartDataSetListener::dataPointChanged ( const IlvChartDataSet dataSet,
IlUInt  ptidx,
IlBoolean  beforeChange 
)
virtual

Performs the necessary updates when a data point is changed.

Performs the necessary updates for an object that uses a data set when a data point is changed in the data set.

Parameters
dataSetThe data set that is modified.
ptidxThe index at which the data point is changed in the data set dataSet.
beforeChangeIndicates whether the method is called before the data point is changed or after it has been changed.
Note
This method does nothing at this level of the class hierarchy since the class does not store the object that uses the data set.

§ dataPointRemoved()

virtual void IlvChartDataSetListener::dataPointRemoved ( const IlvChartDataSet dataSet,
IlUInt  ptidx 
)
virtual

Performs the necessary updates when a data point is removed.

Performs the required updates for the object that uses a data set when a data point is removed from the data set.

Parameters
dataSetThe data set that is modified.
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 this class does not store the object that uses the data set.

§ endBatch()

virtual void IlvChartDataSetListener::endBatch ( const IlvChartDataSet dataSet)
virtual

Specifies the end of a set of modifications.

The notification is triggered when IlvChartDataSet::endBatch() is called. This method allows the listener to batch the update operations.

Parameters
dataSetThe data set that is modified.
Note
The default implementation does nothing.

§ startBatch()

virtual void IlvChartDataSetListener::startBatch ( const IlvChartDataSet dataSet)
virtual

Specifies the beginning of a set of modifications.

The notification is triggered when IlvChartDataSet::startBatch() is called. This method allows the listener to batch the update operations.

Parameters
dataSetThe data set that is modified.
Note
The default implementation does nothing.

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