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>
#include "qgis.h"
#include "qgis_gui.h"

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

class GUI_EXPORT QgsLayerTreeView : public QTreeView
{

#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->inherits( "QgsLayerTreeView" ) )
      sipType = sipType_QgsLayerTreeView;
    else
      sipType = 0;
    SIP_END
#endif


    Q_OBJECT
  public:

    explicit QgsLayerTreeView( QWidget *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsLayerTreeView() override;

    void setModel( QAbstractItemModel *model ) override;

    QgsLayerTreeModel *layerTreeModel() const;

    QgsLayerTreeViewDefaultActions *defaultActions();

    void setMenuProvider( QgsLayerTreeViewMenuProvider *menuProvider SIP_TRANSFER );
    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;

    QList<QgsMapLayer *> selectedLayersRecursive() const;

    void addIndicator( QgsLayerTreeNode *node, QgsLayerTreeViewIndicator *indicator );

    void removeIndicator( QgsLayerTreeNode *node, QgsLayerTreeViewIndicator *indicator );

    QList<QgsLayerTreeViewIndicator *> indicators( QgsLayerTreeNode *node ) const;


    static QStringList viewOnlyCustomProperties() SIP_SKIP;

  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;

    void mouseReleaseEvent( QMouseEvent *event ) override;
    void keyPressEvent( QKeyEvent *event ) override;

    void dropEvent( QDropEvent *event ) override;

  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();

  private slots:
    void onCustomPropertyChanged( QgsLayerTreeNode *node, const QString &key );

  protected:
    QgsLayerTreeViewDefaultActions *mDefaultActions = nullptr;
    QgsLayerTreeViewMenuProvider *mMenuProvider = nullptr;
    QString mCurrentLayerID;
    QHash< QgsLayerTreeNode *, QList<QgsLayerTreeViewIndicator *> > mIndicators;
    QPoint mLastReleaseMousePos;

    // friend so it can access viewOptions() method and mLastReleaseMousePos without making them public
    friend class QgsLayerTreeViewItemDelegate;
};


class GUI_EXPORT QgsLayerTreeViewMenuProvider
{
  public:
    virtual ~QgsLayerTreeViewMenuProvider() = default;

    virtual QMenu *createContextMenu() = 0 SIP_FACTORY;
};


#endif // QGSLAYERTREEVIEW_H