Skip to content

Commit

Permalink
Remove processing sip bindings from sip blacklist
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Apr 2, 2017
1 parent bed74fc commit f831a3c
Show file tree
Hide file tree
Showing 6 changed files with 235 additions and 157 deletions.
3 changes: 0 additions & 3 deletions python/auto_sip.blacklist
Expand Up @@ -243,9 +243,6 @@ core/layertree/qgslayertreemodellegendnode.sip
core/layertree/qgslayertreenode.sip
core/layertree/qgslayertreeregistrybridge.sip
core/layertree/qgslayertreeutils.sip
core/processing/qgsprocessingfeedback.sip
core/processing/qgsprocessingprovider.sip
core/processing/qgsprocessingregistry.sip
core/raster/qgsbilinearrasterresampler.sip
core/raster/qgsbrightnesscontrastfilter.sip
core/raster/qgscliptominmaxenhancement.sip
Expand Down
150 changes: 86 additions & 64 deletions python/core/processing/qgsprocessingfeedback.sip
@@ -1,72 +1,94 @@
/**
* \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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingfeedback.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/




class QgsProcessingFeedback : QgsFeedback
{
%Docstring
\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
%End

%TypeHeaderCode
#include <qgsprocessingfeedback.h>
#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 );
virtual void setProgressText( const QString &text );
%Docstring
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()
%End

virtual void reportError( const QString &error );
%Docstring
Reports that the algorithm encountered an error which prevented it
from successfully executing.
%End

virtual void pushInfo( const QString &info );
%Docstring
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()
%End

virtual void pushCommandInfo( const QString &info );
%Docstring
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()
%End

virtual void pushDebugInfo( const QString &info );
%Docstring
Pushes an informational message containing debugging helpers from
the algorithm.
@see pushInfo()
@see pushCommandInfo()
@see pushConsoleInfo()
%End

virtual void pushConsoleInfo( const QString &info );
%Docstring
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()
%End

};




/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingfeedback.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
92 changes: 59 additions & 33 deletions python/core/processing/qgsprocessingprovider.sip
@@ -1,56 +1,82 @@
/**
* \class QgsProcessingProvider
* \ingroup core
* Abstract base class for processing providers. An algorithm provider is a set of
* related algorithms, typically from the same external application or related
* to a common area of analysis.
* \note added in QGIS 3.0
*/
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/




class QgsProcessingProvider
{
%Docstring
\class QgsProcessingProvider
\ingroup core
Abstract base class for processing providers. An algorithm provider is a set of
related algorithms, typically from the same external application or related
to a common area of analysis.
\note added in QGIS 3.0
%End

%TypeHeaderCode
#include <qgsprocessingprovider.h>
#include "qgsprocessingprovider.h"
%End

public:

QgsProcessingProvider();
%Docstring
Constructor for QgsProcessingProvider.
%End

virtual ~QgsProcessingProvider();

/**
* Returns an icon for the provider.
* @see svgIcon()
*/

virtual QIcon icon() const;
%Docstring
Returns an icon for the provider.
@see svgIconPath()
%End

/**
* Returns a path to an SVG version of the provider's icon.
* @see icon()
*/
virtual QString svgIconPath() const;
%Docstring
Returns a path to an SVG version of the provider's icon.
@see icon()
%End

/**
* Returns the unique provider id, used for identifying the provider. This string
* should be a unique, short, character only string, eg "qgis" or "gdal". This
* string should not be localised.
* @see name()
*/
virtual QString id() const = 0;
%Docstring
Returns the unique provider id, used for identifying the provider. This string
should be a unique, short, character only string, eg "qgis" or "gdal". This
string should not be localised.
@see name()
%End

/**
* Returns the full provider name, which is used to describe the provider within the GUI.
* This string should be localised.
* @see id()
*/
virtual QString name() const = 0;
%Docstring
Returns the full provider name, which is used to describe the provider within the GUI.
This string should be localised.
@see id()
%End

virtual bool canBeActivated() const;
%Docstring
Returns true if the provider can be activated, or false if it cannot be activated (e.g. due to
missing external dependencies).
%End

private:

//! Providers cannot be copied
QgsProcessingProvider( const QgsProcessingProvider& other );
//! Providers cannot be copied
//QgsProcessingProvider& operator=( const QgsProcessingProvider& other );
QgsProcessingProvider( const QgsProcessingProvider &other );
};



/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/

0 comments on commit f831a3c

Please sign in to comment.