qgsvaliditycheckresultswidget.h

Go to the documentation of this file.

/***************************************************************************
  qgsvaliditycheckresultswidget.cpp
 ----------------------------------
 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 QGSVALIDITYCHECKRESULTSWIDGET_H
#define QGSVALIDITYCHECKRESULTSWIDGET_H
 
#include "ui_qgsvaliditycheckresultsbase.h"
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsabstractvaliditycheck.h"
 
#include <QAbstractItemModel>
#include <QWidget>
 
class QgsValidityCheckContext;

class GUI_EXPORT QgsValidityCheckResultsModel : public QAbstractItemModel
{
    Q_OBJECT
  public:
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsValidityCheckResultsModel, Roles ) : int
    {
      Description SIP_MONKEYPATCH_COMPAT_NAME( DescriptionRole ) = Qt::UserRole + 1, 
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    QgsValidityCheckResultsModel( const QList<QgsValidityCheckResult> &results, QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    QModelIndex index( int row, int column, const QModelIndex &parent ) const override;
    QModelIndex parent( const QModelIndex &child ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
 
  private:
    QList<QgsValidityCheckResult> mResults;
};

class GUI_EXPORT QgsValidityCheckResultsWidget : public QWidget, private Ui::QgsValidityCheckResultsBase
{
    Q_OBJECT
 
  public:

    QgsValidityCheckResultsWidget( QWidget *parent SIP_TRANSFERTHIS );

    void setDescription( const QString &description );

    void setResults( const QList<QgsValidityCheckResult> &results );

    static bool runChecks( int type, const QgsValidityCheckContext *context, const QString &title, const QString &description, QWidget *parent = nullptr );
 
  private slots:
 
    void selectionChanged( const QModelIndex &current, const QModelIndex &previous );
 
  private:
    QgsValidityCheckResultsModel *mResultsModel = nullptr;
};
 
#endif // QGSVALIDITYCHECKRESULTSWIDGET_H