vtkQtChartSeriesOptionsModelCollection Class Reference

#include <vtkQtChartSeriesOptionsModelCollection.h>

Inheritance diagram for vtkQtChartSeriesOptionsModelCollection:

[legend]

Collaboration diagram for vtkQtChartSeriesOptionsModelCollection:

[legend]

List of all members.

---

Detailed Description

The vtkQtChartSeriesOptionsModelCollection class is used to combine chart series options models.

The collection maps the overall series index to the model specific series index. This is analogous to vtkQtChartSeriesModelCollection except that it keeps track of vtkQtChartSeriesOptionsModel instead of vtkQtChartSeriesModel.

Definition at line 36 of file vtkQtChartSeriesOptionsModelCollection.h.

Public Types
typedef vtkQtChartSeriesOptionsModel	Superclass
Public Slots
virtual void	reset ()
	Resets the model.
Public Member Functions
	vtkQtChartSeriesOptionsModelCollection (QObject *parent=0)
	Creates a chart series options model.
virtual	~vtkQtChartSeriesOptionsModelCollection ()
void	addSeriesOptionsModel (vtkQtChartSeriesOptionsModel *model)
	Adds a series model to the collection.
void	removeSeriesOptionsModel (vtkQtChartSeriesOptionsModel *model)
	Removes a series model from the collection.
int	getNumberOfSeriesOptionsModels () const
	Gets the number of series models in the collection.
vtkQtChartSeriesOptionsModel *	getSeriesOptionsModel (int index) const
	Gets the series model at the specified index.
int	mapSeriesIndexToCollectionIndex (vtkQtChartSeriesOptionsModel *model, int index) const
	Maps an index from a series model to an index in the collection.
vtkQtChartSeriesOptionsModel Methods
virtual int	getNumberOfOptions () const
	Gets the number of options.
virtual vtkQtChartSeriesOptions *	getOptions (int series) const
	Gets the options for a particular series.
virtual int	getOptionsIndex (vtkQtChartSeriesOptions *options) const
	Gets the index for the given series options.
Protected Slots
void	onOptionsAboutToBeInserted (int first, int last)
	Called when a series is about to be inserted into a model.
void	onOptionsInserted (int first, int last)
	Called when a series is inserted into a model.
void	onOptionsAboutToBeRemoved (int first, int last)
	Called when a series is about to be removed from a model.
void	onOptionsRemoved (int first, int last)
	Called when a series is removed from a model.

---

Member Typedef Documentation

typedef vtkQtChartSeriesOptionsModel vtkQtChartSeriesOptionsModelCollection::Superclass

Reimplemented from vtkQtChartSeriesOptionsModel.

Definition at line 41 of file vtkQtChartSeriesOptionsModelCollection.h.

---

Constructor & Destructor Documentation

vtkQtChartSeriesOptionsModelCollection::vtkQtChartSeriesOptionsModelCollection

(

QObject *

parent = 0

)

Creates a chart series options model.

Parameters:

param

The parent object.

virtual vtkQtChartSeriesOptionsModelCollection::~vtkQtChartSeriesOptionsModelCollection

(

)

[virtual]

---

Member Function Documentation

virtual int vtkQtChartSeriesOptionsModelCollection::getNumberOfOptions

(

)

const [virtual]

Gets the number of options.

Implements vtkQtChartSeriesOptionsModel.

virtual vtkQtChartSeriesOptions* vtkQtChartSeriesOptionsModelCollection::getOptions

(

int

series

)

const [virtual]

Gets the options for a particular series.

Parameters:

series

The series index

Returns:

The options for the series at the given index.

Implements vtkQtChartSeriesOptionsModel.

virtual int vtkQtChartSeriesOptionsModelCollection::getOptionsIndex

(

vtkQtChartSeriesOptions *

options

)

const [virtual]

Gets the index for the given series options.

Parameters:

options

The series options object.

Returns:

The index for the given series options.

Implements vtkQtChartSeriesOptionsModel.

void vtkQtChartSeriesOptionsModelCollection::addSeriesOptionsModel

(

vtkQtChartSeriesOptionsModel *

model

)

Adds a series model to the collection.

Parameters:

model

The series model to add.

void vtkQtChartSeriesOptionsModelCollection::removeSeriesOptionsModel

(

vtkQtChartSeriesOptionsModel *

model

)

Removes a series model from the collection.

Parameters:

model

The series model to remove.

int vtkQtChartSeriesOptionsModelCollection::getNumberOfSeriesOptionsModels

(

)

const

Gets the number of series models in the collection.

Returns:

The number of series models in the collection.

vtkQtChartSeriesOptionsModel* vtkQtChartSeriesOptionsModelCollection::getSeriesOptionsModel

(

int

index

)

const

Gets the series model at the specified index.

Parameters:

index

The series model index.

Returns:

A pointer to the series model.

int vtkQtChartSeriesOptionsModelCollection::mapSeriesIndexToCollectionIndex	(	vtkQtChartSeriesOptionsModel *	model,
		int	index
	)			const

Maps an index from a series model to an index in the collection.

Parameters:

	model	The series model, must be a member of the model collection
	index	A series index from the given series model

Returns:

A series index in the series model collection. Returns 0 if model is not in collection.

virtual void vtkQtChartSeriesOptionsModelCollection::reset

(

)

[virtual, slot]

Resets the model.

Implements vtkQtChartSeriesOptionsModel.

void vtkQtChartSeriesOptionsModelCollection::onOptionsAboutToBeInserted	(	int	first,
		int	last
	)			[protected, slot]

Called when a series is about to be inserted into a model.

This method uses the signal sender to determine which model has changed. It then maps the model series indexes to collection series indexes and re-emits the signal.

Parameters:

	first	The first model series index.
	last	The last model series index.

void vtkQtChartSeriesOptionsModelCollection::onOptionsInserted	(	int	first,
		int	last
	)			[protected, slot]

Called when a series is inserted into a model.

Parameters:

	first	The first model series index.
	last	The last model series index.

void vtkQtChartSeriesOptionsModelCollection::onOptionsAboutToBeRemoved	(	int	first,
		int	last
	)			[protected, slot]

Called when a series is about to be removed from a model.

Parameters:

	first	The first model series index.
	last	The last model series index.

void vtkQtChartSeriesOptionsModelCollection::onOptionsRemoved	(	int	first,
		int	last
	)			[protected, slot]

Called when a series is removed from a model.

Parameters:

	first	The first model series index.
	last	The last model series index.

---

The documentation for this class was generated from the following file:

• dox/GUISupport/Qt/Chart/vtkQtChartSeriesOptionsModelCollection.h