QGIS/python/gui/auto_generated/qgsrelationconfigwidget.sip.in
2020-12-30 04:46:51 +02:00

78 lines
2.3 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsrelationconfigwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsRelationConfigWidget : QWidget
{
%Docstring
This class should be subclassed for every configurable relation widget type.
It implements the GUI configuration widget and transforms this to/from a configuration.
It will only be instantiated by {:py:class:`QgsRelationWidgetFactory`}
.. versionadded:: 3.18
%End
%TypeHeaderCode
#include "qgsrelationconfigwidget.h"
%End
public:
explicit QgsRelationConfigWidget( const QgsRelation &relation, QWidget *parent /TransferThis/ );
%Docstring
Create a new configuration widget
:param relation: The relation for which the configuration dialog will be created
:param parent: A parent widget
%End
virtual QVariantMap config() = 0;
%Docstring
Create a configuration from the current GUI state
:return: A widget configuration
%End
virtual void setConfig( const QVariantMap &config ) = 0;
%Docstring
Update the configuration widget to represent the given configuration.
:param config: The configuration which should be represented by this widget
%End
QgsVectorLayer *layer();
%Docstring
Returns the layer for which this configuration widget applies
:return: The layer
%End
QgsRelation relation() const;
%Docstring
Returns the relation for which this configuration widget applies
:return: The relation
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsrelationconfigwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/