ZoomWheel.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/ZoomWheel.h
22 
23  \brief This class implements a concrete tool to geographic zoom operation using the mouse wheel.
24 */
25 
26 #ifndef __TERRALIB_QT_WIDGETS_INTERNAL_ZOOMWHEEL_H
27 #define __TERRALIB_QT_WIDGETS_INTERNAL_ZOOMWHEEL_H
28 
29 // TerraLib
30 #include "../Config.h"
31 #include "Zoom.h"
32 
33 namespace te
34 {
35  namespace qt
36  {
37  namespace widgets
38  {
39 // Forward declarations
40  class MapDisplay;
41 
42  /*!
43  \class ZoomWheel
44 
45  \brief This class implements a concrete tool to geographic zoom operation using the mouse wheel.
46 
47  \ingroup widgets
48  */
50  {
51  public:
52 
53  /** @name Initializer Methods
54  * Methods related to instantiation and destruction.
55  */
56  //@{
57 
58  /*!
59  \brief It constructs a zoom wheel tool associated with the given map display.
60 
61  \param display The map display associated with the tool.
62  \param zoomFactor The factor used to zoom. i.e. A factor value of 2.0 (default) will generate a new extent twice (%) bigger or smaller.
63  \param parent The tool's parent.
64 
65  \note The tool will NOT take the ownership of the given pointers.
66  */
67  ZoomWheel(MapDisplay* display, const double& zoomFactor = 2.0, const bool& centralize = true, QObject* parent = 0);
68 
69  /*! \brief Destructor. */
70  ~ZoomWheel();
71 
72  //@}
73 
74  /** @name AbstractTool Methods
75  * Methods related with tool behavior.
76  */
77  //@{
78 
79  bool eventFilter(QObject* watched, QEvent* e);
80 
81  //@}
82 
83  protected:
84 
85  bool m_centralize; //!< If TRUE, the reference that will be used will be the center of the map display extent. If FALSE, the position of the wheel will be used as reference.
86 
87 
88  };
89 
90  } // end namespace widgets
91  } // end namespace qt
92 } // end namespace te
93 
94 #endif // __TERRALIB_QT_WIDGETS_INTERNAL_ZOOMWHEEL_H
This is a utility class to geographic zoom operation.
Definition: Zoom.h:49
This is a utility class to geographic zoom operation.
A widget to control the display of a set of layers.
Definition: MapDisplay.h:66
bool m_centralize
If TRUE, the reference that will be used will be the center of the map display extent. If FALSE, the position of the wheel will be used as reference.
Definition: ZoomWheel.h:85
URI C++ Library.
This class implements a concrete tool to geographic zoom operation using the mouse wheel...
Definition: ZoomWheel.h:49
#define TEQTWIDGETSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:63