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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmaplayerproxymodel.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsMapLayerProxyModel : QSortFilterProxyModel
{
%Docstring(signature="appended")
The :py:class:`QgsMapLayerProxyModel` class provides an easy to use
model to display the list of layers in widgets.
%End
%TypeHeaderCode
#include "qgsmaplayerproxymodel.h"
%End
public:
explicit QgsMapLayerProxyModel( QObject *parent /TransferThis/ = 0 );
%Docstring
:py:class:`QgsMapLayerProxModel` creates a proxy model with a
:py:class:`QgsMapLayerModel` as source model. It can be used to filter
the layers list in a widget.
%End
QgsMapLayerModel *sourceLayerModel() const;
%Docstring
layerModel returns the :py:class:`QgsMapLayerModel` used in this
QSortFilterProxyModel
%End
QgsMapLayerProxyModel *setFilters( Qgis::LayerFilters filters );
%Docstring
Sets ``filter`` flags which affect how layers are filtered within the
model.
.. seealso:: :py:func:`filters`
%End
void setFilters( int filters ) /Deprecated/;
%Docstring
Filters according to layer type and/or geometry type.
.. note::
for API compatibility
.. versionadded:: 3.34
.. deprecated:: 3.34
Use the flag signature instead.
%End
const Qgis::LayerFilters &filters() const;
%Docstring
Returns the filter flags which affect how layers are filtered within the
model.
.. seealso:: :py:func:`setFilters`
%End
void setProject( QgsProject *project );
%Docstring
Sets the ``project`` from which map layers are shown.
If ``project`` is ``None`` then :py:func:`QgsProject.instance()` will be
used.
.. versionadded:: 3.24
%End
static bool layerMatchesFilters( const QgsMapLayer *layer, const Qgis::LayerFilters &filters );
%Docstring
Returns if the ``layer`` matches the given ``filters``
.. versionadded:: 3.14
%End
void setLayerWhitelist( const QList<QgsMapLayer *> &layers ) /Deprecated/;
%Docstring
Sets an allowlist of ``layers`` to include within the model. Only layers
from this list will be shown.
An empty list indicates that no filter by allowlist should be performed.
.. seealso:: :py:func:`layerAllowlist`
.. seealso:: :py:func:`setExceptedLayerList`
.. deprecated:: 3.40
Use :py:func:`~QgsMapLayerProxyModel.setLayerAllowList`.
%End
void setLayerAllowlist( const QList<QgsMapLayer *> &layers );
%Docstring
Sets an allowlist of ``layers`` to include within the model. Only layers
from this list will be shown.
An empty list indicates that no filter by allowlist should be performed.
.. seealso:: :py:func:`layerAllowlist`
.. seealso:: :py:func:`setExceptedLayerList`
.. versionadded:: 3.14
%End
QList<QgsMapLayer *> layerWhitelist() /Deprecated/;
%Docstring
Returns the list of layers which are excluded from the model.
An empty list indicates that no filtering by allowlist should be
performed.
.. seealso:: :py:func:`setLayerAllowlist`
.. seealso:: :py:func:`exceptedLayerList`
.. deprecated:: 3.40
Use :py:func:`~QgsMapLayerProxyModel.layerAllowlist` instead.
%End
QList<QgsMapLayer *> layerAllowlist();
%Docstring
Returns the list of layers which are excluded from the model.
An empty list indicates that no filtering by allowlist should be
performed.
.. seealso:: :py:func:`setLayerAllowlist`
.. seealso:: :py:func:`exceptedLayerList`
.. versionadded:: 3.14
%End
void setExceptedLayerList( const QList<QgsMapLayer *> &exceptList );
%Docstring
Sets a blocklist of layers to exclude from the model.
.. seealso:: :py:func:`exceptedLayerList`
.. seealso:: :py:func:`setExceptedLayerIds`
.. seealso:: :py:func:`setLayerAllowlist`
%End
QList<QgsMapLayer *> exceptedLayerList();
%Docstring
Returns the blocklist of layers which are excluded from the model.
.. seealso:: :py:func:`setExceptedLayerList`
.. seealso:: :py:func:`exceptedLayerIds`
.. seealso:: :py:func:`layerAllowlist`
%End
void setExceptedLayerIds( const QStringList &ids );
%Docstring
Sets a blocklist of layers (by layer ID) to exclude from the model.
.. seealso:: :py:func:`exceptedLayerIds`
.. seealso:: :py:func:`setExceptedLayerList`
%End
QStringList exceptedLayerIds() const;
%Docstring
Returns the blocklist of layer IDs which are excluded from the model.
.. seealso:: :py:func:`setExceptedLayerIds`
.. seealso:: :py:func:`exceptedLayerList`
%End
void setExcludedProviders( const QStringList &providers );
%Docstring
Sets a blocklist of data providers which should be excluded from the
model.
.. seealso:: :py:func:`excludedProviders`
%End
QStringList excludedProviders() const;
%Docstring
Returns the blocklist of data providers which are excluded from the
model.
.. seealso:: :py:func:`setExcludedProviders`
%End
QString filterString() const;
%Docstring
Returns the current filter string, if set.
.. seealso:: :py:func:`setFilterString`
.. versionadded:: 3.4
%End
bool acceptsLayer( QgsMapLayer *layer ) const;
%Docstring
Returns ``True`` if the proxy model accepts the specified map ``layer``.
.. versionadded:: 3.8
%End
virtual bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const;
virtual bool lessThan( const QModelIndex &left, const QModelIndex &right ) const;
public slots:
void setFilterString( const QString &filter );
%Docstring
Sets a ``filter`` string, such that only layers with names matching the
specified string will be shown.
.. seealso:: :py:func:`filterString`
.. versionadded:: 3.4
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmaplayerproxymodel.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
