vtkQtChartBrushGenerator Class Reference

#include <vtkQtChartBrushGenerator.h>

Inheritance diagram for vtkQtChartBrushGenerator:

Inheritance graph
[legend]
Collaboration diagram for vtkQtChartBrushGenerator:

Collaboration graph
[legend]

List of all members.


Detailed Description

The vtkQtChartBrushGenerator class generates series brush options using a list of brushes.

Definition at line 39 of file vtkQtChartBrushGenerator.h.


Public Member Functions

 vtkQtChartBrushGenerator (QObject *parent=0)
 Creates a brush generator.
virtual ~vtkQtChartBrushGenerator ()
vtkQtChartStyleBrush Methods
virtual QBrush getStyleBrush (int index) const
 Gets the brush for the specified series style 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.

Constructor & Destructor Documentation

vtkQtChartBrushGenerator::vtkQtChartBrushGenerator ( QObject *  parent = 0  ) 

Creates a brush generator.

Parameters:
parent The parent object.

virtual vtkQtChartBrushGenerator::~vtkQtChartBrushGenerator (  )  [virtual]


Member Function Documentation

virtual QBrush vtkQtChartBrushGenerator::getStyleBrush ( int  index  )  const [virtual]

Gets the brush for the specified series style index.

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

Parameters:
index The series style index.
Returns:
The brush for the specified series style index.

Implements vtkQtChartStyleBrush.

int vtkQtChartBrushGenerator::getNumberOfBrushes (  )  const

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

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

QBrush vtkQtChartBrushGenerator::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 vtkQtChartBrushGenerator::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 vtkQtChartBrushGenerator::clearBrushes (  ) 

Clears the list of brushes (fill styles).

void vtkQtChartBrushGenerator::addBrushes ( const vtkQtChartColors colors  ) 

Adds the color list to the brush list.

Parameters:
colors The list of colors to add.

void vtkQtChartBrushGenerator::addBrush ( const QBrush &  brush  ) 

Adds a new brush to the list of fill styles.

Parameters:
brush The fill style to add.

void vtkQtChartBrushGenerator::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 vtkQtChartBrushGenerator::removeBrush ( int  index  ) 

Removes the brush at the given index.

Parameters:
index The index of the brush to remove.


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

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