vtkQtChartMouseFunction Class Reference

The vtkQtChartMouseFunction class is the base class for all chart mouse functions. More...

#include <vtkQtChartMouseFunction.h>

Inheritance diagram for vtkQtChartMouseFunction:

List of all members.

Signals
void	interactionStarted (vtkQtChartMouseFunction *function)
	Emitted when a function interaction has started.
void	interactionFinished (vtkQtChartMouseFunction *function)
	Emitted when a function has finished an interaction state.
void	cursorChangeRequested (const QCursor &cursor)
	Emitted when the mouse cursor needs to be changed.
Public Member Functions
	vtkQtChartMouseFunction (QObject *parent=0)
	Creates a chart mouse function instance.
virtual	~vtkQtChartMouseFunction ()
virtual bool	isCombinable () const
	Gets whether or not the function is combinable.
bool	isMouseOwner () const
	Gets whether or not the function owns the mouse.
virtual void	setMouseOwner (bool owns)
	Sets whether or not the function owns the mouse.
virtual bool	mousePressEvent (QMouseEvent *e, vtkQtChartArea *chart)=0
	Called to handle the mouse press event.
virtual bool	mouseMoveEvent (QMouseEvent *e, vtkQtChartArea *chart)=0
	Called to handle the mouse move event.
virtual bool	mouseReleaseEvent (QMouseEvent *e, vtkQtChartArea *chart)=0
	Called to handle the mouse release event.
virtual bool	mouseDoubleClickEvent (QMouseEvent *e, vtkQtChartArea *chart)=0
	Called to handle the double click event.
virtual bool	wheelEvent (QWheelEvent *e, vtkQtChartArea *chart)
	Called to handle the wheel event.

---

Detailed Description

The vtkQtChartMouseFunction class is the base class for all chart mouse functions.

Definition at line 42 of file vtkQtChartMouseFunction.h.

---

Constructor & Destructor Documentation

vtkQtChartMouseFunction::vtkQtChartMouseFunction

(

QObject *

parent = 0 )

Creates a chart mouse function instance.

Parameters:

parent

The parent object.

virtual vtkQtChartMouseFunction::~vtkQtChartMouseFunction

(

)

[inline, virtual]

Definition at line 51 of file vtkQtChartMouseFunction.h.

{}

---

Member Function Documentation

void vtkQtChartMouseFunction::cursorChangeRequested

(

const QCursor &

cursor )

[signal]

Emitted when the mouse cursor needs to be changed.

Parameters:

cursor

The new cursor to use.

void vtkQtChartMouseFunction::interactionFinished

(

vtkQtChartMouseFunction *

function )

[signal]

Emitted when a function has finished an interaction state.

Parameters:

function

The function releasing mouse control.

void vtkQtChartMouseFunction::interactionStarted

(

vtkQtChartMouseFunction *

function )

[signal]

Emitted when a function interaction has started.

A mouse function should not assume it has ownership after emitting this signal. The interactor will call setMouseOwner if no other function owns the mouse.

Parameters:

function

The function requesting mouse ownership.

virtual bool vtkQtChartMouseFunction::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 in vtkQtChartMouseSelection.

Definition at line 63 of file vtkQtChartMouseFunction.h.

{return true;}

bool vtkQtChartMouseFunction::isMouseOwner

(

)

const [inline]

Gets whether or not the function owns the mouse.

Returns:

True if the function owns the mouse.

Definition at line 69 of file vtkQtChartMouseFunction.h.

{return this->OwnsMouse;}

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

Called to handle the double click event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Implemented in vtkQtChartMousePan, vtkQtChartMouseSelection, vtkQtChartMouseZoom, and vtkQtChartMouseZoomBox.

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

Called to handle the mouse move event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Implemented in vtkQtChartMousePan, vtkQtChartMouseSelection, vtkQtChartMouseZoom, and vtkQtChartMouseZoomBox.

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

Called to handle the mouse press event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Implemented in vtkQtChartMousePan, vtkQtChartMouseSelection, vtkQtChartMouseZoom, and vtkQtChartMouseZoomBox.

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

Called to handle the mouse release event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Implemented in vtkQtChartMousePan, vtkQtChartMouseSelection, vtkQtChartMouseZoom, and vtkQtChartMouseZoomBox.

virtual void vtkQtChartMouseFunction::setMouseOwner

(

bool

owns )

[inline, virtual]

Sets whether or not the function owns the mouse.

Parameters:

owns	True if the function owns the mouse.

See also:

Reimplemented in vtkQtChartMousePan, vtkQtChartMouseZoom, and vtkQtChartMouseZoomBox.

Definition at line 76 of file vtkQtChartMouseFunction.h.

{this->OwnsMouse = owns;}

virtual bool vtkQtChartMouseFunction::wheelEvent	(	QWheelEvent *	e,
		vtkQtChartArea *	chart
	)		[virtual]

Called to handle the wheel event.

Parameters:

e	Event specific information.
chart	The chart area.

Returns:

True if the event was used.

Reimplemented in vtkQtChartMouseZoom.

---

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

• vtkQtChartMouseFunction.h