vtkQtChartColorStyleGenerator Class Reference

#include <vtkQtChartColorStyleGenerator.h>

Inheritance diagram for vtkQtChartColorStyleGenerator:

[legend]

Collaboration diagram for vtkQtChartColorStyleGenerator:

[legend]

List of all members.

---

Detailed Description

The vtkQtChartColorStyleGenerator class generates series pens using color and pen style lists.

Definition at line 38 of file vtkQtChartColorStyleGenerator.h.

Public Member Functions
	vtkQtChartColorStyleGenerator (QObject *parent=0)
	Creates a color/style generator.
virtual	~vtkQtChartColorStyleGenerator ()
vtkQtChartStylePen Methods
virtual QPen	getStylePen (int index) const
	Gets the pen for the specified series style index.
Color Methods
vtkQtChartColors *	getColors ()
	Gets the list of colors.
const vtkQtChartColors *	getColors () const
	Gets the list of colors.
void	setColors (vtkQtChartColors *colors)
	Sets the list of colors.
Pen Style Methods
int	getNumberOfStyles () const
	Gets the number of pen styles in the style list.
Qt::PenStyle	getPenStyle (int index) const
	Gets a pen style from the pen styles list.
void	setPenStyle (int index, Qt::PenStyle style)
	Sets the pen style for the given index.
void	clearPenStyles ()
	Clears the list of pen styles.
void	addPenStyle (Qt::PenStyle style)
	Adds a pen style to the list of pen styles.
void	insertPenStyle (int index, Qt::PenStyle style)
	Inserts a new pen style into the list of pen styles.
void	removePenStyle (int index)
	Removes the pen style for the given index.

---

Constructor & Destructor Documentation

vtkQtChartColorStyleGenerator::vtkQtChartColorStyleGenerator

(

QObject *

parent = 0

)

Creates a color/style generator.

Parameters:

parent

The parent object.

virtual vtkQtChartColorStyleGenerator::~vtkQtChartColorStyleGenerator

(

)

[virtual]

---

Member Function Documentation

virtual QPen vtkQtChartColorStyleGenerator::getStylePen

(

int

index

)

const [virtual]

Gets the pen for the specified series style index.

If the index is greater than the internal color list, the index will be wrapped around repeating the colors. The repeated colors will have the next pen style in the list.

Parameters:

index

The series style index.

Returns:

The pen for the specified series style index.

Implements vtkQtChartStylePen.

vtkQtChartColors* vtkQtChartColorStyleGenerator::getColors

(

)

[inline]

Gets the list of colors.

Returns:

A pointer to the list of colors.

Definition at line 71 of file vtkQtChartColorStyleGenerator.h.

const vtkQtChartColors* vtkQtChartColorStyleGenerator::getColors

(

)

const [inline]

Gets the list of colors.

Returns:

A pointer to the list of colors.

Definition at line 77 of file vtkQtChartColorStyleGenerator.h.

void vtkQtChartColorStyleGenerator::setColors

(

vtkQtChartColors *

colors

)

[inline]

Sets the list of colors.

Parameters:

colors

The new list of colors.

Definition at line 82 of file vtkQtChartColorStyleGenerator.h.

int vtkQtChartColorStyleGenerator::getNumberOfStyles

(

)

const

Gets the number of pen styles in the style list.

Returns:

The number of pen styles in the style list.

Qt::PenStyle vtkQtChartColorStyleGenerator::getPenStyle

(

int

index

)

const

Gets a pen style from the pen styles list.

This method provides access to the list of styles. If the index is out of range, a default style will be returned.

Parameters:

index

The list index for the style.

Returns:

The pen style for the given index.

See also:

vtkQtChartStyleGenerator::getSeriesPen(int)

void vtkQtChartColorStyleGenerator::setPenStyle	(	int	index,
		Qt::PenStyle	style
	)

Sets the pen style for the given index.

This method does nothing if the index is out of range.

Parameters:

	index	Which pen style to modify.
	style	The new pen style.

void vtkQtChartColorStyleGenerator::clearPenStyles

(

)

Clears the list of pen styles.

void vtkQtChartColorStyleGenerator::addPenStyle

(

Qt::PenStyle

style

)

Adds a pen style to the list of pen styles.

Parameters:

style

The new pen style to add.

void vtkQtChartColorStyleGenerator::insertPenStyle	(	int	index,
		Qt::PenStyle	style
	)

Inserts a new pen style into the list of pen styles.

Parameters:

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

void vtkQtChartColorStyleGenerator::removePenStyle

(

int

index

)

Removes the pen style for the given index.

Parameters:

index

Which pen style to remove from the list.

---

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

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