Treeview fixes (backport):

[dolphin.git] / src / treeviewsidebarpage.cpp

diff --git a/src/treeviewsidebarpage.cpp b/src/treeviewsidebarpage.cpp
index d2e469945ae1749ec0ac58c2ee62256d731cac00..3196fe7bd77395e8ee03d8405db8103aecbce3c4 100644 (file)
--- a/src/treeviewsidebarpage.cpp
+++ b/src/treeviewsidebarpage.cpp
@@ -19,64 +19,45 @@
 
 #include "treeviewsidebarpage.h"
 
 
 #include "treeviewsidebarpage.h"
 

-#include "dolphinmainwindow.h"
+#include "dolphinmodel.h"

 #include "dolphinsortfilterproxymodel.h"
 #include "dolphinview.h"
 #include "dolphinsortfilterproxymodel.h"
 #include "dolphinview.h"

+#include "dolphinsettings.h"

 #include "sidebartreeview.h"
 #include "treeviewcontextmenu.h"
 
 #include <kfileplacesmodel.h>
 #include <kdirlister.h>
 #include "sidebartreeview.h"
 #include "treeviewcontextmenu.h"
 
 #include <kfileplacesmodel.h>
 #include <kdirlister.h>

-#include <kdirmodel.h>

 #include <kfileitem.h>
 
 #include <kfileitem.h>
 

-#include <QHeaderView>
-#include <QItemSelectionModel>
+#include <QItemSelection>

 #include <QTreeView>
 #include <QTreeView>

-#include <QVBoxLayout>
-#include "dolphinsettings.h"
+#include <QBoxLayout>
+#include <QModelIndex>

 
 TreeViewSidebarPage::TreeViewSidebarPage(QWidget* parent) :
     SidebarPage(parent),
 
 TreeViewSidebarPage::TreeViewSidebarPage(QWidget* parent) :
     SidebarPage(parent),

+    m_setLeafVisible(false),

     m_dirLister(0),
     m_dirLister(0),

-    m_dirModel(0),
+    m_dolphinModel(0),

     m_proxyModel(0),
     m_proxyModel(0),

-    m_treeView(0)
+    m_treeView(0),
+    m_leafDir()

 {
 {

-    m_dirLister = new KDirLister();
-    m_dirLister->setDirOnlyMode(true);
-    m_dirLister->setAutoUpdate(true);
-    m_dirLister->setMainWindow(this);
-    m_dirLister->setDelayedMimeTypes(true);
-    m_dirLister->setAutoErrorHandlingEnabled(false, this);
-
-    m_dirModel = new KDirModel();
-    m_dirModel->setDirLister(m_dirLister);
-    m_dirModel->setDropsAllowed(KDirModel::DropOnDirectory);
-
-    m_proxyModel = new DolphinSortFilterProxyModel(this);
-    m_proxyModel->setSourceModel(m_dirModel);
-
-    m_treeView = new SidebarTreeView(this);
-    m_treeView->setModel(m_proxyModel);
-
-    m_proxyModel->setSorting(DolphinView::SortByName);
-    m_proxyModel->setSortOrder(Qt::AscendingOrder);
-
-    connect(m_treeView, SIGNAL(clicked(const QModelIndex&)),
-            this, SLOT(updateActiveView(const QModelIndex&)));
-    connect(m_treeView, SIGNAL(urlsDropped(const KUrl::List&, const QModelIndex&)),
-            this, SLOT(dropUrls(const KUrl::List&, const QModelIndex&)));
-
-    QVBoxLayout* layout = new QVBoxLayout(this);
-    layout->setMargin(0);
-    layout->addWidget(m_treeView);

 }
 
 TreeViewSidebarPage::~TreeViewSidebarPage()
 {
 }
 
 TreeViewSidebarPage::~TreeViewSidebarPage()
 {

-    delete m_dirLister;
-    m_dirLister = 0;
+    delete m_proxyModel;
+    m_proxyModel = 0;
+    delete m_dolphinModel;
+    m_dolphinModel = 0;
+    m_dirLister = 0; // deleted by m_dolphinModel
+}
+
+QSize TreeViewSidebarPage::sizeHint() const
+{
+    return QSize(200, 400);

 }
 
 void TreeViewSidebarPage::setUrl(const KUrl& url)
 }
 
 void TreeViewSidebarPage::setUrl(const KUrl& url)


@@ -86,49 +67,61 @@ void TreeViewSidebarPage::setUrl(const KUrl& url)
     }
 
     SidebarPage::setUrl(url);
     }
 
     SidebarPage::setUrl(url);

-
-    // adjust the root of the tree to the base bookmark
-    KFilePlacesModel* placesModel = DolphinSettings::instance().placesModel();
-    KUrl baseUrl = placesModel->url(placesModel->closestItem(url));
-    if (!baseUrl.isValid()) {
-        // it's possible that no closest item is available and hence an
-        // empty URL is returned
-        baseUrl = url;
+    if (m_dirLister != 0) {
+        m_setLeafVisible = true;
+        loadTree(url);

     }
     }

+}

 
 

-    if (m_dirLister->url() != baseUrl) {
-        m_dirLister->stop();
-        m_dirLister->openUrl(baseUrl);
+void TreeViewSidebarPage::showEvent(QShowEvent* event)
+{
+    if (event->spontaneous()) {
+        SidebarPage::showEvent(event);
+        return;

     }
 
     }
 

-    // select the folder which contains the given URL
-    QItemSelectionModel* selModel = m_treeView->selectionModel();
-    selModel->clearSelection();
+    if (m_dirLister == 0) {
+        // Postpone the creating of the dir lister to the first show event.
+        // This assures that no performance and memory overhead is given when the TreeView is not
+        // used at all (see TreeViewSidebarPage::setUrl()).
+        m_dirLister = new KDirLister();
+        m_dirLister->setDirOnlyMode(true);
+        m_dirLister->setAutoUpdate(true);
+        m_dirLister->setMainWindow(this);
+        m_dirLister->setDelayedMimeTypes(true);
+        m_dirLister->setAutoErrorHandlingEnabled(false, this);

 
 

-    const QModelIndex index = m_dirModel->indexForUrl(url);
-    if (index.isValid()) {
-        // the item with the given URL is already part of the model
-        const QModelIndex proxyIndex = m_proxyModel->mapFromSource(index);
-        m_treeView->scrollTo(proxyIndex);
-        selModel->setCurrentIndex(proxyIndex, QItemSelectionModel::Select);
-    } else {
-        // The item with the given URL is not loaded by the model yet. Iterate
-        // backward to the base URL and trigger the loading of the items for
-        // each hierarchy level.

         connect(m_dirLister, SIGNAL(completed()),
         connect(m_dirLister, SIGNAL(completed()),

-                this, SLOT(expandSelectionParent()));
-
-        KUrl parentUrl = url.upUrl();
-        while (!parentUrl.isParentOf(baseUrl)) {
-            m_dirLister->openUrl(parentUrl, true, false);
-            parentUrl = parentUrl.upUrl();
-        }
+                this, SLOT(triggerLoadSubTree()));
+
+        Q_ASSERT(m_dolphinModel == 0);
+        m_dolphinModel = new DolphinModel(this);
+        m_dolphinModel->setDirLister(m_dirLister);
+        m_dolphinModel->setDropsAllowed(DolphinModel::DropOnDirectory);
+        connect(m_dolphinModel, SIGNAL(expand(const QModelIndex&)),
+                this, SLOT(triggerExpanding()));
+
+        Q_ASSERT(m_proxyModel == 0);
+        m_proxyModel = new DolphinSortFilterProxyModel(this);
+        m_proxyModel->setSourceModel(m_dolphinModel);
+
+        Q_ASSERT(m_treeView == 0);
+        m_treeView = new SidebarTreeView(this);
+        m_treeView->setModel(m_proxyModel);
+        m_proxyModel->setSorting(DolphinView::SortByName);
+        m_proxyModel->setSortOrder(Qt::AscendingOrder);
+
+        connect(m_treeView, SIGNAL(clicked(const QModelIndex&)),
+                this, SLOT(updateActiveView(const QModelIndex&)));
+        connect(m_treeView, SIGNAL(urlsDropped(const KUrl::List&, const QModelIndex&)),
+                this, SLOT(dropUrls(const KUrl::List&, const QModelIndex&)));
+
+        QVBoxLayout* layout = new QVBoxLayout(this);
+        layout->setMargin(0);
+        layout->addWidget(m_treeView);

     }
 
     }
 

-}
-
-void TreeViewSidebarPage::showEvent(QShowEvent* event)
-{
+    loadTree(url());

     SidebarPage::showEvent(event);
 }
 
     SidebarPage::showEvent(event);
 }
 


@@ -142,63 +135,123 @@ void TreeViewSidebarPage::contextMenuEvent(QContextMenuEvent* event)
         return;
     }
 
         return;
     }
 

-    const QModelIndex dirModelIndex = m_proxyModel->mapToSource(index);
-    KFileItem* item = m_dirModel->itemForIndex(dirModelIndex);
+    const QModelIndex dolphinModelIndex = m_proxyModel->mapToSource(index);
+    KFileItem item = m_dolphinModel->itemForIndex(dolphinModelIndex);

 
     emit changeSelection(KFileItemList());
     TreeViewContextMenu contextMenu(this, item);
     contextMenu.open();
 }
 
 
     emit changeSelection(KFileItemList());
     TreeViewContextMenu contextMenu(this, item);
     contextMenu.open();
 }
 

-void TreeViewSidebarPage::expandSelectionParent()
+void TreeViewSidebarPage::updateActiveView(const QModelIndex& index)

 {
 {

-    disconnect(m_dirLister, SIGNAL(completed()),
-               this, SLOT(expandSelectionParent()));
+    const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
+    const KFileItem item = m_dolphinModel->itemForIndex(dirIndex);
+    if (!item.isNull()) {
+        emit changeUrl(item.url());
+    }
+}

 
 

-    // expand the parent folder of the selected item
-    KUrl parentUrl = url().upUrl();
-    if (!m_dirLister->url().isParentOf(parentUrl)) {
+void TreeViewSidebarPage::dropUrls(const KUrl::List& urls,
+                                   const QModelIndex& index)
+{
+    if (index.isValid()) {
+        const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
+        KFileItem item = m_dolphinModel->itemForIndex(dirIndex);
+        Q_ASSERT(!item.isNull());
+        if (item.isDir()) {
+            emit urlsDropped(urls, item.url());
+        }
+    }
+}
+
+void TreeViewSidebarPage::triggerExpanding()
+{
+    // the expanding of the folders may not be done in the context
+    // of this slot
+    QMetaObject::invokeMethod(this, "expandToLeafDir", Qt::QueuedConnection);
+}
+
+void TreeViewSidebarPage::triggerLoadSubTree()
+{
+    // the loading of the sub tree may not be done in the context
+    // of this slot
+    QMetaObject::invokeMethod(this, "loadSubTree", Qt::QueuedConnection);
+}
+
+void TreeViewSidebarPage::expandToLeafDir()
+{
+    // expand all directories until the parent directory of m_leafDir
+    const KUrl parentUrl = m_leafDir.upUrl();
+    QModelIndex dirIndex = m_dolphinModel->indexForUrl(parentUrl);
+    QModelIndex proxyIndex = m_proxyModel->mapFromSource(dirIndex);
+    m_treeView->setExpanded(proxyIndex, true);
+    selectLeafDirectory();
+}
+
+
+void TreeViewSidebarPage::loadSubTree()
+{
+    m_treeView->selectionModel()->clearSelection();
+
+    if (m_leafDir.isParentOf(m_dirLister->url())) {
+        // The leaf directory is not a child of the base URL, hence
+        // no sub directory must be loaded or selected.

         return;
     }
 
         return;
     }
 

-    QModelIndex index = m_dirModel->indexForUrl(parentUrl);
+    const QModelIndex index = m_dolphinModel->indexForUrl(m_leafDir);

     if (index.isValid()) {
     if (index.isValid()) {

-        QModelIndex proxyIndex = m_proxyModel->mapFromSource(index);
-        m_treeView->setExpanded(proxyIndex, true);
+        selectLeafDirectory();
+    } else {
+        // Load all sub directories that need to get expanded for making
+        // the leaf directory visible. The slot triggerExpanding() will
+        // get invoked if the expanding has been finished.
+        m_dolphinModel->expandToUrl(m_leafDir);
+    }
+}

 
 

-        // select the item and assure that the item is visible
-        index = m_dirModel->indexForUrl(url());
-        if (index.isValid()) {
-            proxyIndex = m_proxyModel->mapFromSource(index);
-            m_treeView->scrollTo(proxyIndex);
+void TreeViewSidebarPage::loadTree(const KUrl& url)
+{
+    Q_ASSERT(m_dirLister != 0);
+    m_leafDir = url;

 
 

-            QItemSelectionModel* selModel = m_treeView->selectionModel();
-            selModel->setCurrentIndex(proxyIndex, QItemSelectionModel::Select);
+    // adjust the root of the tree to the base place
+    KFilePlacesModel* placesModel = DolphinSettings::instance().placesModel();
+    KUrl baseUrl = placesModel->url(placesModel->closestItem(url));
+    if (!baseUrl.isValid()) {
+        // it's possible that no closest item is available and hence an
+        // empty URL is returned
+        if (url.isLocalFile()) {
+            // use the root directory as base for local URLs
+            baseUrl = KUrl("file:///");
+        } else {
+            // clear the path for non-local URLs and use it as base
+            baseUrl = url;
+            baseUrl.setPath(QString());

         }
     }
         }
     }

-}

 
 

-void TreeViewSidebarPage::updateActiveView(const QModelIndex& index)
-{
-    const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
-    const KFileItem* item = m_dirModel->itemForIndex(dirIndex);
-    if (item != 0) {
-        const KUrl& url = item->url();
-        emit changeUrl(url);
+    if (m_dirLister->url() != baseUrl) {
+        m_dirLister->stop();
+        m_dirLister->openUrl(baseUrl, KDirLister::Reload);
+    } else {
+        loadSubTree();

     }
 }
 
     }
 }
 

-void TreeViewSidebarPage::dropUrls(const KUrl::List& urls,
-                                   const QModelIndex& index)
+void TreeViewSidebarPage::selectLeafDirectory()

 {
 {

-    if (index.isValid()) {
-        const QModelIndex dirIndex = m_proxyModel->mapToSource(index);
-        KFileItem* item = m_dirModel->itemForIndex(dirIndex);
-        Q_ASSERT(item != 0);
-        if (item->isDir()) {
-            emit urlsDropped(urls, item->url());
-        }
+    const QModelIndex dirIndex = m_dolphinModel->indexForUrl(m_leafDir);
+    const QModelIndex proxyIndex = m_proxyModel->mapFromSource(dirIndex);
+
+    if (m_setLeafVisible) {
+        m_treeView->scrollTo(proxyIndex);
+        m_setLeafVisible = false;

     }
     }

+
+    QItemSelectionModel* selModel = m_treeView->selectionModel();
+    selModel->setCurrentIndex(proxyIndex, QItemSelectionModel::Select);

 }
 
 #include "treeviewsidebarpage.moc"
 }
 
 #include "treeviewsidebarpage.moc"