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::setHiddenFilesShown(bool show)
  74 {
  75     FoldersPanelSettings::setHiddenFilesShown(show);
  76     if (m_dirLister) {
  77         KFileItemModel* model = fileItemModel();
  78         const QSet<KUrl> expandedUrls = model->expandedUrls();
  79         model->setShowHiddenFiles(show);
  80         model->setExpanded(expandedUrls);
  81     }
  82 }
  83
  84 bool FoldersPanel::hiddenFilesShown() const
  85 {
  86     return FoldersPanelSettings::hiddenFilesShown();
  87 }
  88
  89 void FoldersPanel::setAutoScrolling(bool enable)
  90 {
  91     // TODO: Not supported yet in Dolphin 2.0
  92     FoldersPanelSettings::setAutoScrolling(enable);
  93 }
  94
  95 bool FoldersPanel::autoScrolling() const
  96 {
  97     return FoldersPanelSettings::autoScrolling();
  98 }
  99
 100 void FoldersPanel::rename(const KFileItem& item)
 101 {
 102     // TODO: Inline renaming is not supported anymore in Dolphin 2.0
 103     if (false /* GeneralSettings::renameInline() */) {
 104         //const QModelIndex dirIndex = m_dolphinModel->indexForItem(item);
 105         //const QModelIndex proxyIndex = m_proxyModel->mapFromSource(dirIndex);
 106         //m_treeView->edit(proxyIndex);
 107     } else {
 108         RenameDialog* dialog = new RenameDialog(this, KFileItemList() << item);
 109         dialog->setAttribute(Qt::WA_DeleteOnClose);
 110         dialog->show();
 111         dialog->raise();
 112         dialog->activateWindow();
 113     }
 114 }
 115
 116 bool FoldersPanel::urlChanged()
 117 {
 118     if (!url().isValid() || url().protocol().contains("search")) {
 119         // Skip results shown by a search, as possible identical
 120         // directory names are useless without parent-path information.
 121         return false;
 122     }
 123
 124     if (m_dirLister) {
 125         loadTree(url());
 126     }
 127
 128     return true;
 129 }
 130
 131 void FoldersPanel::showEvent(QShowEvent* event)
 132 {
 133     if (event->spontaneous()) {
 134         Panel::showEvent(event);
 135         return;
 136     }
 137
 138     if (!m_dirLister) {
 139         // Postpone the creating of the dir lister to the first show event.
 140         // This assures that no performance and memory overhead is given when the TreeView is not
 141         // used at all (see FoldersPanel::setUrl()).
 142         m_dirLister = new KDirLister();
 143         m_dirLister->setDirOnlyMode(true);
 144         m_dirLister->setAutoUpdate(true);
 145         m_dirLister->setMainWindow(window());
 146         m_dirLister->setDelayedMimeTypes(true);
 147         m_dirLister->setAutoErrorHandlingEnabled(false, this);
 148
 149         KFileItemListView* view  = new KFileItemListView();
 150         view->setWidgetCreator(new KItemListWidgetCreator<KFileItemListWidget>());
 151
 152         KItemListStyleOption styleOption = view->styleOption();
 153         styleOption.margin = 2;
 154         styleOption.iconSize = KIconLoader::SizeSmall;
 155         view->setStyleOption(styleOption);
 156
 157         const qreal itemHeight = qMax(int(KIconLoader::SizeSmall), styleOption.fontMetrics.height());
 158         view->setItemSize(QSizeF(-1, itemHeight + 2 * styleOption.margin));
 159         view->setItemLayout(KFileItemListView::DetailsLayout);
 160         // Set the opacity to 0 initially. The opacity will be increased after the loading of the initial tree
 161         // has been finished in slotLoadingCompleted(). This prevents an unnecessary animation-mess when
 162         // opening the folders panel.
 163         view->setOpacity(0);
 164
 165         KFileItemModel* model = new KFileItemModel(m_dirLister, this);
 166         model->setShowHiddenFiles(FoldersPanelSettings::hiddenFilesShown());
 167         // Use a QueuedConnection to give the view the possibility to react first on the
 168         // finished loading.
 169         connect(model, SIGNAL(loadingCompleted()), this, SLOT(slotLoadingCompleted()), Qt::QueuedConnection);
 170
 171         KItemListContainer* container = new KItemListContainer(this);
 172         m_controller = container->controller();
 173         m_controller->setView(view);
 174         m_controller->setModel(model);
 175         m_controller->setSelectionBehavior(KItemListController::SingleSelection);
 176         m_controller->setAutoActivationDelay(750);
 177
 178         connect(m_controller, SIGNAL(itemActivated(int)), this, SLOT(slotItemActivated(int)));
 179         connect(m_controller, SIGNAL(itemMiddleClicked(int)), this, SLOT(slotItemMiddleClicked(int)));
 180         connect(m_controller, SIGNAL(itemContextMenuRequested(int,QPointF)), this, SLOT(slotItemContextMenuRequested(int,QPointF)));
 181         connect(m_controller, SIGNAL(viewContextMenuRequested(QPointF)), this, SLOT(slotViewContextMenuRequested(QPointF)));
 182         connect(m_controller, SIGNAL(itemDropEvent(int,QGraphicsSceneDragDropEvent*)), this, SLOT(slotItemDropEvent(int,QGraphicsSceneDragDropEvent*)));
 183
 184         // TODO: Check whether it makes sense to make an explicit API for KItemListContainer
 185         // to make the background transparent.
 186         container->setFrameShape(QFrame::NoFrame);
 187         QGraphicsView* graphicsView = qobject_cast<QGraphicsView*>(container->viewport());
 188         if (graphicsView) {
 189             // Make the background of the container transparent and apply the window-text color
 190             // to the text color, so that enough contrast is given for all color
 191             // schemes
 192             QPalette p = graphicsView->palette();
 193             p.setColor(QPalette::Active,   QPalette::Text, p.color(QPalette::Active,   QPalette::WindowText));
 194             p.setColor(QPalette::Inactive, QPalette::Text, p.color(QPalette::Inactive, QPalette::WindowText));
 195             p.setColor(QPalette::Disabled, QPalette::Text, p.color(QPalette::Disabled, QPalette::WindowText));
 196             graphicsView->setPalette(p);
 197             graphicsView->viewport()->setAutoFillBackground(false);
 198         }
 199
 200         QVBoxLayout* layout = new QVBoxLayout(this);
 201         layout->setMargin(0);
 202         layout->addWidget(container);
 203     }
 204
 205     loadTree(url());
 206     Panel::showEvent(event);
 207 }
 208
 209 void FoldersPanel::keyPressEvent(QKeyEvent* event)
 210 {
 211     const int key = event->key();
 212     if ((key == Qt::Key_Enter) || (key == Qt::Key_Return)) {
 213         event->accept();
 214     } else {
 215         Panel::keyPressEvent(event);
 216     }
 217 }
 218
 219 void FoldersPanel::slotItemActivated(int index)
 220 {
 221     const KFileItem item = fileItemModel()->fileItem(index);
 222     if (!item.isNull()) {
 223         emit changeUrl(item.url(), Qt::LeftButton);
 224     }
 225 }
 226
 227 void FoldersPanel::slotItemMiddleClicked(int index)
 228 {
 229     const KFileItem item = fileItemModel()->fileItem(index);
 230     if (!item.isNull()) {
 231         emit changeUrl(item.url(), Qt::MiddleButton);
 232     }
 233 }
 234
 235 void FoldersPanel::slotItemContextMenuRequested(int index, const QPointF& pos)
 236 {
 237     Q_UNUSED(pos);
 238
 239     const KFileItem fileItem = fileItemModel()->fileItem(index);
 240
 241     QWeakPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, fileItem);
 242     contextMenu.data()->open();
 243     if (contextMenu.data()) {
 244         delete contextMenu.data();
 245     }
 246 }
 247
 248 void FoldersPanel::slotViewContextMenuRequested(const QPointF& pos)
 249 {
 250     Q_UNUSED(pos);
 251
 252     QWeakPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, KFileItem());
 253     contextMenu.data()->open();
 254     if (contextMenu.data()) {
 255         delete contextMenu.data();
 256     }
 257 }
 258
 259 void FoldersPanel::slotItemDropEvent(int index, QGraphicsSceneDragDropEvent* event)
 260 {
 261     if (index >= 0) {
 262         KFileItemModel* model = fileItemModel();
 263         KFileItem destItem = model->fileItem(index);
 264         if (destItem.isNull()) {
 265             destItem = model->rootItem();
 266             if (destItem.isNull()) {
 267                 kWarning() << "No destination item available for drop operation.";
 268                 return;
 269             }
 270         }
 271
 272         QDropEvent dropEvent(event->pos().toPoint(),
 273                              event->possibleActions(),
 274                              event->mimeData(),
 275                              event->buttons(),
 276                              event->modifiers());
 277
 278         DragAndDropHelper::dropUrls(destItem, &dropEvent);
 279     }
 280 }
 281
 282 void FoldersPanel::slotLoadingCompleted()
 283 {
 284     if (m_controller->view()->opacity() == 0) {
 285         // The loading of the initial tree after opening the Folders panel
 286         // has been finished. Trigger the increasing of the opacity after
 287         // a short delay to give the view the chance to finish its internal
 288         // animations.
 289         // TODO: Check whether it makes sense to allow accessing the
 290         // view-internal delay for usecases like this.
 291         QTimer::singleShot(250, this, SLOT(startFadeInAnimation()));
 292     }
 293
 294     if (!m_updateCurrentItem) {
 295         return;
 296     }
 297
 298     const int index = fileItemModel()->index(url());
 299     updateCurrentItem(index);
 300     m_updateCurrentItem = false;
 301 }
 302
 303 void FoldersPanel::startFadeInAnimation()
 304 {
 305     QPropertyAnimation* anim = new QPropertyAnimation(m_controller->view(), "opacity", this);
 306     anim->setStartValue(0);
 307     anim->setEndValue(1);
 308     anim->setEasingCurve(QEasingCurve::InOutQuad);
 309     anim->start(QAbstractAnimation::DeleteWhenStopped);
 310     anim->setDuration(200);
 311 }
 312
 313 void FoldersPanel::loadTree(const KUrl& url)
 314 {
 315     Q_ASSERT(m_dirLister);
 316
 317     m_updateCurrentItem = false;
 318
 319     KUrl baseUrl;
 320     if (url.isLocalFile()) {
 321         // Use the root directory as base for local URLs (#150941)
 322         baseUrl = QDir::rootPath();
 323     } else {
 324         // Clear the path for non-local URLs and use it as base
 325         baseUrl = url;
 326         baseUrl.setPath(QString('/'));
 327     }
 328
 329     if (m_dirLister->url() != baseUrl) {
 330         m_updateCurrentItem = true;
 331         m_dirLister->stop();
 332         m_dirLister->openUrl(baseUrl, KDirLister::Reload);
 333     }
 334
 335     KFileItemModel* model = fileItemModel();
 336     const int index = model->index(url);
 337     if (index >= 0) {
 338         updateCurrentItem(index);
 339     } else {
 340         m_updateCurrentItem = true;
 341         model->setExpanded(QSet<KUrl>() << url);
 342         // slotLoadingCompleted() will be invoked after the model has
 343         // expanded the url
 344     }
 345 }
 346
 347 void FoldersPanel::updateCurrentItem(int index)
 348 {
 349     KItemListSelectionManager* selectionManager = m_controller->selectionManager();
 350     selectionManager->setCurrentItem(index);
 351     selectionManager->clearSelection();
 352     selectionManager->setSelected(index);
 353
 354     m_controller->view()->scrollToItem(index);
 355 }
 356
 357 KFileItemModel* FoldersPanel::fileItemModel() const
 358 {
 359     return static_cast<KFileItemModel*>(m_controller->model());
 360 }
 361
 362 #include "folderspanel.moc"