AbstractGraphicWidgetFactory.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/se/AbstractGraphicWidgetFactory.h
22 
23  \brief The abstract factory of widgets used to configure Symbology Enconding Graphic element.
24 */
25 
26 #ifndef __TERRALIB_QT_SE_INTERNAL_ABSTRACTGRAPHICWIDGETFACTORY_H
27 #define __TERRALIB_QT_SE_INTERNAL_ABSTRACTGRAPHICWIDGETFACTORY_H
28 
29 // TerraLib
30 #include "../../../common/AbstractFactory.h"
31 #include "../Config.h"
32 
33 // STL
34 #include <string>
35 #include <vector>
36 
37 namespace te
38 {
39  namespace qt
40  {
41  namespace widgets
42  {
43 // Forward declarations
44  class AbstractGraphicWidget;
45 
46  /*!
47  \class AbstractGraphicWidgetFactory
48 
49  \brief The abstract factory of widgets used to configure Symbology Enconding Graphic element.
50 
51  \sa AbstractFactory
52  */
53  class TEQTWIDGETSEXPORT AbstractGraphicWidgetFactory : public te::common::AbstractFactory<AbstractGraphicWidget, std::string>
54  {
55  public:
56 
57  /** @name Public Destructor
58  * Destructor.
59  */
60  //@{
61 
62  /*!
63  \brief Virtual destructor.
64 
65  \note It will automatically unregister the factory from the dictionary.
66  */
68 
69  //@}
70 
71  /*!
72  \brief It informs the key of each registered graphic widget factory.
73 
74  \param keys A pre-created vector of string that will be filled with the keys of each registered graphic widget factory.
75 
76  \note All registered factories will be consulted.
77  */
78  static void RegisteredWidgets(std::vector<std::string>& keys);
79 
80  protected:
81 
82  /** @name Protected Initializers
83  * Initializers.
84  */
85  //@{
86 
87  /*!
88  \brief It creates the factory.
89 
90  The key of a AbstractGraphicWidgetFactory is a string.
91 
92  \param factoryKey The key that identifies the factory.
93  */
94  AbstractGraphicWidgetFactory(const std::string& factoryKey);
95 
96  //@}
97  };
98 
99  } // end namespace widgets
100  } // end namespace qt
101 } // end namespace te
102 
103 #endif // __TERRALIB_QT_SE_INTERNAL_ABSTRACTGRAPHICWIDGETFACTORY_H
This class defines the interface of abstract factories without initializing parameters.
The abstract factory of widgets used to configure Symbology Enconding Graphic element.
URI C++ Library.
#define TEQTWIDGETSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:63