VTK
Public Member Functions | Protected Attributes | List of all members
vtkQtChartSeriesSelectionHandler Class Reference

The vtkQtChartSeriesSelectionHandler class handles mouse selection for chart series layers. More...

#include <vtkQtChartSeriesSelectionHandler.h>

Inheritance diagram for vtkQtChartSeriesSelectionHandler:
[legend]
Collaboration diagram for vtkQtChartSeriesSelectionHandler:
[legend]

Public Member Functions

 vtkQtChartSeriesSelectionHandler (QObject *parent=0)
 Creates a chart series selection handler. More...
 
virtual ~vtkQtChartSeriesSelectionHandler ()
 
Setup Methods
void setModeNames (const QString &series, const QString &points)
 Sets the mode names for series and point selection. More...
 
void setMousePressModifiers (Qt::KeyboardModifiers series, Qt::KeyboardModifiers points)
 Sets the allowed modifiers for the selection modes. More...
 
vtkQtChartSeriesLayergetLayer () const
 Gets the chart layer associated with the handler. More...
 
void setLayer (vtkQtChartSeriesLayer *layer)
 Sets the chart layer associated with the handler. More...
 
vtkQtChartMouseSelectionHandler Methods
virtual int getNumberOfModes () const
 Gets the number of mouse modes. More...
 
virtual void getModeList (QStringList &list) const
 Gets the list of mouse mode names. More...
 
virtual bool mousePressEvent (const QString &mode, QMouseEvent *e, vtkQtChartArea *chart)
 Handles the mouse press event. More...
 
virtual bool isMouseMoveAvailable (const QString &mode) const
 Gets whether or not mouse move is available for the given mode. More...
 
virtual void startMouseMove (const QString &mode, vtkQtChartArea *chart)
 Starts a mouse move for the given mode. More...
 
virtual void mouseMoveEvent (const QString &mode, QMouseEvent *e, vtkQtChartArea *chart)
 Handles the mouse move event. More...
 
virtual void finishMouseMove (const QString &mode, vtkQtChartArea *chart)
 Finishes a mouse move for the given mode. More...
 
virtual bool mouseReleaseEvent (const QString &mode, QMouseEvent *e, vtkQtChartArea *chart)
 Handles the mouse release event. More...
 
virtual bool mouseDoubleClickEvent (const QString &mode, QMouseEvent *e, vtkQtChartArea *chart)
 Handles the mouse double click event. More...
 
- Public Member Functions inherited from vtkQtChartMouseSelectionHandler
 vtkQtChartMouseSelectionHandler (QObject *parent=0)
 Creates a mouse selection handler. More...
 
virtual ~vtkQtChartMouseSelectionHandler ()
 

Protected Attributes

vtkQtChartSeriesLayerLayer
 Stores the chart layer. More...
 

Detailed Description

The vtkQtChartSeriesSelectionHandler class handles mouse selection for chart series layers.

Definition at line 38 of file vtkQtChartSeriesSelectionHandler.h.

Constructor & Destructor Documentation

vtkQtChartSeriesSelectionHandler::vtkQtChartSeriesSelectionHandler ( QObject *  parent = 0)

Creates a chart series selection handler.

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

Member Function Documentation

void vtkQtChartSeriesSelectionHandler::setModeNames ( const QString &  series,
const QString &  points 
)

Sets the mode names for series and point selection.

Pass in an empty string to prevent that mode type.

Parameters
seriesThe name of the series selection mode.
pointsThe name of the point selection mode.
void vtkQtChartSeriesSelectionHandler::setMousePressModifiers ( Qt::KeyboardModifiers  series,
Qt::KeyboardModifiers  points 
)

Sets the allowed modifiers for the selection modes.

If the shift modifier is allowed, the selection handler will allow the user to select contiguous items. If the control modifier is allowed, the selection handler will allow the user to do xor selection.

Parameters
seriesThe allowed series mode modifiers.
pointsThe allowed point mode modifiers.
vtkQtChartSeriesLayer* vtkQtChartSeriesSelectionHandler::getLayer ( ) const
inline

Gets the chart layer associated with the handler.

Returns
A pointer to the chart layer.

Definition at line 76 of file vtkQtChartSeriesSelectionHandler.h.

void vtkQtChartSeriesSelectionHandler::setLayer ( vtkQtChartSeriesLayer layer)
inline

Sets the chart layer associated with the handler.

Parameters
layerThe chart layer for the handler to use.

Definition at line 81 of file vtkQtChartSeriesSelectionHandler.h.

virtual int vtkQtChartSeriesSelectionHandler::getNumberOfModes ( ) const
virtual

Gets the number of mouse modes.

Returns
The number of mouse modes.

Implements vtkQtChartMouseSelectionHandler.

virtual void vtkQtChartSeriesSelectionHandler::getModeList ( QStringList &  list) const
virtual

Gets the list of mouse mode names.

Parameters
listUsed to return the list of modes.

Implements vtkQtChartMouseSelectionHandler.

virtual bool vtkQtChartSeriesSelectionHandler::mousePressEvent ( const QString &  mode,
QMouseEvent *  e,
vtkQtChartArea chart 
)
virtual

Handles the mouse press event.

Parameters
modeThe current mouse mode.
eThe mouse event.
chartThe chart area.
Returns
True if the event was handled.

Implements vtkQtChartMouseSelectionHandler.

virtual bool vtkQtChartSeriesSelectionHandler::isMouseMoveAvailable ( const QString &  mode) const
virtual

Gets whether or not mouse move is available for the given mode.

Parameters
modeThe mouse mode name.
Returns
True if mouse move is available for the given mode.

Implements vtkQtChartMouseSelectionHandler.

virtual void vtkQtChartSeriesSelectionHandler::startMouseMove ( const QString &  mode,
vtkQtChartArea chart 
)
virtual

Starts a mouse move for the given mode.

Parameters
modeThe mouse mode to start.
chartThe chart area.

Implements vtkQtChartMouseSelectionHandler.

virtual void vtkQtChartSeriesSelectionHandler::mouseMoveEvent ( const QString &  mode,
QMouseEvent *  e,
vtkQtChartArea chart 
)
virtual

Handles the mouse move event.

Parameters
modeThe current mouse mode.
eThe mouse event.
chartThe chart area.

Implements vtkQtChartMouseSelectionHandler.

virtual void vtkQtChartSeriesSelectionHandler::finishMouseMove ( const QString &  mode,
vtkQtChartArea chart 
)
virtual

Finishes a mouse move for the given mode.

Parameters
modeThe mouse mode to finish.
chartThe chart area.

Implements vtkQtChartMouseSelectionHandler.

virtual bool vtkQtChartSeriesSelectionHandler::mouseReleaseEvent ( const QString &  mode,
QMouseEvent *  e,
vtkQtChartArea chart 
)
virtual

Handles the mouse release event.

Parameters
modeThe current mouse mode.
eThe mouse event.
chartThe chart area.
Returns
True if the event was handled.

Implements vtkQtChartMouseSelectionHandler.

virtual bool vtkQtChartSeriesSelectionHandler::mouseDoubleClickEvent ( const QString &  mode,
QMouseEvent *  e,
vtkQtChartArea chart 
)
virtual

Handles the mouse double click event.

Parameters
modeThe current mouse mode.
eThe mouse event.
chartThe chart area.
Returns
True if the event was handled.

Implements vtkQtChartMouseSelectionHandler.

Member Data Documentation

vtkQtChartSeriesLayer* vtkQtChartSeriesSelectionHandler::Layer
protected

Stores the chart layer.

Definition at line 103 of file vtkQtChartSeriesSelectionHandler.h.


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