mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-09 00:08:52 -04:00
253 lines
8.7 KiB
Plaintext
253 lines
8.7 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/processing/qgsprocessingparameterdefinitionwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsProcessingAbstractParameterDefinitionWidget : QWidget, QgsExpressionContextGenerator
|
|
{
|
|
%Docstring(signature="appended")
|
|
Abstract base class for widgets which allow users to specify the properties of a
|
|
Processing parameter.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprocessingparameterdefinitionwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsProcessingAbstractParameterDefinitionWidget( QgsProcessingContext &context,
|
|
const QgsProcessingParameterWidgetContext &widgetContext,
|
|
const QgsProcessingParameterDefinition *definition = 0,
|
|
const QgsProcessingAlgorithm *algorithm = 0, QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Creates a new QgsProcessingAbstractParameterDefinitionWidget, with the specified ``parent`` widget.
|
|
|
|
The ``context`` argument must specify a Processing context, which will be used
|
|
by the widget to evaluate existing ``definition`` properties such as default values. Similarly,
|
|
the ``widgetContext`` argument specifies the wider GUI context in which the widget
|
|
will be used.
|
|
|
|
The optional ``definition`` argument may be used to provide a parameter definition to use
|
|
to initially populate the widget's state.
|
|
|
|
Additionally, the optional ``algorithm`` parameter may be used to specify the algorithm or model
|
|
associated with the parameter.
|
|
%End
|
|
|
|
virtual QgsProcessingParameterDefinition *createParameter( const QString &name, const QString &description, Qgis::ProcessingParameterFlags flags ) const = 0 /Factory/;
|
|
%Docstring
|
|
Returns a new instance of a parameter definition, using the current settings defined in the dialog.
|
|
|
|
Common properties for parameters, including the ``name``, ``description``, and parameter ``flags`` are passed to the
|
|
method. Subclass implementations must use these properties when crafting a parameter definition which
|
|
also respects the additional properties specific to the parameter type handled by the widget subclass.
|
|
%End
|
|
|
|
virtual void setWidgetContext( const QgsProcessingParameterWidgetContext &context );
|
|
%Docstring
|
|
Sets the ``context`` in which the Processing definition widget is shown, e.g., the
|
|
parent model algorithm, a linked map canvas, and other relevant information which allows the widget
|
|
to fine-tune its behavior.
|
|
|
|
Subclasses should take care to call the base class method when reimplementing this method.
|
|
|
|
.. seealso:: :py:func:`widgetContext`
|
|
|
|
.. versionadded:: 3.18
|
|
%End
|
|
|
|
const QgsProcessingParameterWidgetContext &widgetContext() const;
|
|
%Docstring
|
|
Returns the context in which the Processing definition widget is shown, e.g., the
|
|
parent model algorithm, a linked map canvas, and other relevant information which allows the widget
|
|
to fine-tune its behavior.
|
|
|
|
.. seealso:: :py:func:`setWidgetContext`
|
|
|
|
.. versionadded:: 3.18
|
|
%End
|
|
|
|
void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
|
|
%Docstring
|
|
Registers a Processing context ``generator`` class that will be used to retrieve
|
|
a Processing context for the widget when required.
|
|
|
|
.. versionadded:: 3.18
|
|
%End
|
|
|
|
virtual QgsExpressionContext createExpressionContext() const;
|
|
|
|
|
|
};
|
|
|
|
|
|
class QgsProcessingParameterDefinitionWidget: QWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
A widget which allow users to specify the properties of a Processing parameter.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprocessingparameterdefinitionwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsProcessingParameterDefinitionWidget( const QString &type,
|
|
QgsProcessingContext &context,
|
|
const QgsProcessingParameterWidgetContext &widgetContext,
|
|
const QgsProcessingParameterDefinition *definition = 0,
|
|
const QgsProcessingAlgorithm *algorithm = 0,
|
|
QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsProcessingParameterDefinitionWidget, for a parameter of the
|
|
specified ``type``.
|
|
|
|
The ``context`` argument must specify a Processing context, which will be used
|
|
by the widget to evaluate existing ``definition`` properties such as default values. Similarly,
|
|
the ``widgetContext`` argument specifies the wider GUI context in which the widget
|
|
will be used.
|
|
|
|
The optional ``definition`` argument may be used to provide a parameter definition to use
|
|
to initially populate the widget's state.
|
|
|
|
Additionally, the optional ``algorithm`` parameter may be used to specify the algorithm or model
|
|
associated with the parameter.
|
|
%End
|
|
|
|
QgsProcessingParameterDefinition *createParameter( const QString &name = QString() ) const /Factory/;
|
|
%Docstring
|
|
Returns a new instance of a parameter definition, using the current settings defined in the dialog.
|
|
|
|
The ``name`` parameter specifies the name for the newly created parameter.
|
|
%End
|
|
|
|
void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
|
|
%Docstring
|
|
Registers a Processing context ``generator`` class that will be used to retrieve
|
|
a Processing context for the widget when required.
|
|
|
|
.. versionadded:: 3.18
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsProcessingParameterDefinitionDialog: QDialog
|
|
{
|
|
%Docstring(signature="appended")
|
|
A dialog which allow users to specify the properties of a Processing parameter.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprocessingparameterdefinitionwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsProcessingParameterDefinitionDialog( const QString &type,
|
|
QgsProcessingContext &context,
|
|
const QgsProcessingParameterWidgetContext &widgetContext,
|
|
const QgsProcessingParameterDefinition *definition = 0,
|
|
const QgsProcessingAlgorithm *algorithm = 0,
|
|
QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsProcessingParameterDefinitionDialog, for a parameter of the
|
|
specified ``type``.
|
|
|
|
The ``context`` argument must specify a Processing context, which will be used
|
|
by the widget to evaluate existing ``definition`` properties such as default values. Similarly,
|
|
the ``widgetContext`` argument specifies the wider GUI context in which the widget
|
|
will be used.
|
|
|
|
The optional ``definition`` argument may be used to provide a parameter definition to use
|
|
to initially populate the dialog's state.
|
|
|
|
Additionally, the optional ``algorithm`` parameter may be used to specify the algorithm or model
|
|
associated with the parameter.
|
|
%End
|
|
|
|
QgsProcessingParameterDefinition *createParameter( const QString &name = QString() ) const /Factory/;
|
|
%Docstring
|
|
Returns a new instance of a parameter definition, using the current settings defined in the dialog.
|
|
|
|
The ``name`` parameter specifies the name for the newly created parameter.
|
|
%End
|
|
|
|
void setComments( const QString &comments );
|
|
%Docstring
|
|
Sets the comments for the parameter.
|
|
|
|
.. seealso:: :py:func:`comments`
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
QString comments() const;
|
|
%Docstring
|
|
Returns the comments for the parameter.
|
|
|
|
.. seealso:: :py:func:`setComments`
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
void setCommentColor( const QColor &color );
|
|
%Docstring
|
|
Sets the color for the comments for the parameter.
|
|
|
|
.. seealso:: :py:func:`commentColor`
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
QColor commentColor() const;
|
|
%Docstring
|
|
Returns the color for the comments for the parameter.
|
|
|
|
.. seealso:: :py:func:`setCommentColor`
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
void switchToCommentTab();
|
|
%Docstring
|
|
Switches the dialog to the comments tab.
|
|
%End
|
|
|
|
void registerProcessingContextGenerator( QgsProcessingContextGenerator *generator );
|
|
%Docstring
|
|
Registers a Processing context ``generator`` class that will be used to retrieve
|
|
a Processing context for the widget when required.
|
|
|
|
.. versionadded:: 3.18
|
|
%End
|
|
|
|
public slots:
|
|
virtual void accept();
|
|
|
|
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/processing/qgsprocessingparameterdefinitionwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|