QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
gui
processing
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
#include "
qgshistoryprovider.h
"
22
29
class
GUI_EXPORT
QgsProcessingHistoryProvider
:
public
QgsAbstractHistoryProvider
30
{
31
Q_OBJECT
32
33
public
:
34
QgsProcessingHistoryProvider
();
35
36
QString
id
()
const override
;
37
43
void
portOldLog
();
44
45
QgsHistoryEntryNode
*
createNodeForEntry
(
const
QgsHistoryEntry
&entry,
const
QgsHistoryWidgetContext
&context )
override
SIP_FACTORY
;
46
void
updateNodeForEntry
(
QgsHistoryEntryNode
*node,
const
QgsHistoryEntry
&entry,
const
QgsHistoryWidgetContext
&context )
override
;
47
48
signals:
49
55
void
executePython
(
const
QString &commands );
56
62
void
createTest
(
const
QString &command );
63
69
void
showMessage
(
const
QString &message );
70
71
private
:
73
void
emitExecute(
const
QString &commands );
74
76
void
emitCreateTest(
const
QString &command );
77
79
void
emitShowMessage(
const
QString &message );
80
82
QString oldLogPath()
const
;
83
84
friend
class
ProcessingHistoryBaseNode
;
85
};
86
87
#endif
//QGSHISTORYPROVIDER_H
QgsAbstractHistoryProvider
Abstract base class for objects which track user history (i.e.
Definition
qgshistoryprovider.h:38
QgsAbstractHistoryProvider::id
virtual QString id() const =0
Returns the provider's unique id, which is used to associate existing history entries with the provid...
QgsAbstractHistoryProvider::updateNodeForEntry
virtual void updateNodeForEntry(QgsHistoryEntryNode *node, const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context)
Updates an existing history node for the given entry.
Definition
qgshistoryprovider.cpp:28
QgsAbstractHistoryProvider::createNodeForEntry
virtual QgsHistoryEntryNode * createNodeForEntry(const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context)
Creates a new history node for the given entry.
Definition
qgshistoryprovider.cpp:23
QgsHistoryEntryNode
Base class for nodes representing a QgsHistoryEntry.
Definition
qgshistoryentrynode.h:42
QgsHistoryEntry
Encapsulates a history entry.
Definition
qgshistoryentry.h:37
QgsHistoryWidgetContext
Contains settings which reflect the context in which a history widget is shown, e....
Definition
qgshistorywidgetcontext.h:33
QgsProcessingHistoryProvider::showMessage
void showMessage(const QString &message)
Emitted when the provider needs to display a message.
QgsProcessingHistoryProvider::executePython
void executePython(const QString &commands)
Emitted when the provider needs to execute python commands in the Processing context.
QgsProcessingHistoryProvider::createTest
void createTest(const QString &command)
Emitted when the provider needs to create a Processing test with the given python command.
QgsProcessingHistoryProvider::ProcessingHistoryBaseNode
friend class ProcessingHistoryBaseNode
Definition
qgsprocessinghistoryprovider.h:84
QgsProcessingHistoryProvider::portOldLog
void portOldLog()
Ports the old text log to the history framework.
Definition
qgsprocessinghistoryprovider.cpp:54
QgsProcessingHistoryProvider::QgsProcessingHistoryProvider
QgsProcessingHistoryProvider()
Definition
qgsprocessinghistoryprovider.cpp:46
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
qgshistoryprovider.h
Generated on
for QGIS API Documentation by
1.17.0