vtkQtChartSeriesSelection Class Reference

#include <vtkQtChartSeriesSelection.h>

Detailed Description

The vtkQtChartSeriesSelection class is used for series and point selection.

Definition at line 38 of file vtkQtChartSeriesSelection.h.


Public Types
enum	SelectionType { NoSelection = 0, SeriesSelection, PointSelection }
Public Member Functions
	vtkQtChartSeriesSelection ()
	vtkQtChartSeriesSelection (const vtkQtChartSeriesSelection &other)
	~vtkQtChartSeriesSelection ()
vtkQtChartSeriesSelection &	operator= (const vtkQtChartSeriesSelection &other)
bool	isEmpty () const
	Gets whether or not the selection is empty.
SelectionType	getType () const
	Gets the selection type.
bool	clear ()
	Clears the selection lists.
Series Selection Methods
const vtkQtChartIndexRangeList &	getSeries () const
	Gets the list of selected series ranges.
bool	setSeries (const vtkQtChartIndexRangeList &series)
	Sets the list of selected series ranges.
bool	setSeries (int first, int last)
	Sets the list of selected series ranges.
bool	addSeries (const vtkQtChartIndexRangeList &series)
	Adds the list of series ranges to the selection.
bool	addSeries (int first, int last)
	Adds the series index range to the selection.
bool	subtractSeries (const vtkQtChartIndexRangeList &series)
	Subtracts the list of series ranges from the selection.
bool	subtractSeries (int first, int last)
	Subtracts the series index range from the selection.
bool	xorSeries (const vtkQtChartIndexRangeList &series)
	Selects unique series from the given list and the selection.
bool	xorSeries (int first, int last)
	Selects unique series from the given range and the selection.
void	limitSeries (int minimum, int maximum)
	Trims the selected series to the given bounds.
bool	offsetSeries (int first, int offset)
	Adds the offset to all the series greater than or equal to the given series.
Point Selection Methods
const QMap< int, vtkQtChartIndexRangeList > &	getPoints () const
	Gets the list of selected point ranges.
bool	setPoints (const QMap< int, vtkQtChartIndexRangeList > &points)
	Sets the list of selected point ranges.
bool	setPoints (int series, const vtkQtChartIndexRangeList &indexes)
	Sets the list of selected point ranges.
bool	addPoints (const QMap< int, vtkQtChartIndexRangeList > &points)
	Adds the list of point ranges to the selection.
bool	addPoints (int series, const vtkQtChartIndexRangeList &indexes)
	Adds the list of point ranges to the selection.
bool	subtractPoints (const QMap< int, vtkQtChartIndexRangeList > &points)
	Subtracts the list of point ranges from the selection.
bool	subtractPoints (int series, const vtkQtChartIndexRangeList &indexes)
	Subtracts the list of point ranges from the selection.
bool	subtractPoints (int first, int last)
	Subtracts all the selected points in the given series from the selection.
bool	xorPoints (const QMap< int, vtkQtChartIndexRangeList > &points)
	Selects unique points from the given list and the selection.
bool	xorPoints (int series, const vtkQtChartIndexRangeList &indexes)
	Selects unique points from the given list and the selection.
void	limitPoints (int series, int minimum, int maximum)
	Trims the selected point indexes for the given series.

Member Enumeration Documentation

enum vtkQtChartSeriesSelection::SelectionType

Enumerator:

NoSelection	No selection is made.
SeriesSelection	The selection contains series indexes.
PointSelection	The selection contains point indexes.

Definition at line 41 of file vtkQtChartSeriesSelection.h.

Constructor & Destructor Documentation

vtkQtChartSeriesSelection::vtkQtChartSeriesSelection ( )

vtkQtChartSeriesSelection::vtkQtChartSeriesSelection ( const vtkQtChartSeriesSelection & other )

vtkQtChartSeriesSelection::~vtkQtChartSeriesSelection ( )

Member Function Documentation

vtkQtChartSeriesSelection& vtkQtChartSeriesSelection::operator= ( const vtkQtChartSeriesSelection & other )

bool vtkQtChartSeriesSelection::isEmpty ( ) const

Gets whether or not the selection is empty.

Returns:: True if the selection is empty.

SelectionType vtkQtChartSeriesSelection::getType ( ) const

Gets the selection type.

Returns:: The selection type.

bool vtkQtChartSeriesSelection::clear ( )

Clears the selection lists.

const vtkQtChartIndexRangeList& vtkQtChartSeriesSelection::getSeries ( ) const

Gets the list of selected series ranges.

Returns:: A reference to the list of selected series ranges.

bool vtkQtChartSeriesSelection::setSeries ( const vtkQtChartIndexRangeList & series )

Sets the list of selected series ranges.

Parameters:

series

The new list of selected series ranges.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::setSeries	(	int	first,
		int	last
	)

Sets the list of selected series ranges.

Parameters:

	first	The first series index in the range.
	last	The last series index in the range.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::addSeries ( const vtkQtChartIndexRangeList & series )

Adds the list of series ranges to the selection.

Parameters:

series

The list of selected series ranges to add.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::addSeries	(	int	first,
		int	last
	)

Adds the series index range to the selection.

Parameters:

	first	The first series index in the range.
	last	The last series index in the range.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::subtractSeries ( const vtkQtChartIndexRangeList & series )

Subtracts the list of series ranges from the selection.

Parameters:

series

The list of selected series ranges to subtract.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::subtractSeries	(	int	first,
		int	last
	)

Subtracts the series index range from the selection.

Parameters:

	first	The first series index in the range.
	last	The last series index in the range.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::xorSeries ( const vtkQtChartIndexRangeList & series )

Selects unique series from the given list and the selection.

Parameters:

series

The list of series ranges.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::xorSeries	(	int	first,
		int	last
	)

Selects unique series from the given range and the selection.

Parameters:

	first	The first series index in the range.
	last	The last series index in the range.

Returns:: True if the selection was modified.

void vtkQtChartSeriesSelection::limitSeries	(	int	minimum,
		int	maximum
	)

Trims the selected series to the given bounds.

Parameters:

	minimum	The minimum series index.
	maximum	The maximum series index.

bool vtkQtChartSeriesSelection::offsetSeries	(	int	first,
		int	offset
	)

Adds the offset to all the series greater than or equal to the given series.

Parameters:

	first	The starting series index.
	offset	The offset to add to the indexes.

Returns:: True if the selection was modified.

const QMap<int, vtkQtChartIndexRangeList>& vtkQtChartSeriesSelection::getPoints ( ) const

Gets the list of selected point ranges.

Returns:: A reference to the list of selected point ranges.

bool vtkQtChartSeriesSelection::setPoints ( const QMap< int, vtkQtChartIndexRangeList > & points )

Sets the list of selected point ranges.

Parameters:

points

The new list of selected point ranges.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::setPoints	(	int	series,
		const vtkQtChartIndexRangeList &	indexes
	)

Sets the list of selected point ranges.

Parameters:

	series	The series index.
	indexes	The list of point ranges.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::addPoints ( const QMap< int, vtkQtChartIndexRangeList > & points )

Adds the list of point ranges to the selection.

Parameters:

points

The list of selected point ranges to add.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::addPoints	(	int	series,
		const vtkQtChartIndexRangeList &	indexes
	)

Adds the list of point ranges to the selection.

Parameters:

	series	The series index.
	indexes	The list of point ranges.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::subtractPoints ( const QMap< int, vtkQtChartIndexRangeList > & points )

Subtracts the list of point ranges from the selection.

Parameters:

points

The list of selected point ranges to subtract.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::subtractPoints	(	int	series,
		const vtkQtChartIndexRangeList &	indexes
	)

Subtracts the list of point ranges from the selection.

Parameters:

	series	The series index.
	indexes	The list of point ranges.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::subtractPoints	(	int	first,
		int	last
	)

Subtracts all the selected points in the given series from the selection.

Parameters:

	first	The first series in the range.
	last	The last series in the range.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::xorPoints ( const QMap< int, vtkQtChartIndexRangeList > & points )

Selects unique points from the given list and the selection.

Parameters:

points

The list of point ranges.

Returns:: True if the selection was modified.

bool vtkQtChartSeriesSelection::xorPoints	(	int	series,
		const vtkQtChartIndexRangeList &	indexes
	)

Selects unique points from the given list and the selection.

Parameters:

	series	The series index.
	indexes	The list of point ranges.

Returns:: True if the selection was modified.

void vtkQtChartSeriesSelection::limitPoints	(	int	series,
		int	minimum,
		int	maximum
	)

Trims the selected point indexes for the given series.

Parameters:

	series	The series index.
	minimum	The minimum point index.
	maximum	The maximum point index.

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

dox/GUISupport/Qt/Chart/vtkQtChartSeriesSelection.h

vtkQtChartSeriesSelection Class Reference

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation