VTK
Signals | Public Member Functions | List of all members
vtkQtChartAxisModel Class Reference

The vtkQtChartAxisModel class stores the labels for a chart axis. More...

#include <vtkQtChartAxisModel.h>

Inherits QObject.

Signals

void labelInserted (int index)
 Emitted when a new label is added.
 
void removingLabel (int index)
 Emitted before a label is removed.
 
void labelRemoved (int index)
 Emitted after a label is removed.
 
void labelsReset ()
 Emitted when the axis labels are reset.
 

Public Member Functions

 vtkQtChartAxisModel (QObject *parent=0)
 Creates a chart axis model.
 
virtual ~vtkQtChartAxisModel ()
 
void addLabel (const QVariant &label)
 Adds a label to the chart axis.
 
void insertLabel (int index, const QVariant &label)
 Adds a label to the chart axis.
 
void removeLabel (int index)
 Removes a label from the chart axis.
 
void removeAllLabels ()
 Removes all the labels from the chart axis.
 
void startModifyingData ()
 Blocks the model modification signals.
 
void finishModifyingData ()
 Unblocks the model modification signals.
 
int getNumberOfLabels () const
 Gets the number of labels in the chart axis.
 
void getLabel (int index, QVariant &label) const
 Gets a specified chart axis label.
 
int getLabelIndex (const QVariant &label) const
 Gets the index of the given label.
 

Detailed Description

The vtkQtChartAxisModel class stores the labels for a chart axis.

Definition at line 38 of file vtkQtChartAxisModel.h.

Constructor & Destructor Documentation

vtkQtChartAxisModel::vtkQtChartAxisModel ( QObject *  parent = 0)

Creates a chart axis model.

Parameters
parentThe parent object.
virtual vtkQtChartAxisModel::~vtkQtChartAxisModel ( )
virtual

Member Function Documentation

void vtkQtChartAxisModel::addLabel ( const QVariant &  label)

Adds a label to the chart axis.

Parameters
labelThe label to add.
void vtkQtChartAxisModel::insertLabel ( int  index,
const QVariant &  label 
)

Adds a label to the chart axis.

Parameters
indexWhere to insert the label.
labelThe label to add.
void vtkQtChartAxisModel::removeLabel ( int  index)

Removes a label from the chart axis.

Parameters
indexThe index of the label to remove.
void vtkQtChartAxisModel::removeAllLabels ( )

Removes all the labels from the chart axis.

void vtkQtChartAxisModel::startModifyingData ( )

Blocks the model modification signals.

This method should be called before making multiple changes to the model. It will prevent the view from updating before the changes are complete. Once all the changes are made, the finishModifyingData method should be called to notify the view of the changes.

See Also
vtkQtChartAxisModel::finishModifyingData()
void vtkQtChartAxisModel::finishModifyingData ( )

Unblocks the model modification signals.

The labelsReset signal is emitted to synchronize the view.

See Also
vtkQtChartAxisModel::startModifyingData()
int vtkQtChartAxisModel::getNumberOfLabels ( ) const

Gets the number of labels in the chart axis.

Returns
The number of labels in the chart axis.
void vtkQtChartAxisModel::getLabel ( int  index,
QVariant &  label 
) const

Gets a specified chart axis label.

Parameters
indexWhich chart axis to get.
labelUsed to return the label.
int vtkQtChartAxisModel::getLabelIndex ( const QVariant &  label) const

Gets the index of the given label.

Parameters
labelThe label value to find.
Returns
The index of the label or -1 if not found.
void vtkQtChartAxisModel::labelInserted ( int  index)
signal

Emitted when a new label is added.

Parameters
indexWhere the label was added.
void vtkQtChartAxisModel::removingLabel ( int  index)
signal

Emitted before a label is removed.

Parameters
indexThe index being removed.
void vtkQtChartAxisModel::labelRemoved ( int  index)
signal

Emitted after a label is removed.

Parameters
indexThe index being removed.
void vtkQtChartAxisModel::labelsReset ( )
signal

Emitted when the axis labels are reset.


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