vtkQtChartSeriesSelectionHandler Class Reference

#include <vtkQtChartSeriesSelectionHandler.h>

Inheritance diagram for vtkQtChartSeriesSelectionHandler:

Inheritance graph
[legend]
Collaboration diagram for vtkQtChartSeriesSelectionHandler:

Collaboration graph
[legend]

List of all members.


Detailed Description

The vtkQtChartSeriesSelectionHandler class handles mouse selection for chart series layers.

Definition at line 38 of file vtkQtChartSeriesSelectionHandler.h.


Public Member Functions

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

Protected Attributes

vtkQtChartSeriesLayerLayer
 Stores the chart layer.

Constructor & Destructor Documentation

vtkQtChartSeriesSelectionHandler::vtkQtChartSeriesSelectionHandler ( QObject *  parent = 0  ) 

Creates a chart series selection handler.

Parameters:
parent The 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:
series The name of the series selection mode.
points The 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:
series The allowed series mode modifiers.
points The 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:
layer The 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:
list Used 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:
mode The current mouse mode.
e The mouse event.
chart The 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:
mode The 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:
mode The mouse mode to start.
chart The chart area.

Implements vtkQtChartMouseSelectionHandler.

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

Handles the mouse move event.

Parameters:
mode The current mouse mode.
e The mouse event.
chart The chart area.

Implements vtkQtChartMouseSelectionHandler.

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

Finishes a mouse move for the given mode.

Parameters:
mode The mouse mode to finish.
chart The chart area.

Implements vtkQtChartMouseSelectionHandler.

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

Handles the mouse release event.

Parameters:
mode The current mouse mode.
e The mouse event.
chart The 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:
mode The current mouse mode.
e The mouse event.
chart The chart area.
Returns:
True if the event was handled.

Implements vtkQtChartMouseSelectionHandler.


Member Data Documentation

Stores the chart layer.

Definition at line 103 of file vtkQtChartSeriesSelectionHandler.h.


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

Generated on Wed Aug 24 12:00:04 2011 for VTK by  doxygen 1.5.6