QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
qgsprocessinghistoryprovider.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessinghistoryprovider.h
3 --------------------------
4 begin : December 2021
5 copyright : (C) 2021 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 QGSPROCESSINGHISTORYPROVIDER_H
17#define QGSPROCESSINGHISTORYPROVIDER_H
18
19#include "qgis_gui.h"
20#include "qgis_sip.h"
21
22#include "qgshistoryprovider.h"
23
31{
32 Q_OBJECT
33
34 public:
35
37
38 QString id() const override;
39
45 void portOldLog();
46
48 void updateNodeForEntry( QgsHistoryEntryNode *node, const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context ) override;
49
50 signals:
51
57 void executePython( const QString &commands );
58
64 void createTest( const QString &command );
65
66 private:
67
69 void emitExecute( const QString &commands );
70
71 void emitCreateTest( const QString &command );
72
74 QString oldLogPath() const;
75
76 friend class ProcessingHistoryBaseNode;
77
78};
79
80#endif //QGSHISTORYPROVIDER_H
81
82
83
Abstract base class for objects which track user history (i.e.
virtual QString id() const =0
Returns the provider's unique id, which is used to associate existing history entries with the provid...
virtual void updateNodeForEntry(QgsHistoryEntryNode *node, const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context)
Updates an existing history node for the given entry.
virtual QgsHistoryEntryNode * createNodeForEntry(const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context)
Creates a new history node for the given entry.
Base class for nodes representing a QgsHistoryEntry.
Encapsulates a history entry.
Contains settings which reflect the context in which a history widget is shown, e....
History provider for operations performed through the Processing framework.
void executePython(const QString &commands)
Emitted when the provider needs to execute python commands in the Processing context.
void createTest(const QString &command)
Emitted when the provider needs to create a Processing test with the given python command.
#define SIP_FACTORY
Definition qgis_sip.h:76