vtkQtChartSeriesOptions Class Reference

#include <vtkQtChartSeriesOptions.h>

List of all members.


Detailed Description

The vtkQtChartSeriesOptions class stores the common series drawing options.

Definition at line 44 of file vtkQtChartSeriesOptions.h.


Public Types

enum  OptionType {
  VISIBLE, PEN, BRUSH, COLORS,
  AXES_CORNER, MARKER_STYLE, MARKER_SIZE, LABEL,
  NUMBER_OF_OPTION_TYPES
}

Signals

void dataChanged (int type, const QVariant &newValue, const QVariant &oldValue)
 Emitted whenever any of the options change.

Public Member Functions

 vtkQtChartSeriesOptions (QObject *parent=0)
 Creates a series options object.
 vtkQtChartSeriesOptions (const vtkQtChartSeriesOptions &other)
virtual ~vtkQtChartSeriesOptions ()
vtkQtChartSeriesOptionsoperator= (const vtkQtChartSeriesOptions &other)
bool isVisible () const
 Gets whether or not the series should be visible.
void setVisible (bool visible)
 Sets whether or not the series should be visible.
QPen getPen () const
 Gets the series pen.
void setPen (const QPen &pen)
 Sets the series pen.
QBrush getBrush () const
 Gets the series brush.
void setBrush (const QBrush &brush)
 Sets the series brush.
vtkQtChartSeriesColorsgetSeriesColors () const
 Gets the series colors object.
void setSeriesColors (vtkQtChartSeriesColors *colors)
 Sets the series colors object.
vtkQtChartLayer::AxesCorner getAxesCorner () const
 Gets the axes corner for the series.
void setAxesCorner (vtkQtChartLayer::AxesCorner axes)
 Sets the axes corner for the series.
vtkQtPointMarker::MarkerStyle getMarkerStyle () const
 Gets the series marker style.
void setMarkerStyle (vtkQtPointMarker::MarkerStyle style)
 Sets the series marker style.
QSizeF getMarkerSize () const
 Gets the marker size for the series.
void setMarkerSize (const QSizeF &size)
 Sets the marker size for the series.
QString getLabel () const
 Gets the label for this series, if any.
void setLabel (const QString &label)
void setGenericOption (OptionType type, const QVariant &value)
 Sets the option using generic API.
QVariant getGenericOption (OptionType type) const
 Gets the option using generic API.
void setDefaultOption (OptionType type, const QVariant &value)
 Set the default value.

Member Enumeration Documentation

Enumerator:
VISIBLE 
PEN 
BRUSH 
COLORS 
AXES_CORNER 
MARKER_STYLE 
MARKER_SIZE 
LABEL 
NUMBER_OF_OPTION_TYPES 

Definition at line 49 of file vtkQtChartSeriesOptions.h.


Constructor & Destructor Documentation

vtkQtChartSeriesOptions::vtkQtChartSeriesOptions ( QObject *  parent = 0  ) 

Creates a series options object.

Parameters:
parent The parent object.

vtkQtChartSeriesOptions::vtkQtChartSeriesOptions ( const vtkQtChartSeriesOptions other  ) 

virtual vtkQtChartSeriesOptions::~vtkQtChartSeriesOptions (  )  [virtual]


Member Function Documentation

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

bool vtkQtChartSeriesOptions::isVisible (  )  const [inline]

Gets whether or not the series should be visible.

Returns:
True if the series should be visible.

Definition at line 76 of file vtkQtChartSeriesOptions.h.

void vtkQtChartSeriesOptions::setVisible ( bool  visible  )  [inline]

Sets whether or not the series should be visible.

Parameters:
visible True if the series should be visible.

Definition at line 82 of file vtkQtChartSeriesOptions.h.

QPen vtkQtChartSeriesOptions::getPen (  )  const [inline]

Gets the series pen.

Returns:
A reference to the series pen.

Definition at line 89 of file vtkQtChartSeriesOptions.h.

void vtkQtChartSeriesOptions::setPen ( const QPen &  pen  )  [inline]

Sets the series pen.

Parameters:
pen The new series pen.

Definition at line 95 of file vtkQtChartSeriesOptions.h.

QBrush vtkQtChartSeriesOptions::getBrush (  )  const [inline]

Gets the series brush.

Returns:
A reference to the series brush.

Definition at line 102 of file vtkQtChartSeriesOptions.h.

void vtkQtChartSeriesOptions::setBrush ( const QBrush &  brush  )  [inline]

Sets the series brush.

Parameters:
brush The new series brush.

Definition at line 108 of file vtkQtChartSeriesOptions.h.

vtkQtChartSeriesColors* vtkQtChartSeriesOptions::getSeriesColors (  )  const

Gets the series colors object.

Returns:
A pointer to the series colors object.

void vtkQtChartSeriesOptions::setSeriesColors ( vtkQtChartSeriesColors colors  ) 

Sets the series colors object.

If the series colors object is not null, the series should be drawn in multiple colors.

Parameters:
colors The new series colors object.

vtkQtChartLayer::AxesCorner vtkQtChartSeriesOptions::getAxesCorner (  )  const [inline]

Gets the axes corner for the series.

Returns:
The axes corner for the series.

Definition at line 130 of file vtkQtChartSeriesOptions.h.

void vtkQtChartSeriesOptions::setAxesCorner ( vtkQtChartLayer::AxesCorner  axes  )  [inline]

Sets the axes corner for the series.

Parameters:
axes The new axes corner for the series.

Definition at line 139 of file vtkQtChartSeriesOptions.h.

vtkQtPointMarker::MarkerStyle vtkQtChartSeriesOptions::getMarkerStyle (  )  const [inline]

Gets the series marker style.

Returns:
The series marker style.

Definition at line 146 of file vtkQtChartSeriesOptions.h.

void vtkQtChartSeriesOptions::setMarkerStyle ( vtkQtPointMarker::MarkerStyle  style  )  [inline]

Sets the series marker style.

Parameters:
style The new series marker style.

Definition at line 156 of file vtkQtChartSeriesOptions.h.

QSizeF vtkQtChartSeriesOptions::getMarkerSize (  )  const [inline]

Gets the marker size for the series.

Returns:
A reference to the series marker size.

Definition at line 165 of file vtkQtChartSeriesOptions.h.

void vtkQtChartSeriesOptions::setMarkerSize ( const QSizeF &  size  )  [inline]

Sets the marker size for the series.

Parameters:
size The new series marker size.

Definition at line 171 of file vtkQtChartSeriesOptions.h.

QString vtkQtChartSeriesOptions::getLabel (  )  const [inline]

Gets the label for this series, if any.

If an empty string is returned, the default, then the name of the series is used as the label.

Definition at line 177 of file vtkQtChartSeriesOptions.h.

void vtkQtChartSeriesOptions::setLabel ( const QString &  label  )  [inline]

Definition at line 180 of file vtkQtChartSeriesOptions.h.

void vtkQtChartSeriesOptions::setGenericOption ( OptionType  type,
const QVariant &  value 
)

Sets the option using generic API.

QVariant vtkQtChartSeriesOptions::getGenericOption ( OptionType  type  )  const

Gets the option using generic API.

void vtkQtChartSeriesOptions::setDefaultOption ( OptionType  type,
const QVariant &  value 
)

Set the default value.

void vtkQtChartSeriesOptions::dataChanged ( int  type,
const QVariant &  newValue,
const QVariant &  oldValue 
) [signal]

Emitted whenever any of the options change.

Parameters:
type Type of the option that was changed.
newValue The new value for the option.
oldValue The previous value for the option, if any.


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

Generated on Mon Sep 27 18:44:40 2010 for VTK by  doxygen 1.5.6