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
110
111
112
113
114
115
116
117
118
119
120
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layertree/qgslayertreeembeddedwidgetregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsLayerTreeEmbeddedWidgetProvider
{
%Docstring(signature="appended")
Provider interface to be implemented in order to introduce new kinds of
embedded widgets for use in layer tree. Embedded widgets are assigned
per individual map layers and they are shown before any legend entries.
.. seealso:: :py:class:`QgsLayerTreeEmbeddedWidgetRegistry`
%End
%TypeHeaderCode
#include "qgslayertreeembeddedwidgetregistry.h"
%End
public:
virtual ~QgsLayerTreeEmbeddedWidgetProvider();
virtual QString id() const = 0;
%Docstring
Unique name of the provider (among other providers)
%End
virtual QString name() const = 0;
%Docstring
Human readable name - may be translatable with
:py:func:`~QgsLayerTreeEmbeddedWidgetProvider.tr`
%End
virtual QWidget *createWidget( QgsMapLayer *layer, int widgetIndex ) = 0 /Factory/;
%Docstring
Factory to create widgets. The returned widget is owned by the caller.
The widgetIndex argument may be used to identify which widget is being
created (useful when using multiple widgets from the same provider for
one layer).
%End
virtual bool supportsLayer( QgsMapLayer *layer ) = 0;
%Docstring
Whether it makes sense to use this widget for a particular layer
%End
};
class QgsLayerTreeEmbeddedWidgetRegistry
{
%Docstring(signature="appended")
Registry of widgets that may be embedded into layer tree view. Embedded
widgets are assigned per individual map layers and they are shown before
any legend entries. Layer tree must have UseEmbeddedWidgets flag enabled
in order to show assigned widgets.
:py:class:`QgsLayerTreeEmbeddedWidgetRegistry` is not usually directly
created, but rather accessed through
:py:func:`QgsGui.layerTreeEmbeddedWidgetRegistry()`.
.. seealso:: :py:class:`QgsLayerTreeEmbeddedWidgetRegistry`
%End
%TypeHeaderCode
#include "qgslayertreeembeddedwidgetregistry.h"
%End
public:
QgsLayerTreeEmbeddedWidgetRegistry();
%Docstring
Constructor for QgsLayerTreeEmbeddedWidgetRegistry
QgsLayerTreeEmbeddedWidgetRegistry is not usually directly created, but
rather accessed through
:py:func:`QgsGui.layerTreeEmbeddedWidgetRegistry()`.
%End
~QgsLayerTreeEmbeddedWidgetRegistry();
QStringList providers() const;
%Docstring
Returns list of all registered providers
%End
QgsLayerTreeEmbeddedWidgetProvider *provider( const QString &providerId ) const;
%Docstring
Gets provider object from the provider's ID
%End
bool addProvider( QgsLayerTreeEmbeddedWidgetProvider *provider /Transfer/ );
%Docstring
Register a provider, takes ownership of the object. Returns ``True`` on
success, ``False`` if the provider is already registered.
%End
bool removeProvider( const QString &providerId );
%Docstring
Unregister a provider, the provider object is deleted. Returns ``True``
on success, ``False`` if the provider was not registered.
%End
protected:
private:
QgsLayerTreeEmbeddedWidgetRegistry( const QgsLayerTreeEmbeddedWidgetRegistry &other );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/layertree/qgslayertreeembeddedwidgetregistry.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
