mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-26 00:02:08 -05:00
107b48a430
For the c++ api dox this expands to "\c nullptr" (the \c directive indicates a code literal value), and for sipify/Python it expands to ``None`` (`` is sphinx annotation for literal values) Makes for nicer dox for both c++ and Python!
112 lines
3.0 KiB
Plaintext
112 lines
3.0 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgspluginlayerregistry.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsPluginLayerType
|
|
{
|
|
%Docstring
|
|
class for creating plugin specific layers
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgspluginlayerregistry.h"
|
|
%End
|
|
public:
|
|
|
|
QgsPluginLayerType( const QString &name );
|
|
virtual ~QgsPluginLayerType();
|
|
|
|
QString name();
|
|
|
|
virtual QgsPluginLayer *createLayer() /Factory/;
|
|
%Docstring
|
|
Returns new layer of this type. Return ``None`` on error
|
|
%End
|
|
|
|
virtual QgsPluginLayer *createLayer( const QString &uri ) /Factory/;
|
|
%Docstring
|
|
Returns new layer of this type, using layer URI (specific to this plugin layer type). Return ``None`` on error.
|
|
|
|
.. versionadded:: 2.10
|
|
%End
|
|
|
|
virtual bool showLayerProperties( QgsPluginLayer *layer );
|
|
%Docstring
|
|
Show plugin layer properties dialog. Return ``False`` if the dialog cannot be shown.
|
|
%End
|
|
|
|
protected:
|
|
};
|
|
|
|
|
|
class QgsPluginLayerRegistry
|
|
{
|
|
%Docstring
|
|
A registry of plugin layers types.
|
|
|
|
QgsPluginLayerRegistry is not usually directly created, but rather accessed through
|
|
:py:func:`QgsApplication.pluginLayerRegistry()`
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgspluginlayerregistry.h"
|
|
%End
|
|
public:
|
|
|
|
QgsPluginLayerRegistry();
|
|
%Docstring
|
|
Constructor for QgsPluginLayerRegistry.
|
|
%End
|
|
~QgsPluginLayerRegistry();
|
|
|
|
|
|
QStringList pluginLayerTypes();
|
|
%Docstring
|
|
List all known layer types
|
|
%End
|
|
|
|
bool addPluginLayerType( QgsPluginLayerType *pluginLayerType /Transfer/ );
|
|
%Docstring
|
|
Add plugin layer type (take ownership) and return ``True`` on success
|
|
%End
|
|
|
|
bool removePluginLayerType( const QString &typeName );
|
|
%Docstring
|
|
Remove plugin layer type and return ``True`` on success
|
|
%End
|
|
|
|
QgsPluginLayerType *pluginLayerType( const QString &typeName );
|
|
%Docstring
|
|
Returns plugin layer type metadata or ``None`` if doesn't exist
|
|
%End
|
|
|
|
QgsPluginLayer *createLayer( const QString &typeName, const QString &uri = QString() ) /Factory/;
|
|
%Docstring
|
|
Returns new layer if corresponding plugin has been found else returns ``None``.
|
|
|
|
.. note::
|
|
|
|
parameter uri has been added in QGIS 2.10
|
|
%End
|
|
|
|
private:
|
|
QgsPluginLayerRegistry( const QgsPluginLayerRegistry &rh );
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgspluginlayerregistry.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|