qgsabstractvaliditycheck.h

Go to the documentation of this file.

/***************************************************************************
    qgsabstractvaliditycheck.h
    --------------------------
    begin                : November 2018
    copyright            : (C) 2018 by Nyall Dawson
    email                : nyall dot dawson 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 QGSABSTRACTVALIDITYCHECK_H
#define QGSABSTRACTVALIDITYCHECK_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
#include <QString>
 
class QgsValidityCheckContext;
class QgsFeedback;

class CORE_EXPORT QgsValidityCheckResult
{
  public:
    enum Type
    {
      Warning,  
      Critical, 
    };

    QgsValidityCheckResult::Type type;

    QString title;

    QString detailedDescription;

    QString checkId;
};

class CORE_EXPORT QgsAbstractValidityCheck
{
  public:
    // *INDENT-OFF*
    enum class Type SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsAbstractValidityCheck, Type ) : int
    {
      LayoutCheck SIP_MONKEYPATCH_COMPAT_NAME( TypeLayoutCheck ) = 0, 
      UserCheck SIP_MONKEYPATCH_COMPAT_NAME( TypeUserCheck ) = 10000, 
    };
    // *INDENT-ON*
 
    virtual ~QgsAbstractValidityCheck() = default;

    virtual QgsAbstractValidityCheck *create() const = 0 SIP_FACTORY;

    virtual QString id() const = 0;

    virtual int checkType() const = 0;

    virtual bool prepareCheck( const QgsValidityCheckContext *context, QgsFeedback *feedback )
    {
      Q_UNUSED( context )
      Q_UNUSED( feedback )
      return true;
    }

    virtual QList< QgsValidityCheckResult > runCheck( const QgsValidityCheckContext *context, QgsFeedback *feedback ) = 0;
};
 
#endif // QGSABSTRACTVALIDITYCHECK_H