te::qt::widgets::PanExtent Class Reference

This class implements a concrete tool to pan a user defined extent. More...

#include <PanExtent.h>

Inheritance diagram for te::qt::widgets::PanExtent:
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.

 PanExtent (MapDisplay *display, const QCursor &cursor, const QCursor &actionCursor=Qt::BlankCursor, QObject *parent=0)
 It constructs a pan tool associated with the given map display and with the specified cursors. More...
 
 ~PanExtent ()
 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 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_actionCursor
 An optional cursor to be used during the pan user action. More...
 
QBrush m_brush
 The brush used to draw the path. More...
 
QCursor m_curCursor
 The current mapdisplay cursor. More...
 
te::gm::Envelope m_currentExtent
 
QCursor m_cursor
 The default tool cursor. More...
 
MapDisplaym_display
 The map display associated with the tool. More...
 
bool m_panStarted
 Flag that indicates if pan operation was started. More...
 
QPen m_pen
 The pen used to draw the path. More...
 

AbstractTool Methods

Methods related with tool behavior.

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...
 
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...
 
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...
 
void setCurrentExtent (const te::gm::Envelope &e)
 
void drawCurrentExtent ()
 
void extentMoved (te::gm::Envelope e)
 

Detailed Description

This class implements a concrete tool to pan a user defined extent.

Definition at line 52 of file PanExtent.h.

Constructor & Destructor Documentation

◆ PanExtent()

te::qt::widgets::PanExtent::PanExtent ( MapDisplay display,
const QCursor &  cursor,
const QCursor &  actionCursor = Qt::BlankCursor,
QObject *  parent = 0 
)

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

Parameters
displayThe map display associated with the tool.
cursorThe default tool cursor.
actionCursorAn optional cursor to be used during the pan user action. If Qt::BlankCursor, it will be NOT modified.
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.

◆ ~PanExtent()

te::qt::widgets::PanExtent::~PanExtent ( )

Destructor.

Member Function Documentation

◆ drawCurrentExtent()

void te::qt::widgets::PanExtent::drawCurrentExtent ( )
protected

◆ eventFilter()

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

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.

◆ extentMoved

void te::qt::widgets::PanExtent::extentMoved ( te::gm::Envelope  e)
signal

◆ keyPressEvent()

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

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.

◆ mouseDoubleClickEvent()

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

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::mnt::ProfileTools, and te::edit::SubtractAreaTool.

◆ mouseMoveEvent()

bool te::qt::widgets::PanExtent::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 from te::qt::widgets::AbstractTool.

◆ mousePressEvent()

bool te::qt::widgets::PanExtent::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 from te::qt::widgets::AbstractTool.

◆ mouseReleaseEvent()

bool te::qt::widgets::PanExtent::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 from te::qt::widgets::AbstractTool.

◆ setCurrentExtent()

void te::qt::widgets::PanExtent::setCurrentExtent ( const te::gm::Envelope e)

◆ setCursor()

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

It sets the tool cursor.

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

Reimplemented in te::edit::GeometriesUpdateTool.

Member Data Documentation

◆ m_actionCursor

QCursor te::qt::widgets::PanExtent::m_actionCursor
protected

An optional cursor to be used during the pan user action.

Definition at line 108 of file PanExtent.h.

◆ m_brush

QBrush te::qt::widgets::PanExtent::m_brush
protected

The brush used to draw the path.

Definition at line 110 of file PanExtent.h.

◆ m_curCursor

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

The current mapdisplay cursor.

Definition at line 173 of file AbstractTool.h.

◆ m_currentExtent

te::gm::Envelope te::qt::widgets::PanExtent::m_currentExtent
protected

Definition at line 112 of file PanExtent.h.

◆ m_cursor

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

The default tool cursor.

Definition at line 172 of file AbstractTool.h.

◆ m_display

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

The map display associated with the tool.

Definition at line 171 of file AbstractTool.h.

◆ m_panStarted

bool te::qt::widgets::PanExtent::m_panStarted
protected

Flag that indicates if pan operation was started.

Definition at line 106 of file PanExtent.h.

◆ m_pen

QPen te::qt::widgets::PanExtent::m_pen
protected

The pen used to draw the path.

Definition at line 109 of file PanExtent.h.


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