vtkQtChartPenBrushGenerator Class Reference

#include <vtkQtChartPenBrushGenerator.h>

Inheritance diagram for vtkQtChartPenBrushGenerator:

[legend]

Collaboration diagram for vtkQtChartPenBrushGenerator:

[legend]

List of all members.

---

Detailed Description

The vtkQtChartPenBrushGenerator class generates series drawing options using pen and brush lists.

Definition at line 38 of file vtkQtChartPenBrushGenerator.h.

Public Member Functions
	vtkQtChartPenBrushGenerator (QObject *parent=0)
	Creates a pen/brush generator.
virtual	~vtkQtChartPenBrushGenerator ()
vtkQtChartStyleGenerator Methods
virtual QBrush	getSeriesBrush (int index) const
	Gets the brush for the specified series index.
virtual QPen	getSeriesPen (int index) const
	Gets the pen for the specified series index.
Brush Methods
int	getNumberOfBrushes () const
	Gets the number of brushes (fill styles) in the list.
QBrush	getBrush (int index) const
	Gets a fill style from the list.
void	setBrush (int index, const QBrush &brush)
	Sets the fill style for the given index.
void	clearBrushes ()
	Clears the list of brushes (fill styles).
void	addBrushes (const vtkQtChartColors &colors)
	Adds the color list to the brush list.
void	addBrush (const QBrush &brush)
	Adds a new brush to the list of fill styles.
void	insertBrush (int index, const QBrush &brush)
	Inserts a new brush into the list of fill styles.
void	removeBrush (int index)
	Removes the brush at the given 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.

---

Constructor & Destructor Documentation

vtkQtChartPenBrushGenerator::vtkQtChartPenBrushGenerator

(

QObject *

parent = 0

)

Creates a pen/brush generator.

Parameters:

parent

The parent object.

virtual vtkQtChartPenBrushGenerator::~vtkQtChartPenBrushGenerator

(

)

[virtual]

---

Member Function Documentation

virtual QBrush vtkQtChartPenBrushGenerator::getSeriesBrush

(

int

index

)

const [virtual]

Gets the brush for the specified series index.

If the index is greater than the internal brush list, the index will be wrapped to repeat the brushes.

Parameters:

index

The series index.

Returns:

The brush for the specified series index.

Implements vtkQtChartStyleGenerator.

virtual QPen vtkQtChartPenBrushGenerator::getSeriesPen

(

int

index

)

const [virtual]

Gets the pen for the specified series index.

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

Parameters:

index

The series index.

Returns:

The pen for the specified series index.

Implements vtkQtChartStyleGenerator.

int vtkQtChartPenBrushGenerator::getNumberOfBrushes

(

)

const

Gets the number of brushes (fill styles) in the list.

Returns:

The number of brushes (fill styles) in the list.

QBrush vtkQtChartPenBrushGenerator::getBrush

(

int

index

)

const

Gets a fill style from the list.

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

Parameters:

index

The index of the brush.

Returns:

The fill style for the given index.

void vtkQtChartPenBrushGenerator::setBrush	(	int	index,
		const QBrush &	brush
	)

Sets the fill style for the given index.

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

Parameters:

	index	The brush list index.
	brush	The new fill style.

void vtkQtChartPenBrushGenerator::clearBrushes

(

)

Clears the list of brushes (fill styles).

void vtkQtChartPenBrushGenerator::addBrushes

(

const vtkQtChartColors &

colors

)

Adds the color list to the brush list.

Parameters:

colors

The list of colors to add.

void vtkQtChartPenBrushGenerator::addBrush

(

const QBrush &

brush

)

Adds a new brush to the list of fill styles.

Parameters:

brush

The fill style to add.

void vtkQtChartPenBrushGenerator::insertBrush	(	int	index,
		const QBrush &	brush
	)

Inserts a new brush into the list of fill styles.

Parameters:

	index	Where to insert the brush.
	brush	The fill style to insert.

void vtkQtChartPenBrushGenerator::removeBrush

(

int

index

)

Removes the brush at the given index.

Parameters:

index

The index of the brush to remove.

int vtkQtChartPenBrushGenerator::getNumberOfPens

(

)

const

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

Returns:

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

QPen vtkQtChartPenBrushGenerator::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:

index

The index of the pen.

Returns:

The stroke style for the given index.

void vtkQtChartPenBrushGenerator::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:

	index	The pen list index.
	pen	The new stroke style.

void vtkQtChartPenBrushGenerator::clearPens

(

)

Clears the list of pens (stroke styles).

void vtkQtChartPenBrushGenerator::addPens

(

const vtkQtChartColors &

colors

)

Adds the color list to the pen list.

Parameters:

colors

The list of colors to add.

void vtkQtChartPenBrushGenerator::addPen

(

const QPen &

pen

)

Adds a pen to the list of stroke styles.

Parameters:

pen

The stroke style to add.

void vtkQtChartPenBrushGenerator::insertPen	(	int	index,
		const QPen &	pen
	)

Inserts a pen into the list of stroke styles.

Parameters:

	index	Where to insert the pen.
	pen	The stroke style to insert.

void vtkQtChartPenBrushGenerator::removePen

(

int

index

)

Removes the pen at the given index.

Parameters:

index

The index of the pen to remove.

---

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

• dox/GUISupport/Qt/Chart/vtkQtChartPenBrushGenerator.h