Merge pull request #4754 from boundlessgeo/browsertree-collapse-backport

[bugfix] Browsertree collapse network provider items

Author: elpaso

python/core/qgsdataitem.sip

@@ -143,7 +143,8 @@ class QgsDataItem : QObject
       NoCapabilities,
       SetCrs,  //!< Can set CRS on layer or group of layers
       Fertile, //!< Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors.
-      Fast     //!< createChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QSettings
+      Fast,    //!< createChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QSettings
+      Collapse //!< The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.)
     };
     typedef QFlags<QgsDataItem::Capability> Capabilities;
 

python/gui/qgsbrowsertreeview.sip

@@ -15,6 +15,10 @@ class QgsBrowserTreeView: QTreeView
     ~QgsBrowserTreeView();
 
     virtual void setModel( QAbstractItemModel* model );
+    //! Set the browser model
+    void setBrowserModel( QgsBrowserModel *model );
+    //! Return the browser model
+    QgsBrowserModel *browserModel( );
     virtual void showEvent( QShowEvent * e );
     virtual void hideEvent( QHideEvent * e );
 

src/app/qgsbrowserdockwidget.cpp

@@ -344,6 +344,7 @@ void QgsBrowserDockWidget::showEvent( QShowEvent * e )
     mProxyModel = new QgsBrowserTreeFilterProxyModel( this );
     mProxyModel->setBrowserModel( mModel );
     mBrowserView->setSettingsSection( objectName().toLower() ); // to distinguish 2 instances ow browser
+    mBrowserView->setBrowserModel( mModel );
     mBrowserView->setModel( mProxyModel );
     // provide a horizontal scroll bar instead of using ellipse (...) for longer items
     mBrowserView->setTextElideMode( Qt::ElideNone );

src/core/qgsdataitem.h

@@ -170,7 +170,8 @@ class CORE_EXPORT QgsDataItem : public QObject
       NoCapabilities = 0,
       SetCrs         = 1 << 0, //!< Can set CRS on layer or group of layers
       Fertile        = 1 << 1, //!< Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors.
-      Fast           = 1 << 2  //!< createChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QSettings
+      Fast           = 1 << 2, //!< createChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QSettings
+      Collapse       = 1 << 3  //!< The collapse/expand status for this items children should be ignored in order to avoid undesired network connections (wms etc.)
     };
     Q_DECLARE_FLAGS( Capabilities, Capability )
 

src/gui/qgsbrowsertreeview.cpp

@@ -24,13 +24,19 @@
 QgsBrowserTreeView::QgsBrowserTreeView( QWidget *parent )
     : QTreeView( parent )
     , mSettingsSection( "browser" )
+    , mBrowserModel( nullptr )
 {
 }
 
 QgsBrowserTreeView::~QgsBrowserTreeView()
 {
 }
 
+void QgsBrowserTreeView::setBrowserModel( QgsBrowserModel *model )
+{
+  mBrowserModel = model;
+}
+
 void QgsBrowserTreeView::setModel( QAbstractItemModel* model )
 {
 
@@ -78,7 +84,26 @@ void QgsBrowserTreeView::restoreState()
     {
       QModelIndex expandIndex = QgsBrowserModel::findPath( model(), path, Qt::MatchStartsWith );
       if ( expandIndex.isValid() )
-        expandIndexSet.insert( expandIndex );
+      {
+        QModelIndex modelIndex = browserModel()->findPath( path, Qt::MatchExactly );
+        if ( modelIndex.isValid() )
+        {
+          QgsDataItem *ptr = browserModel()->dataItem( modelIndex );
+          if ( ptr && ( ptr->capabilities2() & QgsDataItem::Capability::Collapse ) )
+          {
+            QgsDebugMsgLevel( "do not expand index for path " + path, 4 );
+            QModelIndex parentIndex = model()->parent( expandIndex );
+            // Still we need to store the parent in order to expand it
+            if ( parentIndex.isValid() )
+              expandIndexSet.insert( parentIndex );
+          }
+          else
+          {
+            expandIndexSet.insert( expandIndex );
+          }
+        }
+
+      }
       else
       {
         QgsDebugMsg( "index for path " + path + " not found" );

src/gui/qgsbrowsertreeview.h

@@ -18,7 +18,7 @@
 
 #include <QTreeView>
 
-//class QgsBrowserModel;
+class QgsBrowserModel;
 
 /** \ingroup gui
  * The QgsBrowserTreeView class extends QTreeView with save/restore tree state functionality.
@@ -34,6 +34,10 @@ class GUI_EXPORT QgsBrowserTreeView : public QTreeView
     ~QgsBrowserTreeView();
 
     virtual void setModel( QAbstractItemModel* model ) override;
+    //! Set the browser model
+    void setBrowserModel( QgsBrowserModel *model );
+    //! Return the browser model
+    QgsBrowserModel *browserModel( ) { return mBrowserModel; }
     virtual void showEvent( QShowEvent * e ) override;
     virtual void hideEvent( QHideEvent * e ) override;
 
@@ -63,6 +67,9 @@ class GUI_EXPORT QgsBrowserTreeView : public QTreeView
 
     // returns true if expanded from root to item
     bool treeExpanded( const QModelIndex & index );
+
+    // Stores the browser model
+    QgsBrowserModel *mBrowserModel;
 };
 
 #endif // QGSBROWSERTREEVIEW_H

src/providers/arcgisrest/qgsafsdataitems.cpp

@@ -83,6 +83,7 @@ QgsAfsConnectionItem::QgsAfsConnectionItem( QgsDataItem* parent, const QString &
     , mUrl( url )
 {
   mIconName = "mIconConnect.png";
+  mCapabilities |= Collapse;
 }
 
 QVector<QgsDataItem*> QgsAfsConnectionItem::createChildren()

src/providers/arcgisrest/qgsamsdataitems.cpp

@@ -80,6 +80,7 @@ QgsAmsConnectionItem::QgsAmsConnectionItem( QgsDataItem* parent, QString name, Q
     , mUrl( url )
 {
   mIconName = "mIconConnect.png";
+  mCapabilities |= Collapse;
 }
 
 QVector<QgsDataItem*> QgsAmsConnectionItem::createChildren()

src/providers/db2/qgsdb2dataitems.cpp

@@ -36,6 +36,7 @@ QgsDb2ConnectionItem::QgsDb2ConnectionItem( QgsDataItem *parent, const QString n
     : QgsDataCollectionItem( parent, name, path )
 {
   mIconName = "mIconConnect.png";
+  mCapabilities |= Collapse;
   populate();
 }
 

src/providers/mssql/qgsmssqldataitems.cpp

@@ -41,7 +41,7 @@ QgsMssqlConnectionItem::QgsMssqlConnectionItem( QgsDataItem* parent, QString nam
     , mAllowGeometrylessTables( true )
     , mColumnTypeThread( nullptr )
 {
-  mCapabilities |= Fast;
+  mCapabilities |= Fast | Collapse;
   mIconName = "mIconConnect.png";
 }