qgsmaskingwidget.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaskingwidget.h
    ---------------------
    begin                : September 2019
    copyright            : (C) 2019 by Hugo Mercier
    email                : hugo dot mercier at oslandia dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSMASKINGWIDGET_H
#define QGSMASKINGWIDGET_H
 
// We don't want to expose this in the public API
#define SIP_NO_FILE
 
 
#include <QPointer>
 
#include "qgspanelwidget.h"
#include "ui_qgsmaskingwidgetbase.h"
#include "qgsstyleentityvisitor.h"
#include "qgis_sip.h"
#include "qgis_gui.h"
 
class QgsMessageBarItem;
 
class GUI_EXPORT QgsMaskingWidget: public QgsPanelWidget, private Ui::QgsMaskingWidgetBase
{
    Q_OBJECT
  public:
    QgsMaskingWidget( QWidget *parent = nullptr );
 
    void setLayer( QgsVectorLayer *layer );
 
    void apply();
 
    bool hasBeenPopulated();
 
  protected:
 
    void showEvent( QShowEvent * ) override;
 
  private slots:
 
    void onSelectionChanged();
 
  private:
    QgsVectorLayer *mLayer = nullptr;
    void populate();
 
    QPointer<QgsMessageBarItem> mMessageBarItem;
    bool mMustPopulate = false;
};
 
 
class SymbolLayerVisitor : public QgsStyleEntityVisitorInterface
{
  public:
    typedef std::function<void( const QgsSymbolLayer *, const QString & )> SymbolLayerCallback;
 
    SymbolLayerVisitor( SymbolLayerCallback callback );
 
    bool visitEnter( const QgsStyleEntityVisitorInterface::Node &node ) override;
 
    void visitSymbol( const QgsSymbol *symbol, const QString &leafIdentifier, QVector<int> rootPath );
 
    bool visit( const QgsStyleEntityVisitorInterface::StyleLeaf &leaf ) override;
 
  private:
    QString mSymbolKey;
    QList<QPair<QgsSymbolLayerId, QList<QgsSymbolLayerReference>>> mMasks;
    SymbolLayerCallback mCallback;
};
 
 
#endif