qgsprojectservervalidator.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprojectservervalidator.h
                             ---------------------------
    begin                : March 2020
    copyright            : (C) 2020 by Etienne Trimaille
    email                : etienne dot trimaille at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSPROJECTSERVERVALIDATOR_H
#define QGSPROJECTSERVERVALIDATOR_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayertree.h"
#include "qgslayertreegroup.h"

class CORE_EXPORT QgsProjectServerValidator
{
 
  public:
 
    QgsProjectServerValidator() = default;

    enum ValidationError
    {
      DuplicatedNames = 0, 
      LayerShortName = 1, 
      LayerEncoding = 2,  
      ProjectShortName = 3,  
      ProjectRootNameConflict = 4,  
      OnlyMaptipTrueButEmptyMaptip = 5,  
    };

    static QString displayValidationError( QgsProjectServerValidator::ValidationError error );

    struct ValidationResult
    {

      ValidationResult( const QgsProjectServerValidator::ValidationError error, const QVariant &identifier )
        : error( error )
        , identifier( identifier )
      {}

      QgsProjectServerValidator::ValidationError error;

      QVariant identifier;
    };

    static bool validate( QgsProject *project, QList< QgsProjectServerValidator::ValidationResult > &results SIP_OUT );
 
  private:
    static void browseLayerTree( QgsLayerTreeGroup *treeGroup, QStringList &owsNames, QStringList &encodingMessages, QStringList &layerNames, QStringList &maptipTemplates );
    static bool isOnlyMaptipEnabled( QgsProject *project );
 
};
 
#endif // QGSPROJECTSERVERVALIDATOR_H