ChartStyleWidget.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/chartStyleWidget.h

  \brief A widget used to customize the style parameters of a chart
*/

#ifndef __TERRALIB_QT_WIDGETS_INTERNAL_CHARTSTYLEWIDGET_H
#define __TERRALIB_QT_WIDGETS_INTERNAL_CHARTSTYLEWIDGET_H

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

// Qt
#include <QDialog>

//STL
#include <memory>

namespace Ui { class chartStyleWidgetForm; }

namespace te
{
  namespace qt
  {
    namespace widgets
    {

    class ColorPickerToolButton;
    class ChartStyle;
    class ChartDisplay;

    /*!
        \class Chart Style

        \brief A wdiget used to customize a chart's style parameters.
      */
      class TEQTWIDGETSEXPORT ChartStyleWidget : public QWidget
      {

        Q_OBJECT

        public:

          /*!
            \brief Constructor

            It constructs a ChartStyleWidget.

            \param parent this widget's parent
            \param f Window flags used to configure this widget
            \param title The title to be configured, defaults to an empty title.
            \param PropertyX The label of the x axis to be configured, defaults to an empty label.
            \param PropertyY The label of the y axis to be configured, defaults to an empty label.
          */
          ChartStyleWidget(QWidget* parent = 0, Qt::WindowFlags f = 0, QString title = "", QString PropertyX = "", QString PropertyY = "");

          /*!
            \brief Destructor
          */
          ~ChartStyleWidget();

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

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

          /*!
            \brief It sets the ChartStyle being configured

            \param newStyle The new ChartStyle.
            \note It will not take ownership of the given pointer 
          */
          void setStyle(te::qt::widgets::ChartStyle* newStyle);

        protected slots:

          void onTitleLineEditFinish();
          void onlabelXEditFinish();
          void onlabelYEditFinish();
          void onTitleStylePushButtonClicked();
          void onLabelStylePushButtonClicked();
          void onGridCheckBoxToggled(int state);
          void onColorChanged(const QColor& color);

        private:

          std::auto_ptr<Ui::chartStyleWidgetForm>  m_ui;            //!< The widget form.
          ColorPickerToolButton*                   m_colorPicker;   //!< The color picker used to customise the color of several chart parameters.
          ChartStyle*                              m_chartStyle;    //!< The display's style that will be configured by this dialog.
      };
    } // end namespace widgets
  }   // end namespace qt
}     // end namespace te

#endif  // __TERRALIB_QT_WIDGETS_INTERNAL_CHARTSTYLEWIDGET_H