All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
te::layout::AbstractViewTool Class Reference

#include <AbstractViewTool.h>

Inheritance diagram for te::layout::AbstractViewTool:
te::layout::ViewRubberBand te::layout::ViewZoom te::layout::ViewZoomArea te::layout::ViewZoomClick

Public Member Functions

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

Methods related to instantiation and destruction.

 AbstractViewTool (View *view, QObject *parent=0)
 It constructs a tool associated with the given map display and with the specified cursor. More...
 
virtual ~AbstractViewTool ()
 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...
 
View * m_view
 The QGraphicsView associated with the tool. More...
 

Detailed Description

Definition at line 42 of file AbstractViewTool.h.

Constructor & Destructor Documentation

te::layout::AbstractViewTool::AbstractViewTool ( View *  view,
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 30 of file AbstractViewTool.cpp.

References m_view.

te::layout::AbstractViewTool::~AbstractViewTool ( )
virtual

Destructor.

Definition at line 38 of file AbstractViewTool.cpp.

Member Function Documentation

bool te::layout::AbstractViewTool::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().

Definition at line 44 of file AbstractViewTool.cpp.

bool te::layout::AbstractViewTool::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.

Definition at line 87 of file AbstractViewTool.cpp.

bool te::layout::AbstractViewTool::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::layout::ViewRubberBand, and te::layout::ViewZoomArea.

Definition at line 77 of file AbstractViewTool.cpp.

bool te::layout::AbstractViewTool::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::layout::ViewRubberBand, te::layout::ViewZoomClick, and te::layout::ViewZoomArea.

Definition at line 72 of file AbstractViewTool.cpp.

bool te::layout::AbstractViewTool::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::layout::ViewRubberBand, and te::layout::ViewZoomArea.

Definition at line 82 of file AbstractViewTool.cpp.

void te::layout::AbstractViewTool::setCursor ( const QCursor &  cursor)
virtual

It sets the tool cursor.

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

Definition at line 92 of file AbstractViewTool.cpp.

Referenced by te::layout::ViewZoomArea::ViewZoomArea(), and te::layout::ViewZoomClick::ViewZoomClick().

Member Data Documentation

QCursor te::layout::AbstractViewTool::m_cursor
protected

The default tool cursor.

Definition at line 141 of file AbstractViewTool.h.

View* te::layout::AbstractViewTool::m_view
protected

The QGraphicsView associated with the tool.

Definition at line 140 of file AbstractViewTool.h.

Referenced by AbstractViewTool().

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