GroupingItem.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 layer/explorer/GroupingItem.h
22  *
23  * \brief A class that represents a grouping of a layer in a LayerTreeModel.
24  */
25 #ifndef __TERRALIB_QT_WIDGETS_LAYER_INTERNAL_GROUPINGITEM_H
26 #define __TERRALIB_QT_WIDGETS_LAYER_INTERNAL_GROUPINGITEM_H
27 
28 #include "TreeItem.h"
29 
30 namespace te
31 {
32  namespace map
33  {
34  class Grouping;
35  }
36 
37  namespace qt
38  {
39  namespace widgets
40  {
41  /*!
42  * \class GroupingItem
43  *
44  * \brief A class that represents a grouping of a layer in a LayerTreeModel.
45  *
46  * \note The type of the item is "GROUPING".
47  *
48  * \ingroup widgets
49  */
51  {
52  public:
53  /*!
54  * \name Instantiation Methods
55  *
56  * Methods related to creation and destruction of the object.
57  */
58  //@{
59 
60  /*!
61  * \brief Constructor.
62  *
63  * \param g The grouping to be used.
64  */
66 
67  /*!
68  * \brief Destructor.
69  */
70  ~GroupingItem();
71  //@}
72 
73  /*!
74  * \name Reimplementation of TreeItem
75  *
76  * Methods reimplemented of the TreeItem class.
77  */
78  //@{
79  std::string getAsString() const;
80 
81  VISIBLE isVisible() const;
82 
83  void setVisible(const VISIBLE& visible, const bool& updateAncestors = false, const bool& updateDescendents = false);
84 
85  Qt::ItemFlags flags();
86  //@}
87 
88  protected:
89 
90  std::string m_label; //!< Label to be presented on the Qt view.
91  te::map::Grouping* m_grouping; //!< Grouping being used.
92  };
93  }
94  }
95 }
96 
97 #endif //__TERRALIB_QT_WIDGETS_LAYER_INTERNAL_GROUPINGITEM_H
A class that represents a grouping of a layer in a LayerTreeModel.
Definition: GroupingItem.h:50
std::string m_label
Label to be presented on the Qt view.
Definition: GroupingItem.h:90
Defines an hierarquical structure.
Defines a hierarchical structure.
Definition: TreeItem.h:72
This class contains the parameters needed for grouping the values of a Property.
Definition: Grouping.h:59
te::map::Grouping * m_grouping
Grouping being used.
Definition: GroupingItem.h:91
URI C++ Library.
VISIBLE
Defines the visibility of an item.
Definition: TreeItem.h:58
#define TEQTWIDGETSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:63