VTK
Public Member Functions | List of all members
vtkQtChartPenGenerator Class Reference

The vtkQtChartPenGenerator class generates series pen options using a list of pens. More...

#include <vtkQtChartPenGenerator.h>

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

Public Member Functions

 vtkQtChartPenGenerator (QObject *parent=0)
 Creates a pen generator.
 
virtual ~vtkQtChartPenGenerator ()
 
vtkQtChartStylePen Methods
virtual QPen getStylePen (int index) const
 Gets the pen for the specified series style index.
 
Pen Methods
int getNumberOfPens () const
 Gets the number of pens (stroke styles) in the list.
 
QPen getPen (int index) const
 Gets a stroke style from the list.
 
void setPen (int index, const QPen &pen)
 Sets the stroke style for the given index.
 
void clearPens ()
 Clears the list of pens (stroke styles).
 
void addPens (const vtkQtChartColors &colors)
 Adds the color list to the pen list.
 
void addPen (const QPen &pen)
 Adds a pen to the list of stroke styles.
 
void insertPen (int index, const QPen &pen)
 Inserts a pen into the list of stroke styles.
 
void removePen (int index)
 Removes the pen at the given index.
 
- Public Member Functions inherited from vtkQtChartStylePen
 vtkQtChartStylePen (QObject *parent=0)
 Creates a chart style pen.
 
virtual ~vtkQtChartStylePen ()
 

Detailed Description

The vtkQtChartPenGenerator class generates series pen options using a list of pens.

Definition at line 39 of file vtkQtChartPenGenerator.h.

Constructor & Destructor Documentation

vtkQtChartPenGenerator::vtkQtChartPenGenerator ( QObject *  parent = 0)

Creates a pen generator.

Parameters
parentThe parent object.
virtual vtkQtChartPenGenerator::~vtkQtChartPenGenerator ( )
virtual

Member Function Documentation

virtual QPen vtkQtChartPenGenerator::getStylePen ( int  index) const
virtual

Gets the pen for the specified series style index.

If the index is greater than the internal pen list, the index will be wrapped to repeat the pens.

Parameters
indexThe series style index.
Returns
The pen for the specified series style index.

Implements vtkQtChartStylePen.

int vtkQtChartPenGenerator::getNumberOfPens ( ) const

Gets the number of pens (stroke styles) in the list.

Returns
The number of pens (stroke styles) in the list.
QPen vtkQtChartPenGenerator::getPen ( int  index) const

Gets a stroke style from the list.

The index must be in the range [0, getNumberOfPens()-1]. If it is not, an error message will be printed and an empty QPen will be returned.

Parameters
indexThe index of the pen.
Returns
The stroke style for the given index.
void vtkQtChartPenGenerator::setPen ( int  index,
const QPen &  pen 
)

Sets the stroke style for the given index.

This method will do nothing if the index is out of range.

Parameters
indexThe pen list index.
penThe new stroke style.
void vtkQtChartPenGenerator::clearPens ( )

Clears the list of pens (stroke styles).

void vtkQtChartPenGenerator::addPens ( const vtkQtChartColors colors)

Adds the color list to the pen list.

Parameters
colorsThe list of colors to add.
void vtkQtChartPenGenerator::addPen ( const QPen &  pen)

Adds a pen to the list of stroke styles.

Parameters
penThe stroke style to add.
void vtkQtChartPenGenerator::insertPen ( int  index,
const QPen &  pen 
)

Inserts a pen into the list of stroke styles.

Parameters
indexWhere to insert the pen.
penThe stroke style to insert.
void vtkQtChartPenGenerator::removePen ( int  index)

Removes the pen at the given index.

Parameters
indexThe index of the pen to remove.

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