ConstraintWidget.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/property/ConstraintWidget.h

  \brief This file has the ConstraintWidget class.
*/

#ifndef __TERRALIB_QT_WIDGETS_PROPERTY_INTERNAL_CONSTRAINTWIDGET_H
#define __TERRALIB_QT_WIDGETS_PROPERTY_INTERNAL_CONSTRAINTWIDGET_H

// TerraLib
#ifndef Q_MOC_RUN
#include "../../../dataaccess/dataset/DataSetType.h"
#endif
#include "../Config.h"

// Qt
#include <QWidget>

namespace Ui { class ConstraintWidgetForm; }

namespace te
{
  namespace da { class Constraint; }

  namespace qt
  {
    namespace widgets
    {
      class DoubleListWidget;

      /*!
        \class ConstraintWidget

        \brief This virtual class is used to define a Constraint DataSet class object.
      */
      class TEQTWIDGETSEXPORT ConstraintWidget : public QWidget
      {
        Q_OBJECT

        public:

          ConstraintWidget(te::da::DataSetType* dsType, QWidget* parent = 0, Qt::WindowFlags f = 0);

          virtual ~ConstraintWidget();

          Ui::ConstraintWidgetForm* getForm() const;


        public:

          /*!
            \brief It returns the Constraint DataSet class object.

            \return The caller of this method will TAKE the ownership of the returned Constraint pointer.
          */
          virtual te::da::Constraint* getConstraint() = 0;

          /*!
            \brief Check the interface parameters

            \return True if the necessary parameters is ok and false in other case.
          */
          bool checkParameters();


        protected:

         std::auto_ptr<Ui::ConstraintWidgetForm> m_ui;
         te::qt::widgets::DoubleListWidget* m_doubleListWidget;
         te::da::DataSetType* m_dsType;
      }; 

    } // end namespace widgets
  }   // end namespace qt
}     // end namespace te

#endif  // __TERRALIB_QT_WIDGETS_PROPERTY_INTERNAL_CONSTRAINTWIDGET_H