vtkQtBarChartOptions Class Reference

#include <vtkQtBarChartOptions.h>

Collaboration diagram for vtkQtBarChartOptions:

[legend]

List of all members.

---

Detailed Description

The vtkQtBarChartOptions class stores the drawing options for a bar chart.

The default settings are as follows:

• axes: BottomLeft
• bar group fraction: 0.7
• bar width fraction: 0.9
• outline style: Darker
• selection background: LightBlue

Definition at line 47 of file vtkQtBarChartOptions.h.

Public Types
enum	OutlineStyle { Darker = 0, Black }
Signals
void	axesCornerChanged ()
	Emitted when the bar chart axes change.
void	barFractionsChanged ()
	Emitted when bar group or bar width fractions change.
void	outlineStyleChanged ()
	Emitted when the outline style changes.
void	highlightChanged ()
	Emitted when the highlight color changes.
Public Member Functions
	vtkQtBarChartOptions (QObject *parent=0)
	Creates a bar chart options instance.
	vtkQtBarChartOptions (const vtkQtBarChartOptions &other)
	Makes a copy of another bar chart options instance.
virtual	~vtkQtBarChartOptions ()
vtkQtChartLayer::AxesCorner	getAxesCorner () const
	Gets the pair of axes used by the bar chart.
void	setAxesCorner (vtkQtChartLayer::AxesCorner axes)
	Sets the pair of axes used by the bar chart.
float	getBarGroupFraction () const
	Gets the bar group fraction.
void	setBarGroupFraction (float fraction)
	Sets the bar group fraction.
float	getBarWidthFraction () const
	Gets the bar width fraction.
void	setBarWidthFraction (float fraction)
	Sets the bar width fraction.
OutlineStyle	getOutlineStyle () const
	Gets the outline style for the bars.
void	setOutlineStyle (OutlineStyle style)
	Sets the outline style for the bars.
const QColor &	getHighlightColor () const
	Gets the highlight background color.
void	setHighlightColor (const QColor &color)
	Sets the highlight background color.
vtkQtChartHelpFormatter *	getHelpFormat ()
	Gets the chart help text formatter.
const vtkQtChartHelpFormatter *	getHelpFormat () const
	Gets the chart help text formatter.
vtkQtBarChartOptions &	operator= (const vtkQtBarChartOptions &other)
	Makes a copy of another bar chart options instance.
Static Public Attributes
static const QColor	LightBlue
	Defines the default highlight background.

---

Member Enumeration Documentation

enum vtkQtBarChartOptions::OutlineStyle

Enumerator:

Darker	Draws the bar outline in a darker color.
Black	Draws a black bar outline.

Definition at line 52 of file vtkQtBarChartOptions.h.

---

Constructor & Destructor Documentation

vtkQtBarChartOptions::vtkQtBarChartOptions

(

QObject *

parent = 0

)

Creates a bar chart options instance.

Parameters:

parent

The parent object.

vtkQtBarChartOptions::vtkQtBarChartOptions

(

const vtkQtBarChartOptions &

other

)

Makes a copy of another bar chart options instance.

Parameters:

other

The bar chart options to copy.

virtual vtkQtBarChartOptions::~vtkQtBarChartOptions

(

)

[virtual]

---

Member Function Documentation

vtkQtChartLayer::AxesCorner vtkQtBarChartOptions::getAxesCorner

(

)

const [inline]

Gets the pair of axes used by the bar chart.

Returns:

The pair of axes used by the bar chart.

Definition at line 74 of file vtkQtBarChartOptions.h.

void vtkQtBarChartOptions::setAxesCorner

(

vtkQtChartLayer::AxesCorner

axes

)

Sets the pair of axes used by the bar chart.

Parameters:

axes

The new chart axes.

float vtkQtBarChartOptions::getBarGroupFraction

(

)

const [inline]

Gets the bar group fraction.

The bar group fraction is used to set the spacing between the groups of bars. For a bar chart with one series, this also sets the width of the bars.

Returns:

The bar group fraction.

Definition at line 90 of file vtkQtBarChartOptions.h.

void vtkQtBarChartOptions::setBarGroupFraction

(

float

fraction

)

Sets the bar group fraction.

Parameters:

fraction

The new bar group fraction.

float vtkQtBarChartOptions::getBarWidthFraction

(

)

const [inline]

Gets the bar width fraction.

The bar width fraction is used to set the spacing between the bars of different series.

Returns:

The bar width fraction.

Definition at line 105 of file vtkQtBarChartOptions.h.

void vtkQtBarChartOptions::setBarWidthFraction

(

float

fraction

)

Sets the bar width fraction.

Parameters:

fraction

The new bar width fraction.

OutlineStyle vtkQtBarChartOptions::getOutlineStyle

(

)

const [inline]

Gets the outline style for the bars.

Returns:

The current outline style.

Definition at line 116 of file vtkQtBarChartOptions.h.

void vtkQtBarChartOptions::setOutlineStyle

(

OutlineStyle

style

)

Sets the outline style for the bars.

The default style is Darker.

Parameters:

style

The outline style to use.

const QColor& vtkQtBarChartOptions::getHighlightColor

(

)

const [inline]

Gets the highlight background color.

Returns:

The current highlight background color.

Definition at line 130 of file vtkQtBarChartOptions.h.

void vtkQtBarChartOptions::setHighlightColor

(

const QColor &

color

)

Sets the highlight background color.

Parameters:

color

The color for the highlight background.

vtkQtChartHelpFormatter* vtkQtBarChartOptions::getHelpFormat

(

)

[inline]

Gets the chart help text formatter.

The help text formatter stores the format string. It is also used to generate the help text.

Returns:

A pointer to the chart help text formatter.

Definition at line 145 of file vtkQtBarChartOptions.h.

const vtkQtChartHelpFormatter* vtkQtBarChartOptions::getHelpFormat

(

)

const [inline]

Gets the chart help text formatter.

Returns:

A pointer to the chart help text formatter.

Definition at line 151 of file vtkQtBarChartOptions.h.

vtkQtBarChartOptions& vtkQtBarChartOptions::operator=

(

const vtkQtBarChartOptions &

other

)

Makes a copy of another bar chart options instance.

Parameters:

other

The bar chart options to copy.

Returns:

A reference to the object being assigned.

void vtkQtBarChartOptions::axesCornerChanged

(

)

[signal]

Emitted when the bar chart axes change.

void vtkQtBarChartOptions::barFractionsChanged

(

)

[signal]

Emitted when bar group or bar width fractions change.

void vtkQtBarChartOptions::outlineStyleChanged

(

)

[signal]

Emitted when the outline style changes.

void vtkQtBarChartOptions::highlightChanged

(

)

[signal]

Emitted when the highlight color changes.

---

Member Data Documentation

const QColor vtkQtBarChartOptions::LightBlue [static]

Defines the default highlight background.

Definition at line 175 of file vtkQtBarChartOptions.h.

---

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

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