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

virtual void	init ()

AbstractTool Methods
Methods related with tool behavior.
MapDisplay *	m_display
	The map display associated with the tool. More...

QCursor	m_cursor
	The default tool cursor. More...

QCursor	m_curCursor
	The current mapdisplay cursor. More...

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

virtual void	setCursor (const QCursor &cursor)
	It sets the tool cursor. 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

◆ AbstractTool()

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.

◆ ~AbstractTool()

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

virtual

Destructor.

Member Function Documentation

◆ eventFilter()

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::edit::GeometriesUpdateTool, te::qt::widgets::Measure, te::qt::widgets::ZoomKeyboard, and te::qt::widgets::ZoomWheel.

◆ init()

virtual void te::qt::widgets::AbstractTool::init ( )

virtual

◆ keyPressEvent()

virtual 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

e	The 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::edit::MoveGeometryTool, te::qt::widgets::CoordTracking, and te::qt::widgets::Measure.

◆ mouseDoubleClickEvent()

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

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::AggregateAreaTool, te::edit::CreateLineTool, te::edit::CreatePointTool, te::edit::CreatePolygonTool, te::edit::SplitPolygonTool, te::edit::SubtractAreaTool, te::edit::VertexTool, te::mnt::ProfileTools, te::qt::widgets::Measure, and te::qt::widgets::PolygonAcquire.

◆ mouseMoveEvent()

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

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::AggregateAreaTool, te::edit::CreateLineTool, te::edit::CreatePolygonTool, te::edit::DeleteGeometryByAreaTool, te::edit::MoveGeometryTool, te::edit::RotateGeometryTool, te::edit::SplitPolygonTool, te::edit::SubtractAreaTool, te::edit::VertexTool, te::mnt::ProfileTools, te::qt::plugins::mnt::ShowValuesTool, te::qt::widgets::CoordTracking, te::qt::widgets::ExtentAcquire, 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::RubberBand, te::qt::widgets::Selection, te::qt::widgets::ZoomArea, and te::qt::widgets::ZoomClick.

◆ mousePressEvent()

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

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::AggregateAreaTool, te::edit::CreateLineTool, te::edit::CreatePointTool, te::edit::CreatePolygonTool, te::edit::DeleteGeometryByAreaTool, te::edit::DeleteGeometryTool, te::edit::DeletePartTool, te::edit::EditInfoTool, te::edit::MoveGeometryTool, te::edit::RotateGeometryTool, te::edit::SplitPolygonTool, te::edit::SubtractAreaTool, te::edit::VertexTool, te::mnt::ProfileTools, te::qt::widgets::ExtentAcquire, 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::RubberBand, te::qt::widgets::Selection, te::qt::widgets::ZoomArea, te::qt::widgets::ZoomClick, and te::qt::widgets::ZoomLeftAndRightClick.

◆ mouseReleaseEvent()

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

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::AggregateAreaTool, te::edit::CreatePolygonTool, te::edit::DeleteGeometryByAreaTool, te::edit::MoveGeometryTool, te::edit::RotateGeometryTool, te::edit::SplitPolygonTool, te::edit::SubtractAreaTool, te::edit::VertexTool, te::mnt::ProfileTools, te::qt::widgets::ExtentAcquire, 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::Selection, te::qt::widgets::ZoomArea, and te::qt::widgets::ZoomClick.

◆ setCursor()

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.

Member Data Documentation

◆ m_curCursor

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

protected

The current mapdisplay cursor.

Definition at line 175 of file AbstractTool.h.

◆ m_cursor

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

protected

The default tool cursor.

Definition at line 174 of file AbstractTool.h.

◆ m_display

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

protected

The map display associated with the tool.

Definition at line 173 of file AbstractTool.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/qt/widgets/tools/AbstractTool.h

Public Member Functions

AbstractTool Methods

Detailed Description

Constructor & Destructor Documentation

◆ AbstractTool()

◆ ~AbstractTool()

Member Function Documentation

◆ eventFilter()

◆ init()

◆ keyPressEvent()

◆ mouseDoubleClickEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ setCursor()

Member Data Documentation

◆ m_curCursor

◆ m_cursor

◆ m_display