Public Types | Public Member Functions

vtkQtChartSeriesSelection Class Reference

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

#include <vtkQtChartSeriesSelection.h>

List of all members.

Public Types

enum  SelectionType { NoSelection = 0, SeriesSelection, PointSelection }

Public Member Functions

 vtkQtChartSeriesSelection ()
 vtkQtChartSeriesSelection (const vtkQtChartSeriesSelection &other)
 ~vtkQtChartSeriesSelection ()
bool isEmpty () const
 Gets whether or not the selection is empty.
SelectionType getType () const
 Gets the selection type.
bool clear ()
 Clears the selection lists.
vtkQtChartSeriesSelectionoperator= (const vtkQtChartSeriesSelection &other)
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 (const vtkQtChartIndexRange &series)
 Sets the list of selected series ranges.
bool addSeries (const vtkQtChartIndexRangeList &series)
 Adds the list of series ranges to the selection.
bool addSeries (const vtkQtChartIndexRange &series)
 Adds the series index range to the selection.
bool subtractSeries (const vtkQtChartIndexRangeList &series)
 Subtracts the list of series ranges from the selection.
bool subtractSeries (const vtkQtChartIndexRange &series)
 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 (const vtkQtChartIndexRange &series)
 Selects unique series from the given range and the selection.
void limitSeries (int minimum, int maximum)
 Trims the selected series to the given bounds.
Point Selection Methods
const QList
< vtkQtChartSeriesSelectionItem > & 
getPoints () const
 Gets the list of selected point ranges.
bool setPoints (const QList< vtkQtChartSeriesSelectionItem > &points)
 Sets the list of selected point ranges.
bool addPoints (const QList< vtkQtChartSeriesSelectionItem > &points)
 Adds the list of point ranges to the selection.
bool subtractPoints (const QList< vtkQtChartSeriesSelectionItem > &points)
 Subtracts the list of point ranges from the selection.
bool subtractPoints (const vtkQtChartIndexRange &series)
 Subtracts all the selected points in the given series from the selection.
bool xorPoints (const QList< vtkQtChartSeriesSelectionItem > &points)
 Selects unique points from the given list and the selection.
QList< int > getPointSeries () const
 Gets the list of series that have selected points.
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 59 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 62 of file vtkQtChartSeriesSelection.h.


Constructor & Destructor Documentation

vtkQtChartSeriesSelection::vtkQtChartSeriesSelection (  )
vtkQtChartSeriesSelection::vtkQtChartSeriesSelection ( const vtkQtChartSeriesSelection other )
vtkQtChartSeriesSelection::~vtkQtChartSeriesSelection (  ) [inline]

Definition at line 72 of file vtkQtChartSeriesSelection.h.

{}

Member Function Documentation

bool vtkQtChartSeriesSelection::addPoints ( const QList< vtkQtChartSeriesSelectionItem > &  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::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 ( const vtkQtChartIndexRange series )

Adds the series index range to the selection.

Parameters:
seriesThe series index range to add.
Returns:
True if the selection was modified.
bool vtkQtChartSeriesSelection::clear (  )

Clears the selection lists.

const QList<vtkQtChartSeriesSelectionItem>& vtkQtChartSeriesSelection::getPoints (  ) const

Gets the list of selected point ranges.

Returns:
A reference to the list of selected point ranges.
QList<int> vtkQtChartSeriesSelection::getPointSeries (  ) const

Gets the list of series that have selected points.

Returns:
The list of series that have selected points.
const vtkQtChartIndexRangeList& vtkQtChartSeriesSelection::getSeries (  ) const

Gets the list of selected series ranges.

Returns:
A reference to the list of selected series ranges.
SelectionType vtkQtChartSeriesSelection::getType (  ) const

Gets the selection type.

Returns:
The selection type.
bool vtkQtChartSeriesSelection::isEmpty (  ) const

Gets whether or not the selection is empty.

Returns:
True if the selection is empty.
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.
void vtkQtChartSeriesSelection::limitSeries ( int  minimum,
int  maximum 
)

Trims the selected series to the given bounds.

Parameters:
minimumThe minimum series index.
maximumThe maximum series index.
vtkQtChartSeriesSelection& vtkQtChartSeriesSelection::operator= ( const vtkQtChartSeriesSelection other )
bool vtkQtChartSeriesSelection::setPoints ( const QList< vtkQtChartSeriesSelectionItem > &  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::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 ( const vtkQtChartIndexRange series )

Sets the list of selected series ranges.

Parameters:
seriesThe series index range to select.
Returns:
True if the selection was modified.
bool vtkQtChartSeriesSelection::subtractPoints ( const QList< vtkQtChartSeriesSelectionItem > &  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 ( const vtkQtChartIndexRange series )

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

Parameters:
seriesThe list of series ranges to subtract.
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 ( const vtkQtChartIndexRange series )

Subtracts the series index range from the selection.

Parameters:
seriesThe series index range to subtract.
Returns:
True if the selection was modified.
bool vtkQtChartSeriesSelection::xorPoints ( const QList< vtkQtChartSeriesSelectionItem > &  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::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 ( const vtkQtChartIndexRange series )

Selects unique series from the given range and the selection.

Parameters:
seriesThe series index range.
Returns:
True if the selection was modified.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines