Public Member Functions | Protected Attributes | List of all members
te::qt::widgets::AbstractTool Class Reference
Qt » Widgets

This class defines an interface for objects that can receive application events and respond to them, according to specific tool behavior. Tools, in general, receives map display interaction events, like MouseClick, MouseMove, etc. Tools are created to do some GIS operation using the user interactions. More...

#include <AbstractTool.h>

Inheritance diagram for te::qt::widgets::AbstractTool:
QObject ReadPixelTool SelectionTool te::edit::GeometriesUpdateTool te::qt::plugins::mnt::ShowValuesTool te::qt::widgets::CoordTracking te::qt::widgets::Info te::qt::widgets::Measure te::qt::widgets::Pan te::qt::widgets::PanExtent te::qt::widgets::PanMiddleClick te::qt::widgets::PointMove te::qt::widgets::PointPicker te::qt::widgets::PolygonAcquire te::qt::widgets::ReadPixelTool te::qt::widgets::RubberBand te::qt::widgets::Zoom te::qt::widgets::ZoomLeftAndRightClick

Public Member Functions

virtual void setCursor (const QCursor &cursor)
 It sets the tool cursor. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 AbstractTool (MapDisplay *display, QObject *parent=0)
 It constructs a tool associated with the given map display and with the specified cursor. More...
 
virtual ~AbstractTool ()
 Destructor. More...
 
AbstractTool Methods

Methods related with tool behavior.

virtual bool eventFilter (QObject *watched, QEvent *e)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
virtual bool mousePressEvent (QMouseEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive mouse press events for the watched object. More...
 
virtual bool mouseMoveEvent (QMouseEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive mouse move events for the watched object. More...
 
virtual bool mouseReleaseEvent (QMouseEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive mouse release events for the watched object. More...
 
virtual bool mouseDoubleClickEvent (QMouseEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive mouse double click events for the watched object. More...
 
virtual bool keyPressEvent (QKeyEvent *e)
 This event handler can be reimplemented in a concrete tool class to receive key press events for the watched object. More...
 

Protected Attributes

QCursor m_curCursor
 The current mapdisplay cursor. More...
 
QCursor m_cursor
 The default tool cursor. More...
 
MapDisplay * m_display
 The map display associated with the tool. More...
 

Detailed Description

This class defines an interface for objects that can receive application events and respond to them, according to specific tool behavior. Tools, in general, receives map display interaction events, like MouseClick, MouseMove, etc. Tools are created to do some GIS operation using the user interactions.

See also
CoordTracking, Info, Measure, Pan, RubberBand, Selection, Zoom, ZoomArea, ZoomClick, ZoomKeyboard, ZoomWheel

Definition at line 63 of file AbstractTool.h.

Constructor & Destructor Documentation

te::qt::widgets::AbstractTool::AbstractTool ( MapDisplay *  display,
QObject *  parent = 0 
)

It constructs a tool associated with the given map display and with the specified cursor.

Parameters
displayThe map display associated with the tool.
parentThe tool's parent.
Note
The tool will NOT take the ownership of the given pointers.
If the given cursor is different of Qt::BlankCursor, it will be setted on map display.

Definition at line 36 of file AbstractTool.cpp.

References m_display.

te::qt::widgets::AbstractTool::~AbstractTool ( )
virtual

Destructor.

Definition at line 45 of file AbstractTool.cpp.

References m_curCursor, and m_display.

Member Function Documentation

bool te::qt::widgets::AbstractTool::eventFilter ( QObject *  watched,
QEvent *  e 
)
virtual

Filters events if this object has been installed as an event filter for the watched object.

Parameters
watchedThe watched object.
eventThe last event sent to watched object.
Note
In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.
Here, the default implementation looks for QMouseEvents and call the pure virutal methods defined on AbstractTool class, e.g. mousePressEvent().

Reimplemented in te::edit::GeometriesUpdateTool, te::qt::widgets::ZoomKeyboard, and te::qt::widgets::ZoomWheel.

Definition at line 50 of file AbstractTool.cpp.

References keyPressEvent(), m_cursor, m_display, mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

Referenced by te::qt::widgets::ZoomKeyboard::eventFilter(), te::qt::widgets::ZoomWheel::eventFilter(), and te::edit::GeometriesUpdateTool::eventFilter().

bool te::qt::widgets::AbstractTool::keyPressEvent ( QKeyEvent *  e)
virtual

This event handler can be reimplemented in a concrete tool class to receive key press events for the watched object.

Parameters
eThe key event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Reimplemented in te::qt::widgets::Measure.

Definition at line 101 of file AbstractTool.cpp.

Referenced by eventFilter().

bool te::qt::widgets::AbstractTool::mouseDoubleClickEvent ( QMouseEvent *  e)
virtual

This event handler can be reimplemented in a concrete tool class to receive mouse double click events for the watched object.

Parameters
eThe mouse event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.
Note
The AbstractTool will also receive mouse press and mouse release events in addition to the double click event. It is up to the developer to ensure that the application interprets these events correctly.

Reimplemented in te::edit::VertexTool, te::qt::widgets::Measure, te::edit::SplitPolygonTool, te::edit::CreatePolygonTool, te::edit::CreateLineTool, te::edit::CreatePointTool, te::qt::widgets::PolygonAcquire, te::edit::AggregateAreaTool, te::edit::SubtractAreaTool, and te::mnt::ProfileTools.

Definition at line 96 of file AbstractTool.cpp.

Referenced by eventFilter().

bool te::qt::widgets::AbstractTool::mouseMoveEvent ( QMouseEvent *  e)
virtual

This event handler can be reimplemented in a concrete tool class to receive mouse move events for the watched object.

Parameters
eThe mouse event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Reimplemented in te::edit::VertexTool, te::qt::widgets::Measure, te::edit::SplitPolygonTool, te::qt::widgets::Selection, te::edit::CreatePolygonTool, te::edit::DeleteGeometryByAreaTool, te::edit::MoveGeometryTool, te::edit::CreateLineTool, te::qt::widgets::PolygonAcquire, te::edit::RotateGeometryTool, te::qt::widgets::PanExtent, te::qt::widgets::ExtentAcquire, te::qt::widgets::Zoom, te::edit::AggregateAreaTool, te::qt::widgets::PointMove, te::qt::widgets::PointPicker, te::qt::widgets::RubberBand, te::qt::widgets::CoordTracking, te::qt::widgets::Pan, te::qt::widgets::ZoomClick, te::qt::widgets::ZoomArea, te::qt::widgets::PanMiddleClick, te::edit::SubtractAreaTool, te::mnt::ProfileTools, and te::qt::plugins::mnt::ShowValuesTool.

Definition at line 86 of file AbstractTool.cpp.

Referenced by eventFilter().

bool te::qt::widgets::AbstractTool::mousePressEvent ( QMouseEvent *  e)
virtual

This event handler can be reimplemented in a concrete tool class to receive mouse press events for the watched object.

Parameters
eThe mouse event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Reimplemented in te::edit::VertexTool, te::qt::widgets::Measure, te::edit::SplitPolygonTool, te::qt::widgets::Selection, te::edit::CreatePolygonTool, te::edit::DeleteGeometryByAreaTool, te::edit::MoveGeometryTool, te::edit::DeleteGeometryTool, te::edit::DeletePartTool, te::edit::CreateLineTool, te::edit::CreatePointTool, te::qt::widgets::PolygonAcquire, te::edit::RotateGeometryTool, te::qt::widgets::PanExtent, te::qt::widgets::ExtentAcquire, te::qt::widgets::Zoom, te::edit::AggregateAreaTool, te::qt::widgets::PointMove, te::qt::widgets::PointPicker, te::qt::widgets::RubberBand, te::qt::widgets::Pan, te::qt::widgets::ZoomClick, te::qt::widgets::ZoomArea, te::qt::widgets::PanMiddleClick, te::qt::widgets::ZoomLeftAndRightClick, te::edit::SubtractAreaTool, te::edit::EditInfoTool, and te::mnt::ProfileTools.

Definition at line 81 of file AbstractTool.cpp.

Referenced by eventFilter().

bool te::qt::widgets::AbstractTool::mouseReleaseEvent ( QMouseEvent *  e)
virtual

This event handler can be reimplemented in a concrete tool class to receive mouse release events for the watched object.

Parameters
eThe mouse event.
Returns
If you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Reimplemented in te::edit::VertexTool, te::qt::widgets::Measure, te::qt::widgets::Info, te::edit::SplitPolygonTool, te::edit::CreatePolygonTool, te::qt::widgets::Selection, te::edit::DeleteGeometryByAreaTool, te::edit::MoveGeometryTool, te::qt::widgets::PolygonAcquire, te::edit::RotateGeometryTool, te::qt::widgets::PanExtent, te::edit::AggregateAreaTool, te::qt::widgets::ExtentAcquire, te::qt::widgets::Zoom, te::qt::widgets::PointMove, te::qt::widgets::PointPicker, te::qt::widgets::RubberBand, te::qt::widgets::Pan, te::qt::widgets::ZoomClick, te::qt::widgets::ZoomArea, te::qt::widgets::PanMiddleClick, te::edit::SubtractAreaTool, te::mnt::ProfileTools, ReadPixelTool, SelectionTool, and te::qt::widgets::ReadPixelTool.

Definition at line 91 of file AbstractTool.cpp.

Referenced by eventFilter().

void te::qt::widgets::AbstractTool::setCursor ( const QCursor &  cursor)
virtual

It sets the tool cursor.

Parameters
cursorThe cursor that will be used during the tool operation.

Reimplemented in te::edit::GeometriesUpdateTool.

Definition at line 106 of file AbstractTool.cpp.

References m_curCursor, m_cursor, and m_display.

Referenced by te::qt::widgets::ExtentAcquire::ExtentAcquire(), te::qt::widgets::Info::Info(), te::qt::widgets::Measure::Measure(), te::qt::widgets::Pan::Pan(), te::qt::widgets::PanExtent::PanExtent(), te::qt::widgets::PointMove::PointMove(), te::qt::widgets::PointPicker::PointPicker(), te::qt::widgets::PolygonAcquire::PolygonAcquire(), te::qt::widgets::Selection::Selection(), te::qt::widgets::ZoomArea::ZoomArea(), and te::qt::widgets::ZoomClick::ZoomClick().

Member Data Documentation

QCursor te::qt::widgets::AbstractTool::m_curCursor
protected

The current mapdisplay cursor.

Definition at line 173 of file AbstractTool.h.

Referenced by te::edit::GeometriesUpdateTool::setCursor(), setCursor(), and ~AbstractTool().

QCursor te::qt::widgets::AbstractTool::m_cursor
protected

The default tool cursor.

Definition at line 172 of file AbstractTool.h.

Referenced by eventFilter(), te::qt::widgets::Pan::mouseReleaseEvent(), te::edit::GeometriesUpdateTool::setCursor(), and setCursor().

MapDisplay* te::qt::widgets::AbstractTool::m_display
protected

The map display associated with the tool.

Definition at line 171 of file AbstractTool.h.

Referenced by AbstractTool(), te::qt::widgets::Zoom::applyZoom(), te::edit::MergeGeometriesTool::buildEnvelope(), te::edit::EditInfoTool::buildEnvelope(), te::qt::widgets::PointMove::buildEnvelope(), te::edit::SubtractAreaTool::buildEnvelope(), te::edit::RotateGeometryTool::buildEnvelope(), te::edit::DeleteGeometryTool::buildEnvelope(), te::edit::DeletePartTool::buildEnvelope(), te::edit::AggregateAreaTool::buildEnvelope(), te::edit::MoveGeometryTool::buildEnvelope(), te::edit::DeleteGeometryByAreaTool::buildEnvelope(), te::edit::VertexTool::buildEnvelope(), te::edit::CreateLineTool::buildLine(), te::edit::CreatePointTool::buildPoint(), te::edit::SubtractAreaTool::buildPolygon(), te::edit::AggregateAreaTool::buildPolygon(), te::edit::DeleteGeometryByAreaTool::buildPolygon(), te::edit::CreatePolygonTool::buildPolygon(), te::qt::widgets::PolygonAcquire::clear(), te::qt::widgets::Measure::clear(), te::qt::widgets::CoordTracking::CoordTracking(), te::edit::CreateLineTool::CreateLineTool(), te::edit::CreatePolygonTool::CreatePolygonTool(), te::edit::MergeGeometriesTool::draw(), te::edit::EditInfoTool::draw(), te::edit::SubtractAreaTool::draw(), te::qt::widgets::PointMove::draw(), te::edit::AggregateAreaTool::draw(), te::edit::RotateGeometryTool::draw(), te::edit::CreatePointTool::draw(), te::edit::DeleteGeometryByAreaTool::draw(), te::edit::CreateLineTool::draw(), te::edit::CreatePolygonTool::draw(), te::edit::MoveGeometryTool::draw(), te::edit::SplitPolygonTool::draw(), te::edit::VertexTool::draw(), te::qt::widgets::PanExtent::drawCurrentExtent(), SelectionTool::drawGeometries(), te::qt::widgets::PolygonAcquire::drawGeometry(), te::qt::widgets::Measure::drawGeometry(), te::edit::MergeGeometriesTool::editingFinished(), te::edit::SubtractAreaTool::editingFinished(), te::edit::AggregateAreaTool::editingFinished(), te::qt::widgets::ZoomKeyboard::eventFilter(), te::qt::widgets::ZoomWheel::eventFilter(), eventFilter(), te::qt::widgets::Selection::executeSelection(), te::edit::DeleteGeometryByAreaTool::executeSelection(), te::edit::MergeGeometriesTool::getBaseOID(), te::edit::MergeGeometriesTool::getRefEnvelope(), te::qt::widgets::Measure::Measure(), te::edit::SubtractAreaTool::mouseDoubleClickEvent(), te::edit::AggregateAreaTool::mouseDoubleClickEvent(), te::qt::widgets::PolygonAcquire::mouseDoubleClickEvent(), te::edit::CreatePolygonTool::mouseDoubleClickEvent(), te::edit::VertexTool::mouseDoubleClickEvent(), te::qt::plugins::mnt::ShowValuesTool::mouseMoveEvent(), te::qt::widgets::PanMiddleClick::mouseMoveEvent(), te::qt::widgets::ZoomClick::mouseMoveEvent(), te::qt::widgets::Pan::mouseMoveEvent(), te::qt::widgets::CoordTracking::mouseMoveEvent(), te::qt::widgets::PointPicker::mouseMoveEvent(), te::qt::widgets::RubberBand::mouseMoveEvent(), te::qt::widgets::PointMove::mouseMoveEvent(), te::qt::widgets::Zoom::mouseMoveEvent(), te::qt::widgets::PanExtent::mouseMoveEvent(), te::qt::widgets::PolygonAcquire::mouseMoveEvent(), te::edit::CreateLineTool::mouseMoveEvent(), te::edit::DeleteGeometryByAreaTool::mouseMoveEvent(), te::edit::CreatePolygonTool::mouseMoveEvent(), te::edit::MoveGeometryTool::mouseMoveEvent(), te::qt::widgets::Measure::mouseMoveEvent(), te::edit::VertexTool::mouseMoveEvent(), te::edit::EditInfoTool::mousePressEvent(), te::qt::widgets::ZoomLeftAndRightClick::mousePressEvent(), te::qt::widgets::PanMiddleClick::mousePressEvent(), te::qt::widgets::Pan::mousePressEvent(), te::qt::widgets::ZoomClick::mousePressEvent(), te::qt::widgets::PointPicker::mousePressEvent(), te::qt::widgets::PanExtent::mousePressEvent(), te::qt::widgets::PolygonAcquire::mousePressEvent(), te::edit::CreateLineTool::mousePressEvent(), te::edit::CreatePointTool::mousePressEvent(), te::edit::DeleteGeometryTool::mousePressEvent(), te::edit::DeletePartTool::mousePressEvent(), te::edit::DeleteGeometryByAreaTool::mousePressEvent(), te::edit::CreatePolygonTool::mousePressEvent(), te::edit::MoveGeometryTool::mousePressEvent(), te::qt::widgets::Measure::mousePressEvent(), te::qt::widgets::ReadPixelTool::mouseReleaseEvent(), SelectionTool::mouseReleaseEvent(), ReadPixelTool::mouseReleaseEvent(), te::mnt::ProfileTools::mouseReleaseEvent(), te::edit::SubtractAreaTool::mouseReleaseEvent(), te::qt::widgets::PanMiddleClick::mouseReleaseEvent(), te::qt::widgets::ZoomArea::mouseReleaseEvent(), te::qt::widgets::Pan::mouseReleaseEvent(), te::qt::widgets::ZoomClick::mouseReleaseEvent(), te::qt::widgets::RubberBand::mouseReleaseEvent(), te::qt::widgets::PointPicker::mouseReleaseEvent(), te::qt::widgets::PointMove::mouseReleaseEvent(), te::qt::widgets::ExtentAcquire::mouseReleaseEvent(), te::qt::widgets::Zoom::mouseReleaseEvent(), te::edit::AggregateAreaTool::mouseReleaseEvent(), te::edit::CreatePolygonTool::mouseReleaseEvent(), te::qt::widgets::Selection::mouseReleaseEvent(), te::qt::widgets::Info::mouseReleaseEvent(), te::qt::widgets::Measure::onExtentChanged(), te::edit::MergeGeometriesTool::pickFeature(), te::edit::EditInfoTool::pickFeature(), te::edit::SubtractAreaTool::pickFeature(), te::edit::RotateGeometryTool::pickFeature(), te::edit::AggregateAreaTool::pickFeature(), te::edit::MoveGeometryTool::pickFeature(), te::edit::VertexTool::pickFeature(), te::edit::SplitPolygonTool::pickFeatures(), te::qt::widgets::PolygonAcquire::PolygonAcquire(), SelectionTool::SelectionTool(), te::edit::GeometriesUpdateTool::setCursor(), setCursor(), te::edit::SplitPolygonTool::splitPolygon(), te::edit::SubtractAreaTool::storeUndoCommand(), te::edit::AggregateAreaTool::storeUndoCommand(), te::edit::MoveGeometryTool::storeUndoCommand(), te::edit::CreatePolygonTool::storeUndoCommand(), te::edit::VertexTool::storeUndoCommand(), te::qt::widgets::ZoomKeyboard::ZoomKeyboard(), ~AbstractTool(), te::qt::widgets::Info::~Info(), te::qt::widgets::Measure::~Measure(), te::qt::widgets::PolygonAcquire::~PolygonAcquire(), and SelectionTool::~SelectionTool().

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