RemoveProgressWidgetItemEvent.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/progress/RemoveProgressWidgetItemEvent.h

  \brief The RemoveProgressWidgetItemEvent is a custom event used to remove a progress widget item.
*/

#ifndef __TERRALIB_QT_WIDGETS_PROGRESS_INTERNAL_REMOVEPROGRESSWIDGETITEMEVENT_H
#define __TERRALIB_QT_WIDGETS_PROGRESS_INTERNAL_REMOVEPROGRESSWIDGETITEMEVENT_H

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

// Qt
#include <QtCore/QEvent>
#include <QtCore/QString>

namespace te
{
  namespace qt
  {
    namespace widgets
    {
      /*!
        \class RemoveProgressWidgetItemEvent

        \brief The RemoveProgressWidgetItem is a custom event used to remove a progress widget item.

        This event can be used when working with multithread tasks.
      */
      class TEQTWIDGETSEXPORT RemoveProgressWidgetItemEvent : public QEvent
      {
        public:

          /*!
            \brief It initializes a new RemoveProgressWidgetItemEvent.

            \param taskId The task id associated with the progress widget that will be removed.
          */
          RemoveProgressWidgetItemEvent(const int& taskId);

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

          /*! \brief Get the custom event type */
          static QEvent::Type type();

        public:

          int m_taskId; //!< The task id associated with the progress widget that will be removed.

        private:

          static QEvent::Type sm_customEventType;  //!< Custom Event Type
      };

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

#endif  // __TERRALIB_QT_WIDGETS_PROGRESS_INTERNAL_REMOVEPROGRESSWIDGETITEMEVENT_H