VTK
Public Types | Public Member Functions | List of all members
vtkQtChartSeriesSelection Class Reference

The vtkQtChartSeriesSelection class is used for series and point selection. More...

#include <vtkQtChartSeriesSelection.h>

Public Types

enum  SelectionType { NoSelection = 0, SeriesSelection, PointSelection }
 

Public Member Functions

 vtkQtChartSeriesSelection ()
 
 vtkQtChartSeriesSelection (const vtkQtChartSeriesSelection &other)
 
 ~vtkQtChartSeriesSelection ()
 
vtkQtChartSeriesSelectionoperator= (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 vtkQtChartIndexRangeListgetSeries () 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.
 

Detailed Description

The vtkQtChartSeriesSelection class is used for series and point selection.

Definition at line 38 of file vtkQtChartSeriesSelection.h.

Member Enumeration Documentation

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
seriesThe 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
firstThe first series index in the range.
lastThe 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
seriesThe 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
firstThe first series index in the range.
lastThe 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
seriesThe 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
firstThe first series index in the range.
lastThe 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
seriesThe 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
firstThe first series index in the range.
lastThe 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
minimumThe minimum series index.
maximumThe 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
firstThe starting series index.
offsetThe 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
pointsThe 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
seriesThe series index.
indexesThe 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
pointsThe 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
seriesThe series index.
indexesThe 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
pointsThe 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
seriesThe series index.
indexesThe 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
firstThe first series in the range.
lastThe 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
pointsThe 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
seriesThe series index.
indexesThe 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
seriesThe series index.
minimumThe minimum point index.
maximumThe maximum point index.

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