mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-10 00:13:55 -04:00
78 lines
2.5 KiB
Plaintext
78 lines
2.5 KiB
Plaintext
|
/************************************************************************
|
||
|
|
* This file has been generated automatically from *
|
||
|
|
* *
|
||
|
|
* src/core/processing/qgsprocessingparameterregistry.h *
|
||
|
|
* *
|
||
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
||
|
|
************************************************************************/
|
||
|
|
|
||
|
|
|
||
|
|
class QgsProcessingParameterType
|
||
|
|
{
|
||
|
|
%Docstring
|
||
|
|
Makes metadata of processing parameters available.
|
||
|
|
|
||
|
|
.. versionadded:: 3.2
|
||
|
|
%End
|
||
|
|
|
||
|
|
%TypeHeaderCode
|
||
|
|
#include "qgsprocessingparameterregistry.h"
|
||
|
|
%End
|
||
|
|
public:
|
||
|
|
|
||
|
|
virtual QgsProcessingParameterDefinition *create( const QString &name ) const = 0 /Factory/;
|
||
|
|
%Docstring
|
||
|
|
Creates a new parameter of this type.
|
||
|
|
%End
|
||
|
|
|
||
|
|
virtual QString description() const = 0;
|
||
|
|
%Docstring
|
||
|
|
A human readable and translatable description for this parameter type.
|
||
|
|
This can be a longer description suitable for tooltips and other elements
|
||
|
|
that give the user context for a given parameter.
|
||
|
|
%End
|
||
|
|
|
||
|
|
virtual QString name() const = 0;
|
||
|
|
%Docstring
|
||
|
|
A human readable and translatable short name for this parameter type.
|
||
|
|
This will be used in comboboxes and list widgets.
|
||
|
|
%End
|
||
|
|
|
||
|
|
virtual QString id() const = 0;
|
||
|
|
%Docstring
|
||
|
|
A static id for this type which will be used for storing this parameter type.
|
||
|
|
%End
|
||
|
|
};
|
||
|
|
|
||
|
|
class QgsProcessingParameterTypeRegistry : QObject
|
||
|
|
{
|
||
|
|
|
||
|
|
%TypeHeaderCode
|
||
|
|
#include "qgsprocessingparameterregistry.h"
|
||
|
|
%End
|
||
|
|
public:
|
||
|
|
explicit QgsProcessingParameterTypeRegistry( QObject *parent = 0 );
|
||
|
|
|
||
|
|
void registerParameter( QgsProcessingParameterType *type /Transfer/ );
|
||
|
|
|
||
|
|
void unregisterParameter( QgsProcessingParameterType *type );
|
||
|
|
|
||
|
|
QgsProcessingParameterType *parameterType( const QString &id ) const;
|
||
|
|
|
||
|
|
QList<QgsProcessingParameterType *> parameterTypes() const;
|
||
|
|
|
||
|
|
signals:
|
||
|
|
void parameterRegistered( QgsProcessingParameterType *type );
|
||
|
|
|
||
|
|
void parameterUnregistered( QgsProcessingParameterType *type );
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
/************************************************************************
|
||
|
|
* This file has been generated automatically from *
|
||
|
|
* *
|
||
|
|
* src/core/processing/qgsprocessingparameterregistry.h *
|
||
|
|
* *
|
||
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
||
|
|
************************************************************************/
|