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:

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...

Protected Attributes
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 62 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

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.

Definition at line 36 of file AbstractTool.cpp.

References m_display.

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

virtual

Destructor.

Definition at line 44 of file AbstractTool.cpp.

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

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.

Definition at line 50 of file AbstractTool.cpp.

Referenced by te::qt::widgets::ZoomKeyboard::eventFilter(), and te::qt::widgets::ZoomWheel::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

e	The 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::CreateLineTool, te::edit::CreatePolygonTool, te::edit::MoveGeometryTool, and te::qt::widgets::PolygonAcquire.

Definition at line 93 of file AbstractTool.cpp.

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

e	The 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::Selection, te::edit::CreateLineTool, te::edit::CreatePolygonTool, te::edit::MoveGeometryTool, te::qt::widgets::PolygonAcquire, te::qt::widgets::PanExtent, te::qt::widgets::ExtentAcquire, te::qt::widgets::RubberBand, te::qt::widgets::CoordTracking, te::qt::widgets::Pan, and te::qt::widgets::ZoomArea.

Definition at line 83 of file AbstractTool.cpp.

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

e	The 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::Selection, te::edit::CreateLineTool, te::edit::CreatePolygonTool, te::edit::MoveGeometryTool, te::qt::widgets::PolygonAcquire, te::qt::widgets::PanExtent, te::qt::widgets::ExtentAcquire, te::qt::widgets::RubberBand, te::qt::widgets::Pan, te::qt::widgets::ZoomClick, te::qt::widgets::ZoomArea, and te::qt::widgets::ZoomLeftAndRightClick.

Definition at line 78 of file AbstractTool.cpp.

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

e	The 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::qt::widgets::Selection, te::edit::CreateLineTool, te::edit::CreatePolygonTool, te::edit::MoveGeometryTool, te::qt::widgets::PolygonAcquire, te::qt::widgets::PanExtent, te::qt::widgets::ExtentAcquire, te::qt::widgets::RubberBand, te::qt::widgets::Pan, te::qt::widgets::ZoomArea, te::qt::widgets::PointPicker, and te::qt::widgets::ReadPixelTool.

Definition at line 88 of file AbstractTool.cpp.

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.

Definition at line 98 of file AbstractTool.cpp.

Referenced by te::edit::CreateLineTool::CreateLineTool(), te::edit::CreatePolygonTool::CreatePolygonTool(), 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::PointPicker::PointPicker(), 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_cursor

protected

The default tool cursor.

Definition at line 161 of file AbstractTool.h.

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

protected

The map display associated with the tool.

Definition at line 160 of file AbstractTool.h.

Referenced by AbstractTool(), te::qt::widgets::CoordTracking::CoordTracking(), te::edit::CreateLineTool::CreateLineTool(), te::edit::CreatePolygonTool::CreatePolygonTool(), te::qt::widgets::Measure::Measure(), te::edit::MoveGeometryTool::MoveGeometryTool(), te::qt::widgets::PolygonAcquire::PolygonAcquire(), te::edit::VertexTool::VertexTool(), and te::qt::widgets::ZoomKeyboard::ZoomKeyboard().

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

C:/TL5_2015_release/terralib5/src/terralib/qt/widgets/tools/AbstractTool.h
C:/TL5_2015_release/terralib5/src/terralib/qt/widgets/tools/AbstractTool.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation