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>
|
virtual void | setCursor (const QCursor &cursor) |
| It sets the tool cursor. More...
|
|
|
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...
|
|
|
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...
|
|
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 62 of file AbstractTool.h.
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
-
display | The map display associated with the tool. |
parent | The 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.
virtual te::qt::widgets::AbstractTool::~AbstractTool |
( |
| ) |
|
|
virtual |
virtual 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
-
watched | The watched object. |
event | The 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::qt::widgets::ZoomKeyboard, and te::qt::widgets::ZoomWheel.
virtual 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
-
- 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.
virtual 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
-
- 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::qt::widgets::PanExtent, te::qt::widgets::ExtentAcquire, te::edit::AggregateAreaTool, te::qt::widgets::RubberBand, te::qt::widgets::CoordTracking, te::qt::widgets::Pan, te::qt::widgets::ZoomArea, te::qt::widgets::PanMiddleClick, te::edit::SubtractAreaTool, te::mnt::ProfileTools, and te::qt::plugins::mnt::ShowValuesTool.
virtual 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
-
- 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::qt::widgets::PanExtent, te::qt::widgets::ExtentAcquire, te::edit::AggregateAreaTool, 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.
virtual 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
-
- 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::qt::widgets::PanExtent, te::edit::AggregateAreaTool, te::qt::widgets::ExtentAcquire, te::qt::widgets::RubberBand, te::qt::widgets::Pan, te::qt::widgets::ZoomArea, te::qt::widgets::PanMiddleClick, te::qt::widgets::PointPicker, te::edit::SubtractAreaTool, te::mnt::ProfileTools, and te::qt::widgets::ReadPixelTool.
virtual void te::qt::widgets::AbstractTool::setCursor |
( |
const QCursor & |
cursor | ) |
|
|
virtual |
It sets the tool cursor.
- Parameters
-
cursor | The cursor that will be used during the tool operation. |
QCursor te::qt::widgets::AbstractTool::m_cursor |
|
protected |
MapDisplay* te::qt::widgets::AbstractTool::m_display |
|
protected |
The map display associated with the tool.
Definition at line 160 of file AbstractTool.h.
The documentation for this class was generated from the following file:
- /home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/qt/widgets/tools/AbstractTool.h