ColorMapSliceItem.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 ColorMapSliceItem.h
22  *
23  * \brief A class that represents a slice of a ColorMapItem.
24  */
25 
26 #ifndef __TERRALIB_QT_WIDGETS_LAYER_INTERNAL_COLORMAPSLICEITEM_H
27 #define __TERRALIB_QT_WIDGETS_LAYER_INTERNAL_COLORMAPSLICEITEM_H
28 
29 #include "TreeItem.h"
30 
31 // Qt
32 #include <QColor>
33 #include <QIcon>
34 
35 namespace te
36 {
37  namespace qt
38  {
39  namespace widgets
40  {
41  /*!
42  * \class ColorMapSliceItem
43  *
44  * \brief A class that represents a slice of a ColorMapItem.
45  *
46  * \note The type of the item is "COLORMAPSLICE".
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 label Label to be presented in the Qt view.
64  * \param beg Begin color.
65  * \param end End color.
66  *
67  * \note Use \a end for slices with mixed colors.
68  */
69  ColorMapSliceItem(const std::string& label, const QColor& beg, const QColor& end = QColor());
70 
71  /*!
72  * \brief Destructor.
73  */
75  //@}
76 
77  /*!
78  * \name Reimplementation of TreeItem
79  *
80  * Methods reimplemented of the TreeItem class.
81  */
82  //@{
83  std::string getAsString() const;
84  //@}
85 
86  /*!
87  * \brief Returns the icon to be presented in the tree.
88  *
89  * \return Icon to be presented.
90  */
91  QIcon getIcon() const;
92 
93  protected:
94 
95  std::string m_label; //!< Label to be presented on the Qt view.
96  QIcon m_icon; //!< Icon to be presented.
97  };
98  }
99  }
100 }
101 
102 #endif //__TERRALIB_QT_WIDGETS_LAYER_INTERNAL_COLORMAPSLICEITEM_H
std::string m_label
Label to be presented on the Qt view.
Defines an hierarquical structure.
Defines a hierarchical structure.
Definition: TreeItem.h:72
URI C++ Library.
A class that represents a slice of a ColorMapItem.
#define TEQTWIDGETSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:63
QIcon m_icon
Icon to be presented.