QGIS/python/core/auto_generated/processing/qgsprocessingparameterfieldmap.sip.in

108 lines
3.2 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingparameterfieldmap.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProcessingParameterFieldMapping : QgsProcessingParameterDefinition
{
%Docstring
.. note::
This class is not a part of public API.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsprocessingparameterfieldmap.h"
%End
public:
QgsProcessingParameterFieldMapping( const QString &name, const QString &description = QString(), const QString &parentLayerParameterName = QString() );
%Docstring
Constructor for QgsProcessingParameterFieldMapping.
%End
virtual QgsProcessingParameterDefinition *clone() const;
virtual QString type() const;
virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context ) const;
virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const;
virtual QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const;
virtual QVariantMap toVariantMap() const;
virtual bool fromVariantMap( const QVariantMap &map );
static QString typeName();
%Docstring
Returns the type name for the parameter class.
%End
QString parentLayerParameterName() const;
%Docstring
Returns the name of the parent layer parameter, or an empty string if this is not set.
.. seealso:: :py:func:`setParentLayerParameterName`
%End
void setParentLayerParameterName( const QString &name );
%Docstring
Sets the ``name`` of the parent layer parameter. Use an empty string if this is not required.
.. seealso:: :py:func:`parentLayerParameterName`
%End
};
class QgsProcessingParameterTypeFieldMapping : QgsProcessingParameterType
{
%Docstring
Parameter type definition for QgsProcessingParameterFieldMapping.
.. note::
This class is not a part of public API.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsprocessingparameterfieldmap.h"
%End
public:
virtual QgsProcessingParameterDefinition *create( const QString &name ) const /Factory/;
virtual QString description() const;
virtual QString name() const;
virtual QString id() const;
virtual QString pythonImportString() const;
virtual QString className() const;
virtual QStringList acceptedPythonTypes() const;
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/qgsprocessingparameterfieldmap.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/