VTK
Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes
vtkQtChartSeriesLayer Class Reference

The vtkQtChartSeriesLayer class is the base class for chart layers that use the chart series model. More...

#include <vtkQtChartSeriesLayer.h>

Inheritance diagram for vtkQtChartSeriesLayer:
[legend]
Collaboration diagram for vtkQtChartSeriesLayer:
[legend]

List of all members.

Public Types

enum  { Type = vtkQtChart_SeriesLayerType }
- Public Types inherited from vtkQtChartLayer
enum  AxesCorner { BottomLeft = 0, BottomRight, TopLeft, TopRight }
enum  { Type = vtkQtChart_LayerType }

Public Slots

void setXOffset (float offset)
 Sets the contents x-axis offset.
void setYOffset (float offset)
 Sets the contents y-axis offset.

Signals

void modelChanged (vtkQtChartSeriesModel *previous, vtkQtChartSeriesModel *current)
 Emitted when the series model is changed.
void modelSeriesChanged (int first, int last)
 Emitted when the name or icon changes for a set of series.
- Signals inherited from vtkQtChartLayer
void layoutNeeded ()
 Emitted when the layer layout needs to be calculated.
void rangeChanged ()
 Emitted when the axis range for the layer has changed.

Public Member Functions

 vtkQtChartSeriesLayer (bool useContents=true)
virtual ~vtkQtChartSeriesLayer ()
virtual void setChartArea (vtkQtChartArea *area)
 Sets the chart area for the chart layer.
vtkQtChartSeriesModelgetModel () const
 Gets the chart series model.
virtual void setModel (vtkQtChartSeriesModel *model)
 Sets the chart series model.
vtkQtChartSeriesOptionsModelgetOptionsModel () const
 Gets the chart series options model.
virtual void setOptionsModel (vtkQtChartSeriesOptionsModel *model)
 Sets the chart series options model.
vtkQtChartSeriesOptionsgetSeriesOptions (int series) const
 Gets the drawing options for the given series.
int getSeriesOptionsIndex (vtkQtChartSeriesOptions *options) const
 Gets the index for the given series options.
virtual QPixmap getSeriesIcon (int series) const
 Gets the icon for a given series.
vtkQtChartSeriesSelectionModelgetSelectionModel () const
 Gets the chart series selection model.
virtual void getSeriesAt (const QPointF &point, vtkQtChartSeriesSelection &selection) const
 Gets the list of series at a given position.
virtual void getPointsAt (const QPointF &point, vtkQtChartSeriesSelection &selection) const
 Gets the list of points at a given position.
virtual void getSeriesIn (const QRectF &area, vtkQtChartSeriesSelection &selection) const
 Gets the list of series in a given area.
virtual void getPointsIn (const QRectF &area, vtkQtChartSeriesSelection &selection) const
 Gets the list of points in a given area.
- Public Member Functions inherited from vtkQtChartLayer
 vtkQtChartLayer ()
virtual ~vtkQtChartLayer ()
virtual int type () const
vtkQtChartAreagetChartArea () const
 Gets the chart area containing this layer.
virtual void getLayerDomain (vtkQtChartLayerDomain &domain) const
 Gets the chart layer's domain.
virtual void layoutChart (const QRectF &area)=0
 Used to layout the chart layer.
virtual bool drawItemFilter (QGraphicsItem *item, QPainter *painter)
 Used to filter items while drawing.
virtual bool getHelpText (const QPointF &point, QString &text)
 Gets the help text for the given location.
virtual void startInteractiveResize ()
 Notifies the chart layer that a resize interaction has started.
virtual void finishInteractiveResize ()
 Notifies the chart layer that a resize interaction has finished.

Protected Slots

virtual void handleOptionsChanged (vtkQtChartSeriesOptions *, int type, const QVariant &newvalue, const QVariant &oldvalue)
 Called when any of the series options are changed.

Protected Member Functions

virtual void setupOptions (vtkQtChartSeriesOptions *options)
 Sets up the default values for the series options object.
virtual void cleanupOptions (vtkQtChartSeriesOptions *options)
 Cleans up the options by deallocating the style reservation for the option.

Protected Attributes

vtkQtChartSeriesSelectionModelSelection
 Stores the series/point selection.
vtkQtChartSeriesModelModel
 Stores the series model.
vtkQtChartContentsAreaContents
 Used for panning.
vtkQtChartSeriesOptionsModelOptions
 Stores the series options.
- Protected Attributes inherited from vtkQtChartLayer
vtkQtChartAreaChartArea
 Stores the containing chart area.

Detailed Description

The vtkQtChartSeriesLayer class is the base class for chart layers that use the chart series model.

It stores the pointer to the chart series model and the list of options for the series.

Definition at line 48 of file vtkQtChartSeriesLayer.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
Type 

Definition at line 53 of file vtkQtChartSeriesLayer.h.


Constructor & Destructor Documentation

vtkQtChartSeriesLayer::vtkQtChartSeriesLayer ( bool  useContents = true)
virtual vtkQtChartSeriesLayer::~vtkQtChartSeriesLayer ( )
inlinevirtual

Definition at line 57 of file vtkQtChartSeriesLayer.h.


Member Function Documentation

virtual void vtkQtChartSeriesLayer::setChartArea ( vtkQtChartArea area)
virtual

Sets the chart area for the chart layer.

If the model is set before the chart layer is added to a chart area, series options will not be available. Setting the chart area will create the series options for the model in this case. Subclasses can extend this method to handle the new options.

Parameters:
areaThe new chart area.

Reimplemented from vtkQtChartLayer.

Reimplemented in vtkQtLineChart, vtkQtBarChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

vtkQtChartSeriesModel* vtkQtChartSeriesLayer::getModel ( ) const
inline

Gets the chart series model.

Returns:
A pointer to the chart series model.

Definition at line 74 of file vtkQtChartSeriesLayer.h.

virtual void vtkQtChartSeriesLayer::setModel ( vtkQtChartSeriesModel model)
virtual

Sets the chart series model.

Parameters:
modelThe new chart series model.

Reimplemented in vtkQtLineChart, vtkQtBarChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

vtkQtChartSeriesOptionsModel* vtkQtChartSeriesLayer::getOptionsModel ( ) const
inline

Gets the chart series options model.

Returns:
A pointer to the current chart series options model.

Definition at line 85 of file vtkQtChartSeriesLayer.h.

virtual void vtkQtChartSeriesLayer::setOptionsModel ( vtkQtChartSeriesOptionsModel model)
virtual

Sets the chart series options model.

Parameters:
modelThe new chart series options model.
vtkQtChartSeriesOptions* vtkQtChartSeriesLayer::getSeriesOptions ( int  series) const

Gets the drawing options for the given series.

Parameters:
seriesThe index of the series.
Returns:
A pointer to the drawing options for the given series.
int vtkQtChartSeriesLayer::getSeriesOptionsIndex ( vtkQtChartSeriesOptions options) const

Gets the index for the given series options.

Parameters:
optionsThe series options object.
Returns:
The index for the given series options.
virtual QPixmap vtkQtChartSeriesLayer::getSeriesIcon ( int  series) const
virtual

Gets the icon for a given series.

The icon is used by the chart legend.

Parameters:
seriesThe index of the series.
Returns:
A pixmap representation of the series.

Reimplemented in vtkQtLineChart, vtkQtBarChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

vtkQtChartSeriesSelectionModel* vtkQtChartSeriesLayer::getSelectionModel ( ) const

Gets the chart series selection model.

Returns:
A pointer to the chart series selection model.
virtual void vtkQtChartSeriesLayer::getSeriesAt ( const QPointF &  point,
vtkQtChartSeriesSelection selection 
) const
virtual

Gets the list of series at a given position.

Parameters:
pointThe position in scene coordinates.
selectionUsed to return the list of series.

Reimplemented in vtkQtLineChart, vtkQtBarChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::getPointsAt ( const QPointF &  point,
vtkQtChartSeriesSelection selection 
) const
virtual

Gets the list of points at a given position.

Parameters:
pointThe position in scene coordinates.
selectionUsed to return the list of points.

Reimplemented in vtkQtLineChart, vtkQtBarChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::getSeriesIn ( const QRectF &  area,
vtkQtChartSeriesSelection selection 
) const
virtual

Gets the list of series in a given area.

Parameters:
areaThe rectangle in scene coordinates.
selectionUsed to return the list of series.

Reimplemented in vtkQtLineChart, vtkQtBarChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::getPointsIn ( const QRectF &  area,
vtkQtChartSeriesSelection selection 
) const
virtual

Gets the list of points in a given area.

Parameters:
areaThe rectangle in scene coordinates.
selectionUsed to return the list of points.

Reimplemented in vtkQtLineChart, vtkQtBarChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

void vtkQtChartSeriesLayer::setXOffset ( float  offset)
slot

Sets the contents x-axis offset.

Parameters:
offsetThe new x-axis offset.
void vtkQtChartSeriesLayer::setYOffset ( float  offset)
slot

Sets the contents y-axis offset.

Parameters:
offsetThe new y-axis offset.
void vtkQtChartSeriesLayer::modelChanged ( vtkQtChartSeriesModel previous,
vtkQtChartSeriesModel current 
)
signal

Emitted when the series model is changed.

Parameters:
previousThe previous series model.
currentThe current series model.
void vtkQtChartSeriesLayer::modelSeriesChanged ( int  first,
int  last 
)
signal

Emitted when the name or icon changes for a set of series.

Parameters:
firstThe first series index of the range.
lastThe last series index of the range.
virtual void vtkQtChartSeriesLayer::handleOptionsChanged ( vtkQtChartSeriesOptions ,
int  type,
const QVariant &  newvalue,
const QVariant &  oldvalue 
)
protectedvirtualslot

Called when any of the series options are changed.

Default implementation fires the modelSeriesChanged() signal.

Parameters:
optionsThe options that fired the dataChanged() signal.
typeType of the option that was changed.
newValueThe new value for the option.
oldValueThe previous value for the option, if any.

Reimplemented in vtkQtBarChart, vtkQtLineChart, vtkQtStackedChart, and vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::setupOptions ( vtkQtChartSeriesOptions options)
protectedvirtual

Sets up the default values for the series options object.

The style manager should be used to help set up the series options. Subclass must call this method every time a new series options is set up.

Parameters:
optionsThe newly created series options.

Reimplemented in vtkQtStatisticalBoxChart.

virtual void vtkQtChartSeriesLayer::cleanupOptions ( vtkQtChartSeriesOptions options)
protectedvirtual

Cleans up the options by deallocating the style reservation for the option.

Subclass must call this method before a series options object is cleaned up.


Member Data Documentation

vtkQtChartSeriesSelectionModel* vtkQtChartSeriesLayer::Selection
protected

Stores the series/point selection.

Definition at line 205 of file vtkQtChartSeriesLayer.h.

vtkQtChartSeriesModel* vtkQtChartSeriesLayer::Model
protected

Stores the series model.

Definition at line 206 of file vtkQtChartSeriesLayer.h.

vtkQtChartContentsArea* vtkQtChartSeriesLayer::Contents
protected

Used for panning.

Definition at line 207 of file vtkQtChartSeriesLayer.h.

vtkQtChartSeriesOptionsModel* vtkQtChartSeriesLayer::Options
protected

Stores the series options.

Definition at line 208 of file vtkQtChartSeriesLayer.h.


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