src/panels/folders/folderspanel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2006-2010 by Peter Penz <peter.penz19@gmail.com>        *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #include "folderspanel.h"
  21
  22 #include "dolphin_folderspanelsettings.h"
  23 #include "dolphin_generalsettings.h"
  24 #include "treeviewcontextmenu.h"
  25
  26 #include <kitemviews/kitemlistselectionmanager.h>
  27 #include <kitemviews/kfileitemlistview.h>
  28 #include <kitemviews/kfileitemlistwidget.h>
  29 #include <kitemviews/kitemlistcontainer.h>
  30 #include <kitemviews/kitemlistcontroller.h>
  31 #include <kitemviews/kfileitemmodel.h>
  32
  33 #include <KDirLister>
  34 #include <KFileItem>
  35 #include <konq_operations.h>
  36
  37 #include <QApplication>
  38 #include <QBoxLayout>
  39 #include <QDropEvent>
  40 #include <QGraphicsSceneDragDropEvent>
  41 #include <QGraphicsView>
  42 #include <QPropertyAnimation>
  43 #include <QTimer>
  44
  45 #include <views/draganddrophelper.h>
  46 #include <views/renamedialog.h>
  47
  48 #include <KDebug>
  49
  50 FoldersPanel::FoldersPanel(QWidget* parent) :
  51     Panel(parent),
  52     m_updateCurrentItem(false),
  53     m_dirLister(0),
  54     m_controller(0)
  55 {
  56     setLayoutDirection(Qt::LeftToRight);
  57 }
  58
  59 FoldersPanel::~FoldersPanel()
  60 {
  61     FoldersPanelSettings::self()->writeConfig();
  62
  63     if (m_controller) {
  64         KItemListView* view = m_controller->view();
  65         m_controller->setView(0);
  66         delete view;
  67     }
  68
  69     delete m_dirLister;
  70     m_dirLister = 0;
  71 }
  72
  73 void FoldersPanel::setShowHiddenFiles(bool show)
  74 {
  75     FoldersPanelSettings::setHiddenFilesShown(show);
  76     fileItemModel()->setShowHiddenFiles(show);
  77 }
  78
  79 bool FoldersPanel::showHiddenFiles() const
  80 {
  81     return FoldersPanelSettings::hiddenFilesShown();
  82 }
  83
  84 void FoldersPanel::setAutoScrolling(bool enable)
  85 {
  86     // TODO: Not supported yet in Dolphin 2.0
  87     FoldersPanelSettings::setAutoScrolling(enable);
  88 }
  89
  90 bool FoldersPanel::autoScrolling() const
  91 {
  92     return FoldersPanelSettings::autoScrolling();
  93 }
  94
  95 void FoldersPanel::rename(const KFileItem& item)
  96 {
  97     // TODO: Inline renaming is not supported anymore in Dolphin 2.0
  98     if (false /* GeneralSettings::renameInline() */) {
  99         //const QModelIndex dirIndex = m_dolphinModel->indexForItem(item);
 100         //const QModelIndex proxyIndex = m_proxyModel->mapFromSource(dirIndex);
 101         //m_treeView->edit(proxyIndex);
 102     } else {
 103         RenameDialog* dialog = new RenameDialog(this, KFileItemList() << item);
 104         dialog->setAttribute(Qt::WA_DeleteOnClose);
 105         dialog->show();
 106         dialog->raise();
 107         dialog->activateWindow();
 108     }
 109 }
 110
 111 bool FoldersPanel::urlChanged()
 112 {
 113     if (!url().isValid() || url().protocol().contains("search")) {
 114         // Skip results shown by a search, as possible identical
 115         // directory names are useless without parent-path information.
 116         return false;
 117     }
 118
 119     if (m_dirLister) {
 120         loadTree(url());
 121     }
 122
 123     return true;
 124 }
 125
 126 void FoldersPanel::showEvent(QShowEvent* event)
 127 {
 128     if (event->spontaneous()) {
 129         Panel::showEvent(event);
 130         return;
 131     }
 132
 133     if (!m_dirLister) {
 134         // Postpone the creating of the dir lister to the first show event.
 135         // This assures that no performance and memory overhead is given when the TreeView is not
 136         // used at all (see FoldersPanel::setUrl()).
 137         m_dirLister = new KDirLister();
 138         m_dirLister->setAutoUpdate(true);
 139         m_dirLister->setMainWindow(window());
 140         m_dirLister->setDelayedMimeTypes(true);
 141         m_dirLister->setAutoErrorHandlingEnabled(false, this);
 142
 143         KFileItemListView* view  = new KFileItemListView();
 144         view->setWidgetCreator(new KItemListWidgetCreator<KFileItemListWidget>());
 145
 146         KItemListStyleOption styleOption = view->styleOption();
 147         styleOption.padding = 2;
 148         styleOption.iconSize = KIconLoader::SizeSmall;
 149         styleOption.extendedSelectionRegion = true;
 150         view->setStyleOption(styleOption);
 151
 152         const qreal itemHeight = qMax(int(KIconLoader::SizeSmall), styleOption.fontMetrics.height());
 153         view->setItemSize(QSizeF(-1, itemHeight + 2 * styleOption.padding));
 154         view->setItemLayout(KFileItemListView::DetailsLayout);
 155         // Set the opacity to 0 initially. The opacity will be increased after the loading of the initial tree
 156         // has been finished in slotLoadingCompleted(). This prevents an unnecessary animation-mess when
 157         // opening the folders panel.
 158         view->setOpacity(0);
 159
 160         KFileItemModel* model = new KFileItemModel(m_dirLister, this);
 161         model->setShowFoldersOnly(true);
 162         model->setShowHiddenFiles(FoldersPanelSettings::hiddenFilesShown());
 163         // Use a QueuedConnection to give the view the possibility to react first on the
 164         // finished loading.
 165         connect(model, SIGNAL(loadingCompleted()), this, SLOT(slotLoadingCompleted()), Qt::QueuedConnection);
 166
 167         KItemListContainer* container = new KItemListContainer(this);
 168         m_controller = container->controller();
 169         m_controller->setView(view);
 170         m_controller->setModel(model);
 171         m_controller->setSelectionBehavior(KItemListController::SingleSelection);
 172         m_controller->setAutoActivationDelay(750);
 173         m_controller->setSingleClickActivation(true);
 174
 175         connect(m_controller, SIGNAL(itemActivated(int)), this, SLOT(slotItemActivated(int)));
 176         connect(m_controller, SIGNAL(itemMiddleClicked(int)), this, SLOT(slotItemMiddleClicked(int)));
 177         connect(m_controller, SIGNAL(itemContextMenuRequested(int,QPointF)), this, SLOT(slotItemContextMenuRequested(int,QPointF)));
 178         connect(m_controller, SIGNAL(viewContextMenuRequested(QPointF)), this, SLOT(slotViewContextMenuRequested(QPointF)));
 179         connect(m_controller, SIGNAL(itemDropEvent(int,QGraphicsSceneDragDropEvent*)), this, SLOT(slotItemDropEvent(int,QGraphicsSceneDragDropEvent*)));
 180
 181         // TODO: Check whether it makes sense to make an explicit API for KItemListContainer
 182         // to make the background transparent.
 183         container->setFrameShape(QFrame::NoFrame);
 184         QGraphicsView* graphicsView = qobject_cast<QGraphicsView*>(container->viewport());
 185         if (graphicsView) {
 186             // Make the background of the container transparent and apply the window-text color
 187             // to the text color, so that enough contrast is given for all color
 188             // schemes
 189             QPalette p = graphicsView->palette();
 190             p.setColor(QPalette::Active,   QPalette::Text, p.color(QPalette::Active,   QPalette::WindowText));
 191             p.setColor(QPalette::Inactive, QPalette::Text, p.color(QPalette::Inactive, QPalette::WindowText));
 192             p.setColor(QPalette::Disabled, QPalette::Text, p.color(QPalette::Disabled, QPalette::WindowText));
 193             graphicsView->setPalette(p);
 194             graphicsView->viewport()->setAutoFillBackground(false);
 195         }
 196
 197         QVBoxLayout* layout = new QVBoxLayout(this);
 198         layout->setMargin(0);
 199         layout->addWidget(container);
 200     }
 201
 202     loadTree(url());
 203     Panel::showEvent(event);
 204 }
 205
 206 void FoldersPanel::keyPressEvent(QKeyEvent* event)
 207 {
 208     const int key = event->key();
 209     if ((key == Qt::Key_Enter) || (key == Qt::Key_Return)) {
 210         event->accept();
 211     } else {
 212         Panel::keyPressEvent(event);
 213     }
 214 }
 215
 216 void FoldersPanel::slotItemActivated(int index)
 217 {
 218     const KFileItem item = fileItemModel()->fileItem(index);
 219     if (!item.isNull()) {
 220         emit changeUrl(item.url(), Qt::LeftButton);
 221     }
 222 }
 223
 224 void FoldersPanel::slotItemMiddleClicked(int index)
 225 {
 226     const KFileItem item = fileItemModel()->fileItem(index);
 227     if (!item.isNull()) {
 228         emit changeUrl(item.url(), Qt::MiddleButton);
 229     }
 230 }
 231
 232 void FoldersPanel::slotItemContextMenuRequested(int index, const QPointF& pos)
 233 {
 234     Q_UNUSED(pos);
 235
 236     const KFileItem fileItem = fileItemModel()->fileItem(index);
 237
 238     QWeakPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, fileItem);
 239     contextMenu.data()->open();
 240     if (contextMenu.data()) {
 241         delete contextMenu.data();
 242     }
 243 }
 244
 245 void FoldersPanel::slotViewContextMenuRequested(const QPointF& pos)
 246 {
 247     Q_UNUSED(pos);
 248
 249     QWeakPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, KFileItem());
 250     contextMenu.data()->open();
 251     if (contextMenu.data()) {
 252         delete contextMenu.data();
 253     }
 254 }
 255
 256 void FoldersPanel::slotItemDropEvent(int index, QGraphicsSceneDragDropEvent* event)
 257 {
 258     if (index >= 0) {
 259         KFileItem destItem = fileItemModel()->fileItem(index);
 260         if (destItem.isNull()) {
 261             return;
 262         }
 263
 264         QDropEvent dropEvent(event->pos().toPoint(),
 265                              event->possibleActions(),
 266                              event->mimeData(),
 267                              event->buttons(),
 268                              event->modifiers());
 269
 270         DragAndDropHelper::dropUrls(destItem, destItem.url(), &dropEvent);
 271     }
 272 }
 273
 274 void FoldersPanel::slotLoadingCompleted()
 275 {
 276     if (m_controller->view()->opacity() == 0) {
 277         // The loading of the initial tree after opening the Folders panel
 278         // has been finished. Trigger the increasing of the opacity after
 279         // a short delay to give the view the chance to finish its internal
 280         // animations.
 281         // TODO: Check whether it makes sense to allow accessing the
 282         // view-internal delay for usecases like this.
 283         QTimer::singleShot(250, this, SLOT(startFadeInAnimation()));
 284     }
 285
 286     if (!m_updateCurrentItem) {
 287         return;
 288     }
 289
 290     const int index = fileItemModel()->index(url());
 291     updateCurrentItem(index);
 292     m_updateCurrentItem = false;
 293 }
 294
 295 void FoldersPanel::startFadeInAnimation()
 296 {
 297     QPropertyAnimation* anim = new QPropertyAnimation(m_controller->view(), "opacity", this);
 298     anim->setStartValue(0);
 299     anim->setEndValue(1);
 300     anim->setEasingCurve(QEasingCurve::InOutQuad);
 301     anim->start(QAbstractAnimation::DeleteWhenStopped);
 302     anim->setDuration(200);
 303 }
 304
 305 void FoldersPanel::loadTree(const KUrl& url)
 306 {
 307     Q_ASSERT(m_dirLister);
 308
 309     m_updateCurrentItem = false;
 310
 311     KUrl baseUrl;
 312     if (url.isLocalFile()) {
 313         // Use the root directory as base for local URLs (#150941)
 314         baseUrl = QDir::rootPath();
 315     } else {
 316         // Clear the path for non-local URLs and use it as base
 317         baseUrl = url;
 318         baseUrl.setPath(QString('/'));
 319     }
 320
 321     if (m_dirLister->url() != baseUrl) {
 322         m_updateCurrentItem = true;
 323         m_dirLister->stop();
 324         m_dirLister->openUrl(baseUrl, KDirLister::Reload);
 325     }
 326
 327     KFileItemModel* model = fileItemModel();
 328     const int index = model->index(url);
 329     if (index >= 0) {
 330         updateCurrentItem(index);
 331     } else {
 332         m_updateCurrentItem = true;
 333         model->expandParentItems(url);
 334         // slotLoadingCompleted() will be invoked after the model has
 335         // expanded the url
 336     }
 337 }
 338
 339 void FoldersPanel::updateCurrentItem(int index)
 340 {
 341     KItemListSelectionManager* selectionManager = m_controller->selectionManager();
 342     selectionManager->setCurrentItem(index);
 343     selectionManager->clearSelection();
 344     selectionManager->setSelected(index);
 345
 346     m_controller->view()->scrollToItem(index);
 347 }
 348
 349 KFileItemModel* FoldersPanel::fileItemModel() const
 350 {
 351     return static_cast<KFileItemModel*>(m_controller->model());
 352 }
 353
 354 #include "folderspanel.moc"