QGIS API Documentation  3.24.2-Tisler (13c1a02865)
qgshistoryprovider.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgshistoryprovider.h
3  --------------------------
4  begin : April 2019
5  copyright : (C) 2019 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 /***************************************************************************
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 #ifndef QGSHISTORYPROVIDER_H
17 #define QGSHISTORYPROVIDER_H
18 
19 #include "qgis_gui.h"
20 #include "qgis_sip.h"
21 #include <QString>
22 #include <QVariantMap>
23 
24 class QgsHistoryEntryNode;
25 
26 
36 {
37  public:
38 
39 #ifdef SIP_RUN
41  if ( dynamic_cast<QgsProcessingHistoryProvider *>( sipCpp ) )
42  sipType = sipType_QgsProcessingHistoryProvider;
43  else
44  sipType = nullptr;
45  SIP_END
46 #endif
47 
49 
53  virtual QString id() const = 0;
54 
55 #if 0
56 
60  virtual QgsHistoryEntryNode *createNodeForEntry( const QVariantMap &entry ) = 0 SIP_FACTORY;
61 #endif
62 };
63 
64 #endif //QGSHISTORYPROVIDER_H
65 
66 
67 
Abstract base class for objects which track user history (i.e.
virtual ~QgsAbstractHistoryProvider()
virtual QString id() const =0
Returns the provider's unique id, which is used to associate existing history entries with the provid...
History provider for operations performed through the Processing framework.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:177
#define SIP_FACTORY
Definition: qgis_sip.h:76
#define SIP_END
Definition: qgis_sip.h:194