vtkQtChartMouseSelection Class Reference

The vtkQtChartMouseSelection class is used to select chart elements based on the current selection mode. More...

#include <vtkQtChartMouseSelection.h>

Inheritance diagram for vtkQtChartMouseSelection:

Collaboration diagram for vtkQtChartMouseSelection:

List of all members.

Public Slots
void	setSelectionMode (const QString &mode)
	Sets the current selection mode.
Signals
void	modeListChanged ()
	Emitted when the list of available modes changes.
void	selectionModeChanged (const QString &mode)
	Emitted when the selection mode changes.
Public Member Functions
	vtkQtChartMouseSelection (QObject *parent=0)
	Creates a mouse selection object.
virtual	~vtkQtChartMouseSelection ()
Configuration Methods
virtual bool	isCombinable () const
	Gets whether or not the function is combinable.
const QString &	getSelectionMode () const
	Gets the name of current selection mode.
const QStringList &	getModeList () const
	Gets the list of selection modes.
void	addHandler (vtkQtChartMouseSelectionHandler *handler)
	Adds a selection handler to the list.
void	insertHandler (int index, vtkQtChartMouseSelectionHandler *handler)
	Inserts a selection handler into the list.
void	removeHandler (vtkQtChartMouseSelectionHandler *handler)
	Removes the given selection handler from the list.
Interaction Methods
virtual bool	mousePressEvent (QMouseEvent *e, vtkQtChartArea *chart)
	Called to handle the mouse press event.
virtual bool	mouseMoveEvent (QMouseEvent *e, vtkQtChartArea *chart)
	Called to handle the mouse move event.
virtual bool	mouseReleaseEvent (QMouseEvent *e, vtkQtChartArea *chart)
	Called to handle the mouse release event.
virtual bool	mouseDoubleClickEvent (QMouseEvent *e, vtkQtChartArea *chart)
	Called to handle the double click event.

---

Detailed Description

The vtkQtChartMouseSelection class is used to select chart elements based on the current selection mode.

Definition at line 43 of file vtkQtChartMouseSelection.h.

---

Constructor & Destructor Documentation

vtkQtChartMouseSelection::vtkQtChartMouseSelection

(

QObject *

parent = 0 )

Creates a mouse selection object.

Parameters:

parent

The parent object.

virtual vtkQtChartMouseSelection::~vtkQtChartMouseSelection

(

)

[virtual]

---

Member Function Documentation

void vtkQtChartMouseSelection::addHandler

(

vtkQtChartMouseSelectionHandler *

handler )

Adds a selection handler to the list.

The selection mode list is rebuilt when a new handler is added.

Parameters:

handler

The new selection handler.

Referenced by QmitkVtkHistogramWidget::QmitkVtkHistogramWidget(), and QmitkVtkLineProfileWidget::QmitkVtkLineProfileWidget().

const QStringList& vtkQtChartMouseSelection::getModeList

(

)

const

Gets the list of selection modes.

Returns:

The list of selection modes.

const QString& vtkQtChartMouseSelection::getSelectionMode

(

)

const

Gets the name of current selection mode.

Returns:

The name of the current selection mode.

void vtkQtChartMouseSelection::insertHandler	(	int	index,
		vtkQtChartMouseSelectionHandler *	handler
	)

Inserts a selection handler into the list.

Parameters:

index	Where to insert the handler.
handler	The new selection handler.

virtual bool vtkQtChartMouseSelection::isCombinable

(

)

const [inline, virtual]

Gets whether or not the function is combinable.

If a function can be combined with other functions on the same mouse button mode, this method should return true. Functions are combined using keyboard modifiers. If a function uses the keyboard modifiers, it should return false.

Returns:

True if the other functions can be combined with this one.

Reimplemented from vtkQtChartMouseFunction.

Definition at line 57 of file vtkQtChartMouseSelection.h.

{return false;}

void vtkQtChartMouseSelection::modeListChanged

(

)

[signal]

Emitted when the list of available modes changes.

virtual bool vtkQtChartMouseSelection::mouseDoubleClickEvent	(	QMouseEvent *	e,
		vtkQtChartArea *	chart
	)		[virtual]

Called to handle the double click event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Implements vtkQtChartMouseFunction.

virtual bool vtkQtChartMouseSelection::mouseMoveEvent	(	QMouseEvent *	e,
		vtkQtChartArea *	chart
	)		[virtual]

Called to handle the mouse move event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Implements vtkQtChartMouseFunction.

virtual bool vtkQtChartMouseSelection::mousePressEvent	(	QMouseEvent *	e,
		vtkQtChartArea *	chart
	)		[virtual]

Called to handle the mouse press event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Implements vtkQtChartMouseFunction.

virtual bool vtkQtChartMouseSelection::mouseReleaseEvent	(	QMouseEvent *	e,
		vtkQtChartArea *	chart
	)		[virtual]

Called to handle the mouse release event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Implements vtkQtChartMouseFunction.

void vtkQtChartMouseSelection::removeHandler

(

vtkQtChartMouseSelectionHandler *

handler )

Removes the given selection handler from the list.

Parameters:

handler

The selection handler to remove.

void vtkQtChartMouseSelection::selectionModeChanged

(

const QString &

mode )

[signal]

Emitted when the selection mode changes.

Parameters:

mode	The name of the new selection mode.

void vtkQtChartMouseSelection::setSelectionMode

(

const QString &

mode )

[slot]

Sets the current selection mode.

Parameters:

mode	The name of the new selection mode.

Referenced by QmitkVtkHistogramWidget::QmitkVtkHistogramWidget(), and QmitkVtkLineProfileWidget::QmitkVtkLineProfileWidget().

---

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

• vtkQtChartMouseSelection.h