ProxyProject.h

Go to the documentation of this file.

/*  Copyright (C) 2013-2014 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 ProxyProject.h
   
   \brief Provide a surrogate or placeholder for te::qt::af::Project to control access to it. 
    A wrapper to access without complexity. This proxy is required because module not must have dependence te::qt::af.
    Useful to access the Layers belonging to the project.

  \ingroup layout
*/

#ifndef __TE_QT_PLUGINS_LAYOUT_INTERNAL_PROXY_PROJECT_H 
#define __TE_QT_PLUGINS_LAYOUT_INTERNAL_PROXY_PROJECT_H

// TerraLib
#include "../../../layout/core/pattern/proxy/AbstractProxyProject.h"

// Qt
#include <QObject>

// STL
#include <string>

namespace te
{
  namespace qt
  {
    namespace plugins
    {
      namespace layout
      {
        /*!
        \brief Provide a surrogate or placeholder for te::qt::af::Project to control access to it. 
          A wrapper to access without complexity. This proxy is required because module not must have dependence te::qt::af.
          Useful to access the Layers belonging to the project.
    
        \ingroup layout

        \sa te::layout::AbstractProxyProject
        */
        class ProxyProject : public QObject, public te::layout::AbstractProxyProject
        {
          Q_OBJECT //for slots/signals

          public:

            /*!
              \brief Constructor
            */
            ProxyProject();

            /*!
              \brief Destructor
            */
            virtual ~ProxyProject();

            /*!
              \brief Reimplemented from AbstractProxyProject
            */
            std::list<te::map::AbstractLayerPtr> getAllLayers(bool invalid = true);

            /*!
              \brief Reimplemented from AbstractProxyProject
            */
            const std::list<te::map::AbstractLayerPtr> getSelectedLayers(bool invalid = true) const;

            /*!
              \brief Reimplemented from AbstractProxyProject
            */
            te::map::AbstractLayerPtr contains(std::string name);
         };
       }
    }
  }
}

#endif