]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/treeviewsidebarpage.cpp
Use a QActionGroup and save 6 slots (and the duplication of the action names in the...
[dolphin.git] / src / treeviewsidebarpage.cpp
index aef455c1e35f2efae9e64beed8c6f8b6013fabf0..14c8777280d15d775b97ce2dd8291a7642e7e88a 100644 (file)
 
 #include "treeviewsidebarpage.h"
 
-#include "bookmarkselector.h"
-#include "dolphinmainwindow.h"
+#include "dolphinmodel.h"
 #include "dolphinsortfilterproxymodel.h"
 #include "dolphinview.h"
+#include "dolphinsettings.h"
 #include "sidebartreeview.h"
 #include "treeviewcontextmenu.h"
 
+#include <kfileplacesmodel.h>
 #include <kdirlister.h>
-#include <kdirmodel.h>
 #include <kfileitem.h>
 
-#include <QHeaderView>
-#include <QItemSelectionModel>
+#include <QItemSelection>
 #include <QTreeView>
-#include <QVBoxLayout>
-#include "dolphinsettings.h"
-
-// TODO: currently when using a proxy model the strange effect occurs
-// that items get duplicated. Activate the following define to have the proxy
-// model:
-//#define USE_PROXY_MODEL
+#include <QBoxLayout>
+#include <QModelIndex>
+#include <QScrollBar>
+#include <QTimer>
 
 TreeViewSidebarPage::TreeViewSidebarPage(QWidget* parent) :
     SidebarPage(parent),
+    m_setLeafVisible(false),
+    m_horizontalPos(0),
     m_dirLister(0),
-    m_dirModel(0),
+    m_dolphinModel(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);
-
-
-#if defined(USE_PROXY_MODEL)
-    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::Ascending);
-#else
-    m_treeView = new SidebarTreeView(this);
-    m_treeView->setModel(m_dirModel);
-#endif
-
-    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()
 {
-    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)
 {
-    if (!url.isValid() || (url == m_url)) {
+    if (!url.isValid() || (url == SidebarPage::url())) {
         return;
     }
 
-    m_url = url;
+    SidebarPage::setUrl(url);
+    if (m_dirLister != 0) {
+        m_setLeafVisible = true;
+        loadTree(url);
+    }
+}
 
-    // adjust the root of the tree to the base bookmark
-    const KUrl baseUrl = BookmarkSelector::baseBookmark(DolphinSettings::instance().bookmarkManager(), url).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()) {
-#if defined(USE_PROXY_MODEL)
-        // 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
-        m_treeView->scrollTo(index);
-        selModel->setCurrentIndex(index, QItemSelectionModel::Select);
-#endif
-    }
-    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()),
-                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);
 }
 
@@ -152,86 +138,137 @@ void TreeViewSidebarPage::contextMenuEvent(QContextMenuEvent* event)
         return;
     }
 
-#if defined(USE_PROXY_MODEL)
-    const QModelIndex dirModelIndex = m_proxyModel->mapToSource(index);
-    KFileItem* item = m_dirModel->itemForIndex(dirModelIndex);
-#else
-    KFileItem* item = m_dirModel->itemForIndex(index);
-#endif
+    const QModelIndex dolphinModelIndex = m_proxyModel->mapToSource(index);
+    KFileItem item = m_dolphinModel->itemForIndex(dolphinModelIndex);
 
     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());
+    }
+}
+
+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());
+        }
+    }
+}
 
-    // expand the parent folder of the selected item
-    KUrl parentUrl = m_url.upUrl();
-    if (!m_dirLister->url().isParentOf(parentUrl)) {
+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;
     }
 
-    QModelIndex index = m_dirModel->indexForUrl(parentUrl);
+    const QModelIndex index = m_dolphinModel->indexForUrl(m_leafDir);
     if (index.isValid()) {
-#if defined(USE_PROXY_MODEL)
-        QModelIndex proxyIndex = m_proxyModel->mapFromSource(index);
-        m_treeView->setExpanded(proxyIndex, true);
-#else
-        m_treeView->setExpanded(index, true);
-#endif
-
-        // select the item and assure that the item is visible
-        index = m_dirModel->indexForUrl(m_url);
-        if (index.isValid()) {
-#if defined(USE_PROXY_MODEL)
-            proxyIndex = m_proxyModel->mapFromSource(index);
-            m_treeView->scrollTo(proxyIndex);
-
-            QItemSelectionModel* selModel = m_treeView->selectionModel();
-            selModel->setCurrentIndex(proxyIndex, QItemSelectionModel::Select);
-#else
-            m_treeView->scrollTo(index);
-
-            QItemSelectionModel* selModel = m_treeView->selectionModel();
-            selModel->setCurrentIndex(index, QItemSelectionModel::Select);
-#endif
-        }
+        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);
     }
 }
 
-void TreeViewSidebarPage::updateActiveView(const QModelIndex& index)
+void TreeViewSidebarPage::scrollToLeaf()
 {
-#if defined(USE_PROXY_MODEL)
-    const QModelIndex& dirIndex = m_proxyModel->mapToSource(index);
-    const KFileItem* item = m_dirModel->itemForIndex(dirIndex);
-#else
-    const KFileItem* item = m_dirModel->itemForIndex(index);
-#endif
-    if (item != 0) {
-        const KUrl& url = item->url();
-        emit changeUrl(url);
+    const QModelIndex dirIndex = m_dolphinModel->indexForUrl(m_leafDir);
+    const QModelIndex proxyIndex = m_proxyModel->mapFromSource(dirIndex);
+    if (proxyIndex.isValid()) {
+        m_treeView->scrollTo(proxyIndex);
     }
 }
 
-void TreeViewSidebarPage::dropUrls(const KUrl::List& urls,
-                                   const QModelIndex& index)
+void TreeViewSidebarPage::loadTree(const KUrl& url)
 {
-    if (index.isValid()) {
-#if defined(USE_PROXY_MODEL)
-        const QModelIndex& dirIndex = m_proxyModel->mapToSource(index);
-        KFileItem* item = m_dirModel->itemForIndex(dirIndex);
-#else
-        KFileItem* item = m_dirModel->itemForIndex(index);
-#endif
-        Q_ASSERT(item != 0);
-        if (item->isDir()) {
-            emit urlsDropped(urls, item->url());
-        }
+    Q_ASSERT(m_dirLister != 0);
+    m_leafDir = url;
+
+    m_horizontalPos = m_treeView->horizontalScrollBar()->value();
+
+    KUrl baseUrl = url;
+    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());
+    }
+
+    if (m_dirLister->url() != baseUrl) {
+        m_dirLister->stop();
+        m_dirLister->openUrl(baseUrl, KDirLister::Reload);
+    } else {
+        loadSubTree();
+    }
+}
+
+void TreeViewSidebarPage::selectLeafDirectory()
+{
+    const QModelIndex dirIndex = m_dolphinModel->indexForUrl(m_leafDir);
+    const QModelIndex proxyIndex = m_proxyModel->mapFromSource(dirIndex);
+    if (!proxyIndex.isValid()) {
+        return;
+    }
+
+    if (m_setLeafVisible) {
+        // Invoke m_treeView->scrollTo(proxyIndex) asynchronously by
+        // scrollToLeaf(). This assures that the scrolling is done after
+        // the horizontal scrollbar gets visible (otherwise the scrollbar
+        // might hide the leaf).
+        QTimer::singleShot(100, this, SLOT(scrollToLeaf()));
+        m_setLeafVisible = false;
     }
+
+    QItemSelectionModel* selModel = m_treeView->selectionModel();
+    selModel->setCurrentIndex(proxyIndex, QItemSelectionModel::Select);
+
+    m_treeView->horizontalScrollBar()->setValue(m_horizontalPos);
 }
 
 #include "treeviewsidebarpage.moc"