QGIS/python/core/processing/models/qgsprocessingmodelparameter.sip.in

73 lines
2.1 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodelparameter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProcessingModelParameter : QgsProcessingModelComponent
{
%Docstring
Represents an input parameter used by the model.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsprocessingmodelparameter.h"
%End
public:
QgsProcessingModelParameter( const QString &parameterName = QString() );
%Docstring
Constructor for QgsProcessingModelParameter. The parameter name should match one of the
parameters from the parent model.
%End
QString parameterName() const;
%Docstring
Returns the associated parameter name. The parameter name should match one of the
parameters from the parent model.
.. seealso:: :py:func:`parameterName`
%End
void setParameterName( const QString &name );
%Docstring
Sets the associated parameter name. The parameter name should match one of the
parameters from the parent model.
.. seealso:: :py:func:`parameterName`
%End
QVariant toVariant() const;
%Docstring
Saves this parameter to a QVariant.
.. seealso:: :py:func:`loadVariant`
%End
bool loadVariant( const QVariantMap &map );
%Docstring
Loads this parameter from a QVariantMap.
.. seealso:: :py:func:`toVariant`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/processing/models/qgsprocessingmodelparameter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/