RubberBand.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/qt/widgets/tools/RubberBand.h
22 
23  \brief This is a utility class tool that provides a rectangle that can indicate a boundary.
24 */
25 
26 #ifndef __TERRALIB_QT_WIDGETS_INTERNAL_RUBBERBAND_H
27 #define __TERRALIB_QT_WIDGETS_INTERNAL_RUBBERBAND_H
28 
29 // TerraLib
30 #include "../Config.h"
31 #include "AbstractTool.h"
32 
33 // Qt
34 #include <QPen>
35 
36 namespace te
37 {
38  namespace qt
39  {
40  namespace widgets
41  {
42 // Forward declarations
43  class MapDisplay;
44 
45  /*!
46  \class RubberBand
47 
48  \brief This class provides a rectangle that can indicate a boundary.
49 
50  \ingroup widgets
51  */
53  {
54  public:
55 
56  /** @name Initializer Methods
57  * Methods related to instantiation and destruction.
58  */
59  //@{
60 
61  /*!
62  \brief It constructs a rubber band associated with the given map display and with the specified cursor.
63 
64  \param display The map display associated with the tool.
65  \param parent The tool's parent.
66 
67  \note The tool will NOT take the ownership of the given pointers.
68  \note If the given cursor is different of Qt::BlankCursor, it will be setted on map display.
69  */
70  RubberBand(MapDisplay* display, QObject* parent = 0);
71 
72  /*! \brief Destructor. */
73  virtual ~RubberBand();
74 
75  //@}
76 
77  /** @name AbstractTool Methods
78  * Methods related with tool behavior.
79  */
80  //@{
81 
82  virtual bool mousePressEvent(QMouseEvent* e);
83 
84  virtual bool mouseMoveEvent(QMouseEvent* e);
85 
86  virtual bool mouseReleaseEvent(QMouseEvent* e);
87 
88  //@}
89 
90  protected:
91 
92  QPoint m_origin; //!< Origin point on mouse pressed.
93  QRectF m_rect; //!< The boundary rectangle managed by the rubber band.
94  QPen m_pen; //!< The pen used to draw the rubber band shape.
95  QBrush m_brush; //!< The brush used to draw the rubber band shape.
96 
97  };
98 
99  } // end namespace widgets
100  } // end namespace qt
101 } // end namespace te
102 
103 #endif // __TERRALIB_QT_WIDGETS_INTERNAL_RUBBERBAND_H
Abstract tool concept.
QPoint m_origin
Origin point on mouse pressed.
Definition: RubberBand.h:92
QPen m_pen
The pen used to draw the rubber band shape.
Definition: RubberBand.h:94
A widget to control the display of a set of layers.
Definition: MapDisplay.h:69
This class defines an interface for objects that can receive application events and respond to them...
Definition: AbstractTool.h:62
QBrush m_brush
The brush used to draw the rubber band shape.
Definition: RubberBand.h:95
QRectF m_rect
The boundary rectangle managed by the rubber band.
Definition: RubberBand.h:93
URI C++ Library.
This class provides a rectangle that can indicate a boundary.
Definition: RubberBand.h:52
#define TEQTWIDGETSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:63