qgslayertreeview.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreeview.h
  --------------------------------------
  Date                 : May 2014
  Copyright            : (C) 2014 by Martin Dobias
  Email                : wonder dot sk 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 QGSLAYERTREEVIEW_H
#define QGSLAYERTREEVIEW_H

#include <QTreeView>

class QgsLayerTreeGroup;
class QgsLayerTreeLayer;
class QgsLayerTreeModel;
class QgsLayerTreeNode;
class QgsLayerTreeModelLegendNode;
class QgsLayerTreeViewDefaultActions;
class QgsLayerTreeViewMenuProvider;
class QgsMapLayer;

class GUI_EXPORT QgsLayerTreeView : public QTreeView
{
    Q_OBJECT
  public:
    explicit QgsLayerTreeView( QWidget *parent = nullptr );
    ~QgsLayerTreeView();

    virtual void setModel( QAbstractItemModel* model ) override;

    QgsLayerTreeModel* layerTreeModel() const;

    QgsLayerTreeViewDefaultActions* defaultActions();

    void setMenuProvider( QgsLayerTreeViewMenuProvider* menuProvider );
    QgsLayerTreeViewMenuProvider* menuProvider() const { return mMenuProvider; }

    QgsMapLayer* currentLayer() const;
    void setCurrentLayer( QgsMapLayer* layer );

    QgsLayerTreeNode* currentNode() const;
    QgsLayerTreeGroup* currentGroupNode() const;

    QgsLayerTreeModelLegendNode* currentLegendNode() const;

    QList<QgsLayerTreeNode*> selectedNodes( bool skipInternal = false ) const;
    QList<QgsLayerTreeLayer*> selectedLayerNodes() const;

    QList<QgsMapLayer*> selectedLayers() const;

  public slots:
    void refreshLayerSymbology( const QString& layerId );

    void expandAllNodes();

    void collapseAllNodes();

  signals:
    void currentLayerChanged( QgsMapLayer* layer );

  protected:
    void contextMenuEvent( QContextMenuEvent* event ) override;

    void updateExpandedStateFromNode( QgsLayerTreeNode* node );

    QgsMapLayer* layerForIndex( const QModelIndex& index ) const;

  protected slots:

    void modelRowsInserted( const QModelIndex& index, int start, int end );
    void modelRowsRemoved();

    void updateExpandedStateToNode( const QModelIndex& index );

    void onCurrentChanged();
    void onExpandedChanged( QgsLayerTreeNode* node, bool expanded );
    void onModelReset();

  protected:
    QgsLayerTreeViewDefaultActions* mDefaultActions;
    QgsLayerTreeViewMenuProvider* mMenuProvider;
    QString mCurrentLayerID;
};


class GUI_EXPORT QgsLayerTreeViewMenuProvider
{
  public:
    virtual ~QgsLayerTreeViewMenuProvider() {}

    virtual QMenu* createContextMenu() = 0;
};


#endif // QGSLAYERTREEVIEW_H