qgshistoryprovider.h

Go to the documentation of this file.

/***************************************************************************
                            qgshistoryprovider.h
                            --------------------------
    begin                : April 2019
    copyright            : (C) 2019 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 QGSHISTORYPROVIDER_H
#define QGSHISTORYPROVIDER_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QString>
#include <QVariantMap>
 
class QgsHistoryEntryNode;
class QgsHistoryEntry;
class QgsHistoryWidgetContext;

class GUI_EXPORT QgsAbstractHistoryProvider : public QObject
{
    Q_OBJECT
 
  public:
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsProcessingHistoryProvider *>( sipCpp ) )
      sipType = sipType_QgsProcessingHistoryProvider;
    else
      sipType = nullptr;
    SIP_END
#endif
 
    ~QgsAbstractHistoryProvider() override;

    virtual QString id() const = 0;

    virtual QgsHistoryEntryNode *createNodeForEntry( const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context ) SIP_FACTORY;

    virtual void updateNodeForEntry( QgsHistoryEntryNode *node, const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context );
};
 
#endif //QGSHISTORYPROVIDER_H