All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Plugin.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/plugins/addressgeocoding/Plugin.h
22 
23  \brief Plugin implementation for the SA Qt Plugin widget.
24 */
25 
26 #ifndef __TE_QT_PLUGINS_ADDRESSGEOCODING_INTERNAL_PLUGIN_H
27 #define __TE_QT_PLUGINS_ADDRESSGEOCODING_INTERNAL_PLUGIN_H
28 
29 // TerraLib
30 #include "../../../maptools/AbstractLayer.h"
31 #include "../../../plugin/Plugin.h"
32 #include "Config.h"
33 
34 // Qt
35 #include <QAction>
36 #include <QtCore/QObject>
37 #include <QMenu>
38 
39 namespace te
40 {
41  namespace qt
42  {
43  namespace plugins
44  {
45  namespace addressgeocoding
46  {
47 
48  class Plugin : public QObject, public te::plugin::Plugin
49  {
50  Q_OBJECT
51 
52  public:
53 
54  Plugin(const te::plugin::PluginInfo& pluginInfo);
55 
56  ~Plugin();
57 
58  void startup();
59 
60  void shutdown();
61 
62  protected slots:
63  /*!
64  \brief Slot function used when a action was selected.
65 
66  \param checked Flag used in case a toggle action.
67  */
68  void onActionActivated(bool checked);
69 
70  protected:
71 
72  /*!
73  \brief Get the list of layers from app
74 
75  \return The list pf layer auto pointers
76 
77  */
78  std::list<te::map::AbstractLayerPtr> getLayers();
79 
80  /*!
81  \brief Function used to unregister all addressgeocoding actions.
82 
83  */
84  void unRegisterActions();
85 
86  protected:
87 
88  QAction* m_action; //!< Address Geocoding Action
89  };
90 
91  } // end namespace addressgeocoding
92  } // end namespace plugins
93  } // end namespace qt
94 } // end namespace te
95 
97 
98 #endif //__TE_QT_PLUGINS_ADDRESSGEOCODING_INTERNAL_PLUGIN_H
PLUGIN_CALL_BACK_DECLARATION(TEQTPLUGINADDRESSGEOCODINGEXPORT)
#define TEQTPLUGINADDRESSGEOCODINGEXPORT
You can use this macro in order to export/import classes and functions from all plug-ins files...
Definition: Config.h:53
QAction * m_action
Address Geocoding Action.
Definition: Plugin.h:88
std::list< te::map::AbstractLayerPtr > getLayers()
Get the list of layers from app.
Definition: Plugin.cpp:165
Configuration flags for the address geocoding Qt Widget plugin.
void startup()
Do nothing! Just set plugin as started.
Definition: Plugin.cpp:69
A base class for plugin types.
Definition: Plugin.h:50
Plugin(const te::plugin::PluginInfo &pluginInfo)
Definition: Plugin.cpp:60
void unRegisterActions()
Function used to unregister all addressgeocoding actions.
Definition: Plugin.cpp:178
void onActionActivated(bool checked)
Slot function used when a action was selected.
Definition: Plugin.cpp:134
The basic information about a plugin.
Definition: PluginInfo.h:61
void shutdown()
Do nothing! Just set plugin as stopped.
Definition: Plugin.cpp:117