DISPLACE  1.0
A spatial model of fisheries to help sustainable fishing and maritime spatial planning
SingleClickMouseMode Class Reference

The SingleClickMouseMode class implements a mouse mode that completes once a point on the map is clicked, by emitting the modeCompleted(QPointF) signal. The class can be decorated using the MoveVilteringMouseModeDecorator. More...

#include <singleclickmousemode.h>

Inheritance diagram for SingleClickMouseMode:
MouseMode

Signals

void modeCompleted (QPointF)
 

Public Member Functions

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

Protected Attributes

QString mDescription
 

Additional Inherited Members

- Protected Member Functions inherited from MouseMode
void showMessage (QString msg)
 

Detailed Description

The SingleClickMouseMode class implements a mouse mode that completes once a point on the map is clicked, by emitting the modeCompleted(QPointF) signal. The class can be decorated using the MoveVilteringMouseModeDecorator.

Constructor & Destructor Documentation

◆ SingleClickMouseMode()

SingleClickMouseMode::SingleClickMouseMode ( QString  description)
explicit

◆ ~SingleClickMouseMode()

SingleClickMouseMode::~SingleClickMouseMode ( )
virtual

Member Function Documentation

◆ endMode()

bool SingleClickMouseMode::endMode ( bool  success)
virtual

Completes the mouse mode.

Returns
false if the mouse mode must be aborted, true otherwise

Implements MouseMode.

◆ getModeDescription()

QString SingleClickMouseMode::getModeDescription ( ) const
virtual

Implements MouseMode.

◆ modeCompleted

void SingleClickMouseMode::modeCompleted ( QPointF  _t1)
signal

◆ releaseEvent()

bool SingleClickMouseMode::releaseEvent ( const QPointF &  point)
virtual

signals a mouse release event.

Returns
false if the mouse mode must be aborted, true otherwise

Reimplemented from MouseMode.

Member Data Documentation

◆ mDescription

QString SingleClickMouseMode::mDescription
protected

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