File: qgspluginlayerregistry.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (109 lines) | stat: -rw-r--r-- 3,086 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgspluginlayerregistry.h                                    *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsPluginLayerType
{
%Docstring(signature="appended")
Class for creating plugin specific layers
%End

%TypeHeaderCode
#include "qgspluginlayerregistry.h"
%End
  public:

    QgsPluginLayerType( const QString &name );
    virtual ~QgsPluginLayerType();

    QString name() const;

    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.
%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(signature="appended")
A registry of plugin layers types.

:py:class:`QgsPluginLayerRegistry` is not usually directly created, but
rather accessed through :py:func:`QgsApplication.pluginLayerRegistry()`.
%End

%TypeHeaderCode
#include "qgspluginlayerregistry.h"
%End
  public:

    QgsPluginLayerRegistry();
    ~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.py again   *
 ************************************************************************/