TimeSeriesStyleWidget.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 terralib/qt/widgets/charts/timeSeriesStyleWidget.h

  \brief A widget used to adjust a timeSeries's style.
*/

#ifndef __TERRALIB_QT_WIDGETS_INTERNAL_TIMESERIESSTYLEWIDGET_H
#define __TERRALIB_QT_WIDGETS_INTERNAL_TIMESERIESSTYLEWIDGET_H

//TerraLib
#include "../Config.h"

// Qt
#include <QWidget>

//STL
#include <memory>

namespace Ui { class TimeSeriesStyleWidgetForm; }

namespace te
{
  namespace qt
  {
    namespace widgets
    {
    //Forward Declarations
    class TimeSeriesStyle;

    /*!
        \class TimeSeriesStyleWidget

        \brief  A widget used to adjust a timeSeries's style.
      */
      class TEQTWIDGETSEXPORT TimeSeriesStyleWidget : public QWidget
      {

        Q_OBJECT

        public:

          /*!
            \brief Constructor

            \param initial  An initial TimeSeriesStyle element that will be used, it will take ownership of this pointer if it is given. The widget form will be updated based on
                            it's parameters. It can be NULL.
            \param parent   this widget's parent
            \param f Window flags used to configure this dialog
          */
          TimeSeriesStyleWidget(te::qt::widgets::TimeSeriesStyle* initial = 0, QWidget* parent = 0, Qt::WindowFlags f = 0);

          /*! 
            \brief Destructor.
          */
          ~TimeSeriesStyleWidget();

          /*!
            \brief Returns a pointer to the TimeSeriesStyle being configured

            \return A TimeSeriesStyle type pointer to the style being configured
            \note The caller will take ownership of the returned pointer.
          */
          te::qt::widgets::TimeSeriesStyle* getTimeSeriesStyle();

        protected slots:

          void onStrokePushButtonClicked();

        private:

          std::auto_ptr<Ui::TimeSeriesStyleWidgetForm>  m_ui;               //!< The iwdget form.
          TimeSeriesStyle*                              m_timeSeriesStyle;  //!< The timeSeries's chart style that will be configured by this widget.
      };
    } // end namespace widgets
  }   // end namespace qt
}     // end namespace te

#endif  // __TERRALIB_QT_WIDGETS_INTERNAL_TIMESERIESSTYLEWIDGET_H