mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
73 lines
2.2 KiB
Plaintext
73 lines
2.2 KiB
Plaintext
|
/**
|
||
|
|
* \class QgsProcessingFeedback
|
||
|
|
* \ingroup core
|
||
|
|
* Base class for providing feedback from a processing algorithm.
|
||
|
|
*
|
||
|
|
* This base class implementation silently ignores all feedback reported by algorithms.
|
||
|
|
* Subclasses of QgsProcessingFeedback can be used to log this feedback or report
|
||
|
|
* it to users via the GUI.
|
||
|
|
* \note added in QGIS 3.0
|
||
|
|
*/
|
||
|
|
class QgsProcessingFeedback : public QgsFeedback
|
||
|
|
{
|
||
|
|
%TypeHeaderCode
|
||
|
|
#include <qgsprocessingfeedback.h>
|
||
|
|
%End
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets a progress report text string. This can be used in conjunction with
|
||
|
|
* setProgress() to provide detailed progress reports, such as "Transformed
|
||
|
|
* 4 of 5 layers".
|
||
|
|
* @see setProgress()
|
||
|
|
*/
|
||
|
|
virtual void setProgressText( const QString& text );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reports that the algorithm encountered an error which prevented it
|
||
|
|
* from successfully executing.
|
||
|
|
*/
|
||
|
|
virtual void reportError( const QString& error );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pushes a general informational message from the algorithm. This can
|
||
|
|
* be used to report feedback which is neither a status report or an
|
||
|
|
* error, such as "Found 47 matching features".
|
||
|
|
* @see pushCommandInfo()
|
||
|
|
* @see pushDebugInfo()
|
||
|
|
* @see pushConsoleInfo()
|
||
|
|
*/
|
||
|
|
virtual void pushInfo( const QString& info );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pushes an informational message containing a command from the algorithm.
|
||
|
|
* This is usually used to report commands which are executed in an external
|
||
|
|
* application or as subprocesses.
|
||
|
|
* @see pushInfo()
|
||
|
|
* @see pushDebugInfo()
|
||
|
|
* @see pushConsoleInfo()
|
||
|
|
*/
|
||
|
|
virtual void pushCommandInfo( const QString& info );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pushes an informational message containing debugging helpers from
|
||
|
|
* the algorithm.
|
||
|
|
* @see pushInfo()
|
||
|
|
* @see pushCommandInfo()
|
||
|
|
* @see pushConsoleInfo()
|
||
|
|
*/
|
||
|
|
virtual void pushDebugInfo( const QString& info );
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pushes a console feedback message from the algorithm. This is used to
|
||
|
|
* report the output from executing an external command or subprocess.
|
||
|
|
* @see pushInfo()
|
||
|
|
* @see pushDebugInfo()
|
||
|
|
* @see pushCommandInfo()
|
||
|
|
*/
|
||
|
|
virtual void pushConsoleInfo( const QString& info );
|
||
|
|
|
||
|
|
};
|