VTK
Public Slots | Signals | Public Member Functions
vtkQtChartWidget Class Reference

The vtkQtChartWidget class is a container for the chart widgets. More...

#include <vtkQtChartWidget.h>

List of all members.

Public Slots

void printChart (QPrinter &printer)
 Prints the chart using the given printer.
void saveChart (const QStringList &files)
 Saves a screenshot of the chart to the given files.
void saveChart (const QString &filename)
 Saves a screenshot of the chart to the given file.

Signals

void newChartTitle (vtkQtChartTitle *title)
 Emitted when a new chart title has been set.
void newChartLegend (vtkQtChartLegend *legend)
 Emitted when a new chart legend has been set.
void newAxisTitle (vtkQtChartAxis::AxisLocation axis, vtkQtChartTitle *title)
 Emitted when a new axis title has been set.

Public Member Functions

 vtkQtChartWidget (QWidget *parent=0)
 Creates a chart widget instance.
virtual ~vtkQtChartWidget ()
vtkQtChartTitlegetTitle () const
 Gets the overall title for the chart.
void setTitle (vtkQtChartTitle *title)
 Sets the overall title for the chart.
vtkQtChartLegendgetLegend () const
 Gets the chart legend.
void setLegend (vtkQtChartLegend *legend)
 Sets the chart legend.
vtkQtChartAreagetChartArea () const
 Gets the main chart area.
vtkQtChartTitlegetAxisTitle (vtkQtChartAxis::AxisLocation axis) const
 Gets the title for the given axis location.
void setAxisTitle (vtkQtChartAxis::AxisLocation axis, vtkQtChartTitle *title)
 Sets the title for the given axis location.
virtual QSize sizeHint () const
 Gets the preferred size of the chart.

Detailed Description

The vtkQtChartWidget class is a container for the chart widgets.

The main charting widget is the chart area. It holds the chart layers. The title and legend widgets are arranged around the chart area. A title can be added for each axis as well as an overall title for the chart.

The main chart area is created and owned by the chart widget. The other widgets should be created and passed in.

Definition at line 55 of file vtkQtChartWidget.h.


Constructor & Destructor Documentation

vtkQtChartWidget::vtkQtChartWidget ( QWidget *  parent = 0)

Creates a chart widget instance.

Parameters:
parentThe parent widget.
virtual vtkQtChartWidget::~vtkQtChartWidget ( ) [virtual]

Member Function Documentation

vtkQtChartTitle* vtkQtChartWidget::getTitle ( ) const [inline]

Gets the overall title for the chart.

Returns:
A pointer to the overall title for the chart.

Definition at line 70 of file vtkQtChartWidget.h.

void vtkQtChartWidget::setTitle ( vtkQtChartTitle title)

Sets the overall title for the chart.

Parameters:
titleThe new chart title.
vtkQtChartLegend* vtkQtChartWidget::getLegend ( ) const [inline]

Gets the chart legend.

Returns:
A pointer to the chart legend.

Definition at line 81 of file vtkQtChartWidget.h.

void vtkQtChartWidget::setLegend ( vtkQtChartLegend legend)

Sets the chart legend.

Parameters:
legendThe new chart legend.
vtkQtChartArea* vtkQtChartWidget::getChartArea ( ) const [inline]

Gets the main chart area.

Returns:
A pointer to the main chart area.

Definition at line 92 of file vtkQtChartWidget.h.

vtkQtChartTitle* vtkQtChartWidget::getAxisTitle ( vtkQtChartAxis::AxisLocation  axis) const

Gets the title for the given axis location.

Parameters:
axisThe axis location on the chart.
Returns:
A pointer to the axis title.
void vtkQtChartWidget::setAxisTitle ( vtkQtChartAxis::AxisLocation  axis,
vtkQtChartTitle title 
)

Sets the title for the given axis location.

Parameters:
axisThe axis location on the chart.
titleThe new axis title.
virtual QSize vtkQtChartWidget::sizeHint ( ) const [virtual]

Gets the preferred size of the chart.

Returns:
The preferred size of the chart.
void vtkQtChartWidget::printChart ( QPrinter &  printer) [slot]

Prints the chart using the given printer.

Parameters:
printerThe printer to use.
void vtkQtChartWidget::saveChart ( const QStringList &  files) [slot]

Saves a screenshot of the chart to the given files.

Parameters:
filesThe list of files to write.
void vtkQtChartWidget::saveChart ( const QString &  filename) [slot]

Saves a screenshot of the chart to the given file.

Parameters:
filenameThe name of the file to write.
void vtkQtChartWidget::newChartTitle ( vtkQtChartTitle title) [signal]

Emitted when a new chart title has been set.

Parameters:
titleThe new chart title.
void vtkQtChartWidget::newChartLegend ( vtkQtChartLegend legend) [signal]

Emitted when a new chart legend has been set.

Parameters:
legendThe new chart legend.
void vtkQtChartWidget::newAxisTitle ( vtkQtChartAxis::AxisLocation  axis,
vtkQtChartTitle title 
) [signal]

Emitted when a new axis title has been set.

Parameters:
axisThe axis location.
titleThe new axis title.

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