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 "qgis.h"
#include "qgis_gui.h"
 
#include <QTreeView>
 
class QgsLayerTreeGroup;
class QgsLayerTreeLayer;
class QgsLayerTreeModel;
class QgsLayerTreeNode;
class QgsLayerTreeModelLegendNode;
class QgsLayerTreeViewDefaultActions;
class QgsLayerTreeViewIndicator;
class QgsLayerTreeViewMenuProvider;
class QgsMapLayer;
class QgsMessageBar;
class QgsLayerTreeFilterProxyModel;
 
 
#include <QSortFilterProxyModel>

class GUI_EXPORT QgsLayerTreeProxyModel : public QSortFilterProxyModel
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsLayerTreeProxyModel *>( sipCpp ) != nullptr )
      sipType = sipType_QgsLayerTreeProxyModel;
    else
      sipType = nullptr;
    SIP_END
#endif
 
    Q_OBJECT
 
  public:

    QgsLayerTreeProxyModel( QgsLayerTreeModel *treeModel, QObject *parent );

    void setFilterText( const QString &filterText = QString() );

    bool showPrivateLayers() const;

    void setShowPrivateLayers( bool showPrivate );

    bool hideValidLayers() const;

    void setHideValidLayers( bool hideValid );
 
  protected:
    bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const override;

    virtual bool nodeShown( QgsLayerTreeNode *node ) const;
 
  private:
    QgsLayerTreeModel *mLayerTreeModel = nullptr;
    QString mFilterText;
    bool mShowPrivateLayers = false;
    bool mHideValidLayers = false;
};
 

class GUI_EXPORT QgsLayerTreeViewBase : public QTreeView
{
    Q_OBJECT
 
  public:
    explicit QgsLayerTreeViewBase( QWidget *parent SIP_TRANSFERTHIS = nullptr );
    ~QgsLayerTreeViewBase() override;
 
    void mouseDoubleClickEvent( QMouseEvent *event ) override;

    void setLayerTreeModel( QgsLayerTreeModel *model );

    QgsLayerTreeModel *layerTreeModel() const;

    QgsLayerTreeNode *index2node( const QModelIndex &index ) const;

    QModelIndex node2index( QgsLayerTreeNode *node ) const;

    QModelIndex node2sourceIndex( QgsLayerTreeNode *node ) const;

    QgsLayerTreeModelLegendNode *index2legendNode( const QModelIndex &index ) const;

    QgsLayerTreeNode *currentNode() const;

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

    QgsMapLayer *currentLayer() const;

    QgsMapLayer *layerForIndex( const QModelIndex &index ) const;

    QgsLayerTreeGroup *currentGroupNode() const;

    QList<QgsLayerTreeLayer *> selectedLayerNodes() const;

    QList<QgsMapLayer *> selectedLayers() const;

    QModelIndex legendNode2index( QgsLayerTreeModelLegendNode *legendNode );

    QModelIndex legendNode2sourceIndex( QgsLayerTreeModelLegendNode *legendNode );

    void setCurrentNode( QgsLayerTreeNode *node );

    void setCurrentLayer( QgsMapLayer *layer );

    QgsLayerTreeModelLegendNode *currentLegendNode() const;

    QList<QgsLayerTreeModelLegendNode *> selectedLegendNodes() const;

    QList<QgsMapLayer *> selectedLayersRecursive() const;

    QgsLayerTreeViewDefaultActions *defaultActions();
 
  public slots:

    void expandAllNodes();

    void collapseAllNodes();
 
  protected:

    void updateExpandedStateFromNode( QgsLayerTreeNode *node );

    QModelIndex viewIndexToLayerTreeModelIndex( const QModelIndex &index ) const;

    QModelIndex layerTreeModelIndexToViewIndex( const QModelIndex &index ) const;

    QgsLayerTreeViewDefaultActions *mDefaultActions = nullptr;
 
  protected slots:

    void updateExpandedStateToNode( const QModelIndex &index );

    void onExpandedChanged( QgsLayerTreeNode *node, bool expanded );

    void onModelReset();
 
  private slots:
 
    void onDataChanged( const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles );
 
  private:
    QgsLayerTreeModel *mLayerTreeModel = nullptr;
    QTimer *mBlockDoubleClickTimer = nullptr;
};
 

class GUI_EXPORT QgsLayerTreeView : public QgsLayerTreeViewBase
{
#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;

    void setModel( QgsLayerTreeModel *model, QgsLayerTreeProxyModel *proxyModel );

    QgsLayerTreeProxyModel *proxyModel() const;

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

    void setLayerVisible( QgsMapLayer *layer, bool visible );

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

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

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

    int layerMarkWidth() const { return mLayerMarkWidth; }


    static QStringList viewOnlyCustomProperties() SIP_SKIP;


    bool showPrivateLayers() const;

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

    void setLayerMarkWidth( int width ) { mLayerMarkWidth = width; }

    void setMessageBar( QgsMessageBar *messageBar );

    void setShowPrivateLayers( bool showPrivate );

    void setHideValidLayers( bool hideValid );
 
  signals:
    void currentLayerChanged( QgsMapLayer *layer );

    void datasetsDropped( QDropEvent *event );

    void contextMenuAboutToShow( QMenu *menu );
 
  protected:
    void contextMenuEvent( QContextMenuEvent *event ) override;
 
    void mouseReleaseEvent( QMouseEvent *event ) override;
    void keyPressEvent( QKeyEvent *event ) override;
 
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dragMoveEvent( QDragMoveEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
 
    void resizeEvent( QResizeEvent *event ) override;
 
  protected slots:
 
    void modelRowsInserted( const QModelIndex &index, int start, int end );
    void modelRowsRemoved();
 
    void onCurrentChanged();
 
  private slots:
    void onCustomPropertyChanged( QgsLayerTreeNode *node, const QString &key );
    void onHorizontalScroll( int value );
 
    void onDataChanged( const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles );
 
  protected:
    QgsLayerTreeViewMenuProvider *mMenuProvider = nullptr;
    QString mCurrentLayerID;
    QHash<QgsLayerTreeNode *, QList<QgsLayerTreeViewIndicator *>> mIndicators;
    QPoint mLastReleaseMousePos;

    int mLayerMarkWidth;
 
  private:
    QgsLayerTreeProxyModel *mProxyModel = nullptr;
 
    QgsMessageBar *mMessageBar = nullptr;
 
    bool mShowPrivateLayers = false;
    bool mHideValidLayers = false;
 
    // For model  debugging
    // void checkModel( );
 
    // 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