sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-09 00:04:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove processing sip bindings from sip blacklist

Browse Source
This commit is contained in:
Nyall Dawson 2017-04-02 17:04:47 +10:00
parent bed74fc24a
commit f831a3c1a2
6 changed files with 226 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
python/auto_sip.blacklist
View File

@ -243,9 +243,6 @@ core/layertree/qgslayertreemodellegendnode.sip
core/layertree/qgslayertreenode.sip core/layertree/qgslayertreenode.sip
core/layertree/qgslayertreeregistrybridge.sip core/layertree/qgslayertreeregistrybridge.sip
core/layertree/qgslayertreeutils.sip core/layertree/qgslayertreeutils.sip
core/processing/qgsprocessingfeedback.sip
core/processing/qgsprocessingprovider.sip
core/processing/qgsprocessingregistry.sip
core/raster/qgsbilinearrasterresampler.sip core/raster/qgsbilinearrasterresampler.sip
core/raster/qgsbrightnesscontrastfilter.sip core/raster/qgsbrightnesscontrastfilter.sip
core/raster/qgscliptominmaxenhancement.sip core/raster/qgscliptominmaxenhancement.sip

140
python/core/processing/qgsprocessingfeedback.sip
View File

@ -1,72 +1,94 @@
/** /************************************************************************
* \class QgsProcessingFeedback * This file has been generated automatically from *
* \ingroup core * *
* Base class for providing feedback from a processing algorithm. * src/core/processing/qgsprocessingfeedback.h *
* * *
* This base class implementation silently ignores all feedback reported by algorithms. * Do not edit manually ! Edit header and run scripts/sipify.pl again *
* 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
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 %TypeHeaderCode
#include <qgsprocessingfeedback.h> #include "qgsprocessingfeedback.h"
%End %End
public: public:
/** virtual void setProgressText( const QString &text );
* Sets a progress report text string. This can be used in conjunction with %Docstring
* setProgress() to provide detailed progress reports, such as "Transformed Sets a progress report text string. This can be used in conjunction with
* 4 of 5 layers". setProgress() to provide detailed progress reports, such as "Transformed
* @see setProgress() 4 of 5 layers".
*/ @see setProgress()
virtual void setProgressText( const QString& text ); %End
/** virtual void reportError( const QString &error );
* Reports that the algorithm encountered an error which prevented it %Docstring
* from successfully executing. Reports that the algorithm encountered an error which prevented it
*/ from successfully executing.
virtual void reportError( const QString& error ); %End
/** virtual void pushInfo( const QString &info );
* Pushes a general informational message from the algorithm. This can %Docstring
* be used to report feedback which is neither a status report or an Pushes a general informational message from the algorithm. This can
* error, such as "Found 47 matching features". be used to report feedback which is neither a status report or an
* @see pushCommandInfo() error, such as "Found 47 matching features".
* @see pushDebugInfo() @see pushCommandInfo()
* @see pushConsoleInfo() @see pushDebugInfo()
*/ @see pushConsoleInfo()
virtual void pushInfo( const QString& info ); %End
/** virtual void pushCommandInfo( const QString &info );
* Pushes an informational message containing a command from the algorithm. %Docstring
* This is usually used to report commands which are executed in an external Pushes an informational message containing a command from the algorithm.
* application or as subprocesses. This is usually used to report commands which are executed in an external
* @see pushInfo() application or as subprocesses.
* @see pushDebugInfo() @see pushInfo()
* @see pushConsoleInfo() @see pushDebugInfo()
*/ @see pushConsoleInfo()
virtual void pushCommandInfo( const QString& info ); %End
/** virtual void pushDebugInfo( const QString &info );
* Pushes an informational message containing debugging helpers from %Docstring
* the algorithm. Pushes an informational message containing debugging helpers from
* @see pushInfo() the algorithm.
* @see pushCommandInfo() @see pushInfo()
* @see pushConsoleInfo() @see pushCommandInfo()
*/ @see pushConsoleInfo()
virtual void pushDebugInfo( const QString& info ); %End
virtual void pushConsoleInfo( const QString &info );
/** %Docstring
* Pushes a console feedback message from the algorithm. This is used to Pushes a console feedback message from the algorithm. This is used to
* report the output from executing an external command or subprocess. report the output from executing an external command or subprocess.
* @see pushInfo() @see pushInfo()
* @see pushDebugInfo() @see pushDebugInfo()
* @see pushCommandInfo() @see pushCommandInfo()
*/ %End
virtual void pushConsoleInfo( const QString& info );
}; };
/************************************************************************
* 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
python/core/processing/qgsprocessingprovider.sip
View File

@ -1,56 +1,82 @@
/** /************************************************************************
* \class QgsProcessingProvider * This file has been generated automatically from *
* \ingroup core * *
* Abstract base class for processing providers. An algorithm provider is a set of * src/core/processing/qgsprocessingprovider.h *
* related algorithms, typically from the same external application or related * *
* to a common area of analysis. * Do not edit manually ! Edit header and run scripts/sipify.pl again *
* \note added in QGIS 3.0 ************************************************************************/
*/
class QgsProcessingProvider 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 %TypeHeaderCode
#include <qgsprocessingprovider.h> #include "qgsprocessingprovider.h"
%End %End
public: public:
QgsProcessingProvider(); QgsProcessingProvider();
%Docstring
Constructor for QgsProcessingProvider.
%End
virtual ~QgsProcessingProvider(); virtual ~QgsProcessingProvider();
/**
* Returns an icon for the provider.
* @see svgIcon()
*/
virtual QIcon icon() const; 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; 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; 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; 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; 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: private:
QgsProcessingProvider( const QgsProcessingProvider &other );
//! Providers cannot be copied
QgsProcessingProvider( const QgsProcessingProvider& other );
//! Providers cannot be copied
//QgsProcessingProvider& operator=( 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 *
************************************************************************/

125
python/core/processing/qgsprocessingregistry.sip
View File

@ -1,72 +1,95 @@
/** /************************************************************************
* \class QgsProcessingRegistry * This file has been generated automatically from *
* \ingroup core * *
* Registry for various processing components, including providers, algorithms * src/core/processing/qgsprocessingregistry.h *
* and various parameters and outputs. * *
* * Do not edit manually ! Edit header and run scripts/sipify.pl again *
* QgsProcessingRegistry is not usually directly created, but rather accessed through ************************************************************************/
* QgsApplication::processingRegistry().
* \note added in QGIS 3.0
*/
class QgsProcessingRegistry : QObject class QgsProcessingRegistry : QObject
{ {
%Docstring
\class QgsProcessingRegistry
\ingroup core
Registry for various processing components, including providers, algorithms
and various parameters and outputs.
QgsProcessingRegistry is not usually directly created, but rather accessed through
QgsApplication::processingRegistry().
\note added in QGIS 3.0
%End
%TypeHeaderCode %TypeHeaderCode
#include <qgsprocessingregistry.h> #include "qgsprocessingregistry.h"
%End %End
public: public:
/** QgsProcessingRegistry( QObject *parent /TransferThis/ = 0 );
* Constructor for QgsProcessingRegistry. %Docstring
*/ Constructor for QgsProcessingRegistry.
QgsProcessingRegistry( QObject* parent /TransferThis/ = nullptr ); %End
~QgsProcessingRegistry(); ~QgsProcessingRegistry();
/**
* Get list of available providers.
*/
QList<QgsProcessingProvider*> providers() const;
/** QList<QgsProcessingProvider *> providers() const;
* Add a processing provider to the registry. Ownership of the provider is transferred to the registry. %Docstring
* Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists Get list of available providers.
* in the registry). %End
* @see removeProvider()
*/
bool addProvider( QgsProcessingProvider* provider /Transfer/ );
/** bool addProvider( QgsProcessingProvider *provider /Transfer/ );
* Removes a provider implementation from the registry (the provider object is deleted). %Docstring
* Returns false if the provider could not be removed (eg provider does not exist in the registry). Add a processing provider to the registry. Ownership of the provider is transferred to the registry.
* @see addProvider() Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists
*/ in the registry).
bool removeProvider( QgsProcessingProvider* provider ); @see removeProvider()
%End
/** bool removeProvider( QgsProcessingProvider *provider );
* Removes a provider implementation from the registry (the provider object is deleted). %Docstring
* Returns false if the provider could not be removed (eg provider does not exist in the registry). Removes a provider implementation from the registry (the provider object is deleted).
* @see addProvider() Returns false if the provider could not be removed (eg provider does not exist in the registry).
*/ @see addProvider()
bool removeProvider( const QString& providerId ); %End
/** bool removeProvider( const QString &providerId );
* Returns a matching provider by provider ID. %Docstring
*/ Removes a provider implementation from the registry (the provider object is deleted).
QgsProcessingProvider* providerById( const QString& id ); Returns false if the provider could not be removed (eg provider does not exist in the registry).
@see addProvider()
%End
QgsProcessingProvider *providerById( const QString &id );
%Docstring
Returns a matching provider by provider ID.
%End
signals: signals:
//! Emitted when a provider has been added to the registry. void providerAdded( const QString &id );
void providerAdded( const QString& id ); %Docstring
Emitted when a provider has been added to the registry.
%End
//! Emitted when a provider is removed from the registry void providerRemoved( const QString &id );
void providerRemoved( const QString& id ); %Docstring
Emitted when a provider is removed from the registry
%End
private: private:
QgsProcessingRegistry( const QgsProcessingRegistry &other );
//! Registry cannot be copied
QgsProcessingRegistry( const QgsProcessingRegistry& other );
//! Registry cannot be copied
//QgsProcessingRegistry& operator=( const QgsProcessingRegistry& other );
}; };
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/

5
src/core/processing/qgsprocessingprovider.h
View File

@ -79,6 +79,11 @@ class CORE_EXPORT QgsProcessingProvider
*/ */
virtual bool canBeActivated() const { return true; } virtual bool canBeActivated() const { return true; }
private:
#ifdef SIP_RUN
QgsProcessingProvider( const QgsProcessingProvider &other );
#endif
}; };
#endif // QGSPROCESSINGPROVIDER_H #endif // QGSPROCESSINGPROVIDER_H

9
src/core/processing/qgsprocessingregistry.h
View File

@ -19,6 +19,7 @@
#define QGSPROCESSINGREGISTRY_H #define QGSPROCESSINGREGISTRY_H
#include "qgis_core.h" #include "qgis_core.h"
#include "qgis.h"
#include "qgsprocessingprovider.h" #include "qgsprocessingprovider.h"
#include <QMap> #include <QMap>
@ -41,7 +42,7 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject
/** /**
* Constructor for QgsProcessingRegistry. * Constructor for QgsProcessingRegistry.
*/ */
QgsProcessingRegistry( QObject *parent = nullptr ); QgsProcessingRegistry( QObject *parent SIP_TRANSFERTHIS = nullptr );
~QgsProcessingRegistry(); ~QgsProcessingRegistry();
@ -61,7 +62,7 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject
* in the registry). * in the registry).
* @see removeProvider() * @see removeProvider()
*/ */
bool addProvider( QgsProcessingProvider *provider ); bool addProvider( QgsProcessingProvider *provider SIP_TRANSFER );
/** /**
* Removes a provider implementation from the registry (the provider object is deleted). * Removes a provider implementation from the registry (the provider object is deleted).
@ -94,6 +95,10 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject
//! Map of available providers by id. This class owns the pointers //! Map of available providers by id. This class owns the pointers
QMap<QString, QgsProcessingProvider *> mProviders; QMap<QString, QgsProcessingProvider *> mProviders;
#ifdef SIP_RUN
QgsProcessingRegistry( const QgsProcessingRegistry &other );
#endif
}; };
#endif // QGSPROCESSINGREGISTRY_H #endif // QGSPROCESSINGREGISTRY_H