QGIS/python/gui/auto_generated/processing/qgsprocessingmaplayercombobox.sip.in

114 lines
3.0 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingmaplayercombobox.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProcessingMapLayerComboBox : QWidget
{
%Docstring
Processing map layer combo box.
.. warning::
Not part of stable API and may change in future QGIS releases.
.. versionadded:: 3.8
%End
%TypeHeaderCode
#include "qgsprocessingmaplayercombobox.h"
%End
public:
QgsProcessingMapLayerComboBox( const QgsProcessingParameterDefinition *parameter, QWidget *parent = 0 );
%Docstring
Constructor for QgsProcessingMapLayerComboBox, with the specified ``parameter`` definition.
%End
~QgsProcessingMapLayerComboBox();
void setLayer( QgsMapLayer *layer );
%Docstring
Sets the combo box to the specified ``layer``, if ``layer`` is compatible with the
widget's parameter definition.
%End
QgsMapLayer *currentLayer();
%Docstring
Returns the current layer selected in the combobox, or ``None`` if the selection cannot
be represented as a map layer.
.. warning::
Prefer calling value() instead, as it correctly encapsulates all valid
values which can be represented by the widget.
.. seealso:: :py:func:`currentText`
%End
QString currentText();
%Docstring
Returns the current text of the selected item in the combobox.
.. warning::
Prefer calling value() instead, as it correctly encapsulates all valid
values which can be represented by the widget.
.. seealso:: :py:func:`currentLayer`
%End
void setValue( const QVariant &value, QgsProcessingContext &context );
%Docstring
Sets the ``value`` shown in the widget.
.. seealso:: :py:func:`value`
%End
QVariant value() const;
%Docstring
Returns the current value of the widget.
.. seealso:: :py:func:`setValue`
%End
signals:
void valueChanged();
%Docstring
Emitted whenever the value is changed in the widget.
%End
void triggerFileSelection();
%Docstring
Emitted when the widget has triggered a file selection operation (to be
handled in Python for now).
%End
protected:
virtual void dragEnterEvent( QDragEnterEvent *event );
virtual void dragLeaveEvent( QDragLeaveEvent *event );
virtual void dropEvent( QDropEvent *event );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/processing/qgsprocessingmaplayercombobox.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/