MouseMode Class Reference

The MouseMode class. More...

#include <mousemode.h>

Inheritance diagram for MouseMode:

Public Member Functions
	MouseMode ()
virtual	~MouseMode ()
virtual bool	pressEvent (const QPointF &point)
	signals a mouse press event. More...
virtual bool	releaseEvent (const QPointF &point)
	signals a mouse release event. More...
virtual bool	moveEvent (const QPointF &point)
	signals a mouse move event. More...
virtual bool	beginMode ()
	Starts the mouse mode. More...
virtual bool	endMode (bool success)=0
	Completes the mouse mode. More...
virtual QString	getModeDescription () const =0
virtual void	setMouseModeInterface (MouseModeInterface *)

Protected Member Functions
void	showMessage (QString msg)

Detailed Description

The MouseMode class.

Note

this class can be decorated (and it is), so follow these simple rules:

• Data members are duplicated by decorators. So getter and setter must be overloaded to allow pass the decorated version of the object
• for this purpose, getter and setter must be declared virtual.

Constructor & Destructor Documentation

MouseMode()

MouseMode::MouseMode

(

)

~MouseMode()

MouseMode::~MouseMode ( )

virtual

Member Function Documentation

beginMode()

bool MouseMode::beginMode ( )

virtual

Starts the mouse mode.

Returns

false if the mouse mode must be aborted, true otherwise

Reimplemented in DrawPenaltyPolygon, MoveFilteringMouseModeDecorator, and EdgeAddMouseMode.

endMode()

virtual bool MouseMode::endMode ( bool  success )

pure virtual

Completes the mouse mode.

Returns

false if the mouse mode must be aborted, true otherwise

Implemented in DrawPenaltyPolygon, MoveFilteringMouseModeDecorator, SingleClickMouseMode, and EdgeAddMouseMode.

getModeDescription()

virtual QString MouseMode::getModeDescription ( ) const

pure virtual

Implemented in DrawPenaltyPolygon, MoveFilteringMouseModeDecorator, SingleClickMouseMode, and EdgeAddMouseMode.

moveEvent()

bool MouseMode::moveEvent ( const QPointF &  point )

virtual

signals a mouse move event.

Returns

false if the mouse mode must be aborted, true otherwise

Reimplemented in DrawPenaltyPolygon, and MoveFilteringMouseModeDecorator.

pressEvent()

bool MouseMode::pressEvent ( const QPointF &  point )

virtual

signals a mouse press event.

Returns

false if the mouse mode must be aborted, true otherwise

Reimplemented in DrawPenaltyPolygon, and MoveFilteringMouseModeDecorator.

releaseEvent()

bool MouseMode::releaseEvent ( const QPointF &  point )

virtual

signals a mouse release event.

Returns

false if the mouse mode must be aborted, true otherwise

Reimplemented in DrawPenaltyPolygon, SingleClickMouseMode, MoveFilteringMouseModeDecorator, and EdgeAddMouseMode.

setMouseModeInterface()

void MouseMode::setMouseModeInterface ( MouseModeInterface *  ifc )

virtual

Reimplemented in MoveFilteringMouseModeDecorator.

showMessage()

void MouseMode::showMessage ( QString  msg )

protected

---

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

• C:/Users/fbas/Documents/GitHub/DISPLACE_GUI/qtgui/mousemode.h
• C:/Users/fbas/Documents/GitHub/DISPLACE_GUI/qtgui/mousemode.cpp