qgssymbollayermodel.h

Go to the documentation of this file.

/***************************************************************************
    qgssymbollayermodel.h
    ---------------------
    begin                : June 2026
    copyright            : (C) 2026 by Valentin Buira
    email                : valentin dot buira at gmail 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 QGSSYMBOLLAYERMODEL_H
#define QGSSYMBOLLAYERMODEL_H
 
#include <deque>
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsvectorlayer.h"
 
#include <QAbstractItemModel>
 
#define SIP_NO_FILE
 
class QgsSymbolLayerModelNode;
class QgsSymbol;
class QScreen;
class QgsSymbolLayer;
 

class GUI_EXPORT QgsSymbolLayerModelNode
{
  public:
    QgsSymbolLayerModelNode();
    QgsSymbolLayerModelNode( QgsSymbolLayer *layer, Qgis::SymbolType symbolType, QgsVectorLayer *vectorLayer, QScreen *screen );
    QgsSymbolLayerModelNode( QgsSymbol *symbol, QgsVectorLayer *vectorLayer, QScreen *screen );
    ~QgsSymbolLayerModelNode();

    void setLayer( QgsSymbolLayer *layer, Qgis::SymbolType symbolType );

    void setScreen( QScreen *screen );

    bool isLayer() const { return mIsLayer; }

    QIcon icon() const;

    QVariant data( int role ) const;

    QgsSymbol *symbol() { return mSymbol; }

    QgsSymbolLayer *layer() { return mLayer; }

    QgsSymbolLayerModelNode *addChildNode( std::unique_ptr<QgsSymbolLayerModelNode> node );

    QgsSymbolLayerModelNode *insertChildNode( int index, std::unique_ptr<QgsSymbolLayerModelNode> node );

    void moveChildNode( QgsSymbolLayerModelNode *node, int to );

    void removeChildNode( QgsSymbolLayerModelNode *node );

    void deleteChildren();

    QgsSymbolLayerModelNode *parent() { return mParent; }

    bool isRootNode() const { return mParent == nullptr; }

    QgsSymbolLayerModelNode *childAt( int index ) const;

    int indexOf( const QgsSymbolLayerModelNode *node );

    int rowCount() const;

    int rowIndex() const;
 
  private:
    void setSymbol( QgsSymbol *symbol );
 
    QgsSymbolLayer *mLayer = nullptr;
    QgsSymbol *mSymbol = nullptr;
    QPointer<QgsVectorLayer> mVectorLayer;
    bool mIsLayer = false;
    QSize mSize;
    Qgis::SymbolType mSymbolType = Qgis::SymbolType::Hybrid;
    QPointer<QScreen> mScreen;
 
    QgsSymbolLayerModelNode *mParent = nullptr;
    std::deque<std::unique_ptr<QgsSymbolLayerModelNode>> mChildren;
 
    friend class TestQgsSymbolLayerModel;
};

class GUI_EXPORT QgsSymbolLayerModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    QgsSymbolLayerModel( QgsVectorLayer *vl, QObject *parent SIP_TRANSFERTHIS = nullptr, QScreen *screen = nullptr );
 
    QVariant data( const QModelIndex &index, int role ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex & = QModelIndex() ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &child ) const override;

    void updateNode( QgsSymbol *symbol, QgsSymbolLayerModelNode *parent );

    void moveLayerByOffset( QgsSymbolLayerModelNode *node, int offset );

    QgsSymbolLayerModelNode *duplicateLayer( QgsSymbolLayerModelNode *node );

    QgsSymbolLayerModelNode *addLayer( QModelIndex index );

    void removeLayer( QgsSymbolLayerModelNode *node );

    void changeLayer( QgsSymbolLayerModelNode *node, QgsSymbolLayer *newLayer );

    void updatePreview( QgsSymbolLayerModelNode *node );

    void setSymbol( QgsSymbol *symbol );

    void setScreen( QScreen *screen );

    QModelIndex node2index( QgsSymbolLayerModelNode *node ) const;

    QgsSymbolLayerModelNode *index2node( const QModelIndex &index ) const;

    QgsSymbolLayerModelNode *rootNode() const { return mRootNode.get(); }
 
 
  private:
    QModelIndex indexOfParentTreeNode( QgsSymbolLayerModelNode *parentNode ) const;
    void loadSymbol( QgsSymbol *symbol, QgsSymbolLayerModelNode *parent );
    void rebuild();
 
    std::unique_ptr<QgsSymbolLayerModelNode> mRootNode;
 
    QgsSymbol *mSymbol = nullptr;
 
    QPointer<QgsVectorLayer> mVectorLayer;
 
    QPointer<QScreen> mScreen;
 
    friend class TestQgsSymbolLayerModel;
};
 
#endif // QGSSYMBOLLAYERMODEL_H