ColorMapSliceItem.h

Go to the documentation of this file.

/*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

This file is part of the TerraLib - a Framework for building GIS enabled applications.

TerraLib is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.

TerraLib is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with TerraLib. See COPYING. If not, write to
TerraLib Team at <terralib-team@terralib.org>.
*/

/*!
 * \file ColorMapSliceItem.h
 *
 * \brief A class that represents a slice of a ColorMapItem.
 */

#ifndef __TERRALIB_QT_WIDGETS_LAYER_INTERNAL_COLORMAPSLICEITEM_H
#define __TERRALIB_QT_WIDGETS_LAYER_INTERNAL_COLORMAPSLICEITEM_H

#include "TreeItem.h"

// Qt
#include <QColor>
#include <QIcon>

namespace te
{
  namespace qt
  {
    namespace widgets
    {
      /*!
      * \class ColorMapSliceItem
      *
      * \brief A class that represents a slice of a ColorMapItem.
      *
      * \note The type of the item is "COLORMAPSLICE".
      *
      * \ingroup widgets
      */
      class TEQTWIDGETSEXPORT ColorMapSliceItem: public TreeItem
      {
      public:
        /*!
        * \name Instantiation Methods
        *
        * Methods related to creation and destruction of the object.
        */
        //@{

        /*!
        * \brief Constructor.
        *
        * \param label Label to be presented in the Qt view.
        * \param beg Begin color.
        * \param end End color.
        *
        * \note Use \a end for slices with mixed colors. 
        */
        ColorMapSliceItem(const std::string& label, const QColor& beg, const QColor& end = QColor());

        /*!
        * \brief Destructor.
        */
        ~ColorMapSliceItem();
        //@}

        /*!
        * \name Reimplementation of TreeItem
        *
        * Methods reimplemented of the TreeItem class.
        */
        //@{
        std::string getAsString() const;
        //@}

        /*!
        * \brief Returns the icon to be presented in the tree.
        *
        * \return Icon to be presented.
        */
        QIcon getIcon() const;

      protected:

        std::string m_label;    //!< Label to be presented on the Qt view.
        QIcon m_icon;           //!< Icon to be presented.
      };
    }
  }
}

#endif //__TERRALIB_QT_WIDGETS_LAYER_INTERNAL_COLORMAPSLICEITEM_H