QGIS API Documentation  2.99.0-Master (b698612)
qgsmaplayerproxymodel.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmaplayerproxymodel.h
3  --------------------------------------
4  Date : 01.04.2014
5  Copyright : (C) 2014 Denis Rouzaud
6  Email : [email protected]
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15 
16 #ifndef QGSMAPLAYERPROXYMODEL_H
17 #define QGSMAPLAYERPROXYMODEL_H
18 
19 #include <QSortFilterProxyModel>
20 #include <QStringList>
21 
22 #include "qgis_core.h"
23 #include "qgis.h"
24 
25 class QgsMapLayerModel;
26 class QgsMapLayer;
27 
32 class CORE_EXPORT QgsMapLayerProxyModel : public QSortFilterProxyModel
33 {
34  Q_OBJECT
35  Q_FLAGS( Filters )
36 
37  Q_PROPERTY( QgsMapLayerProxyModel::Filters filters READ filters WRITE setFilters )
38  Q_PROPERTY( QList<QgsMapLayer *> exceptedLayerList READ exceptedLayerList WRITE setExceptedLayerList )
39  Q_PROPERTY( QStringList exceptedLayerIds READ exceptedLayerIds WRITE setExceptedLayerIds )
40 
41  public:
42  enum Filter
43  {
44  RasterLayer = 1,
45  NoGeometry = 2,
46  PointLayer = 4,
47  LineLayer = 8,
48  PolygonLayer = 16,
49  HasGeometry = PointLayer | LineLayer | PolygonLayer,
50  VectorLayer = NoGeometry | HasGeometry,
51  PluginLayer = 32,
52  WritableLayer = 64,
53  All = RasterLayer | VectorLayer | PluginLayer
54  };
55  Q_DECLARE_FLAGS( Filters, Filter )
56 
57 
61  explicit QgsMapLayerProxyModel( QObject *parent SIP_TRANSFERTHIS = nullptr );
62 
66  QgsMapLayerModel *sourceLayerModel() const { return mModel; }
67 
73  QgsMapLayerProxyModel *setFilters( QgsMapLayerProxyModel::Filters filters );
74  const Filters &filters() const { return mFilters; }
75 
77  void setExceptedLayerList( const QList<QgsMapLayer *> &exceptList );
79  QList<QgsMapLayer *> exceptedLayerList() {return mExceptList;}
80 
82  void setExceptedLayerIds( const QStringList &ids );
84  QStringList exceptedLayerIds() const;
85 
91  void setExcludedProviders( const QStringList &providers );
92 
98  QStringList excludedProviders() const { return mExcludedProviders; }
99 
100  bool filterAcceptsRow( int source_row, const QModelIndex &source_parent ) const override;
101  bool lessThan( const QModelIndex &left, const QModelIndex &right ) const override;
102 
103  private:
104  Filters mFilters;
105  QList<QgsMapLayer *> mExceptList;
106  QgsMapLayerModel *mModel = nullptr;
107  QStringList mExcludedProviders;
108 };
109 
110 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapLayerProxyModel::Filters )
111 
112 #endif // QGSMAPLAYERPROXYMODEL_H
Base class for all map layer types.
Definition: qgsmaplayer.h:54
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:34
QList< QgsMapLayer * > exceptedLayerList()
Get the list of maplayers which are excluded from the list.
QStringList excludedProviders() const
Returns the list of data providers which are excluded from the model.
The QgsMapLayerModel class is a model to display layers in widgets.
The QgsMapLayerProxyModel class provides an easy to use model to display the list of layers in widget...
QgsMapLayerModel * sourceLayerModel() const
layerModel returns the QgsMapLayerModel used in this QSortFilterProxyModel
const Filters & filters() const