FolderItem.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 FolderItem.h
22  *
23  * \brief Defines a folder item, just containing LayerItem.
24  */
25 #ifndef __TERRALIB_QT_WIDGETS_LAYER_INTERNAL_FOLDERITEM_H
26 #define __TERRALIB_QT_WIDGETS_LAYER_INTERNAL_FOLDERITEM_H
27 
28 #include "TreeItem.h"
29 
30 namespace te
31 {
32  namespace qt
33  {
34  namespace widgets
35  {
36  /*!
37  * \class FolderItem
38  *
39  * \brief Represents a folder item that contains layers and / or other folders.
40  *
41  * \note The type of the item is "FOLDER".
42  *
43  * \ingroup widgets
44  */
46  {
47  public:
48  /*!
49  * \name Instantiation Methods
50  *
51  * Methods related to creation and destruction of the object.
52  */
53  //@{
54 
55  /*!
56  * \brief Constructor.
57  *
58  * \param label Label to be presented in the Qt view.
59  */
60  FolderItem(const std::string& label);
61 
62  /*!
63  * \brief Destructor.
64  */
65  ~FolderItem();
66  //@}
67 
68  /*!
69  * \name Reimplementation of TreeItem
70  *
71  * Methods reimplemented of the TreeItem class.
72  */
73  //@{
74  std::string getAsString() const;
75 
76  VISIBLE isVisible() const;
77 
78  void setVisible(const VISIBLE& visible, const bool& updateAncestors = false, const bool& updateDescendents = false);
79 
80  Qt::ItemFlags flags();
81  //@}
82 
83  /*!
84  * \brief Updates the title of the folder.
85  *
86  * \param title The new item title.
87  */
88  void setTitle(const std::string& title);
89 
90  protected:
91  std::string m_label; //!< Label to be presented on the Qt view.
92  VISIBLE m_v; //!< Visibility of the folder.
93  };
94  }
95  }
96 }
97 
98 #endif //__TERRALIB_QT_WIDGETS_LAYER_INTERNAL_FOLDERITEM_H
Defines an hierarquical structure.
Defines a hierarchical structure.
Definition: TreeItem.h:72
Represents a folder item that contains layers and / or other folders.
Definition: FolderItem.h:45
std::string m_label
Label to be presented on the Qt view.
Definition: FolderItem.h:91
URI C++ Library.
VISIBLE m_v
Visibility of the folder.
Definition: FolderItem.h:92
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