QGIS/python/core/auto_generated/qgspluginlayer.sip.in

76 lines
2.3 KiB
Plaintext
Raw Normal View History

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgspluginlayer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsPluginLayer : QgsMapLayer
{
2021-03-22 21:13:52 +01:00
%Docstring(signature="appended")
Base class for plugin layers. These can be implemented by plugins
and registered in :py:class:`QgsPluginLayerRegistry`.
In order to be readable from project files, they should set these attributes in layer DOM node:
"type" = "plugin"
"name" = "your_layer_type"
%End
%TypeHeaderCode
#include "qgspluginlayer.h"
%End
public:
QgsPluginLayer( const QString &layerType, const QString &layerName = QString() );
~QgsPluginLayer();
SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsPluginLayer: '%1'>" ).arg( sipCpp->name() );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End
2017-05-17 08:53:52 +02:00
virtual QgsPluginLayer *clone() const = 0;
2017-05-16 13:34:18 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns a new instance equivalent to this one.
:return: a new layer instance
2017-05-16 13:34:18 +02:00
.. versionadded:: 3.0
%End
QString pluginLayerType();
%Docstring
Returns plugin layer type (the same as used in :py:class:`QgsPluginLayerRegistry`)
%End
virtual void setExtent( const QgsRectangle &extent );
%Docstring
Sets extent of the layer
%End
void setSource( const QString &source );
%Docstring
2017-12-15 10:36:55 -04:00
Set source string. This is used for example in layer tree to show tooltip.
.. versionadded:: 2.16
%End
virtual QgsDataProvider *dataProvider();
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgspluginlayer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/