src/panels/places/placespanel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2008-2012 by Peter Penz <peter.penz19@gmail.com>        *
   3  *                                                                         *
   4  *   Based on KFilePlacesView from kdelibs:                                *
   5  *   Copyright (C) 2007 Kevin Ottens <ervin@kde.org>                       *
   6  *   Copyright (C) 2007 David Faure <faure@kde.org>                        *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  22  ***************************************************************************/
  23
  24 #include "placespanel.h"
  25
  26 #include <KConfigGroup>
  27 #include <KDebug>
  28 #include <KDirNotify>
  29 #include <KIcon>
  30 #include <KIO/Job>
  31 #include <KIO/JobUiDelegate>
  32 #include <KLocale>
  33 #include <kitemviews/kitemlistcontainer.h>
  34 #include <kitemviews/kitemlistcontroller.h>
  35 #include <kitemviews/kitemlistselectionmanager.h>
  36 #include <kitemviews/kstandarditem.h>
  37 #include <kitemviews/kstandarditemlistview.h>
  38 #include <KMenu>
  39 #include <KMessageBox>
  40 #include <KNotification>
  41 #include "placesitem.h"
  42 #include "placesitemeditdialog.h"
  43 #include "placesitemlistgroupheader.h"
  44 #include "placesitemlistwidget.h"
  45 #include "placesitemmodel.h"
  46 #include <views/draganddrophelper.h>
  47 #include <QVBoxLayout>
  48 #include <QShowEvent>
  49
  50 PlacesPanel::PlacesPanel(QWidget* parent) :
  51     Panel(parent),
  52     m_controller(0),
  53     m_model(0)
  54 {
  55 }
  56
  57 PlacesPanel::~PlacesPanel()
  58 {
  59 }
  60
  61 bool PlacesPanel::urlChanged()
  62 {
  63     return true;
  64 }
  65
  66 void PlacesPanel::showEvent(QShowEvent* event)
  67 {
  68     if (event->spontaneous()) {
  69         Panel::showEvent(event);
  70         return;
  71     }
  72
  73     if (!m_controller) {
  74         // Postpone the creating of the controller to the first show event.
  75         // This assures that no performance and memory overhead is given when the folders panel is not
  76         // used at all and stays invisible.
  77         m_model = new PlacesItemModel(this);
  78         m_model->setGroupedSorting(true);
  79         m_model->setSortRole("group");
  80         connect(m_model, SIGNAL(errorMessage(QString)),
  81                 this, SIGNAL(errorMessage(QString)));
  82
  83         KStandardItemListView* view = new KStandardItemListView();
  84         view->setWidgetCreator(new KItemListWidgetCreator<PlacesItemListWidget>());
  85         view->setGroupHeaderCreator(new KItemListGroupHeaderCreator<PlacesItemListGroupHeader>());
  86
  87         m_controller = new KItemListController(m_model, view, this);
  88         m_controller->setSelectionBehavior(KItemListController::SingleSelection);
  89         connect(m_controller, SIGNAL(itemActivated(int)), this, SLOT(slotItemActivated(int)));
  90         connect(m_controller, SIGNAL(itemMiddleClicked(int)), this, SLOT(slotItemMiddleClicked(int)));
  91         connect(m_controller, SIGNAL(itemContextMenuRequested(int,QPointF)), this, SLOT(slotItemContextMenuRequested(int,QPointF)));
  92         connect(m_controller, SIGNAL(viewContextMenuRequested(QPointF)), this, SLOT(slotViewContextMenuRequested(QPointF)));
  93
  94         KItemListContainer* container = new KItemListContainer(m_controller, this);
  95         container->setEnabledFrame(false);
  96
  97         QVBoxLayout* layout = new QVBoxLayout(this);
  98         layout->setMargin(0);
  99         layout->addWidget(container);
 100
 101         selectClosestItem();
 102     }
 103
 104     Panel::showEvent(event);
 105 }
 106
 107 void PlacesPanel::slotItemActivated(int index)
 108 {
 109     const KUrl url = m_model->data(index).value("url").value<KUrl>();
 110     if (!url.isEmpty()) {
 111         emit placeActivated(PlacesItemModel::convertedUrl(url));
 112     }
 113 }
 114
 115 void PlacesPanel::slotItemMiddleClicked(int index)
 116 {
 117     const KUrl url = m_model->data(index).value("url").value<KUrl>();
 118     if (!url.isEmpty()) {
 119         emit placeMiddleClicked(PlacesItemModel::convertedUrl(url));
 120     }
 121 }
 122
 123 void PlacesPanel::slotItemContextMenuRequested(int index, const QPointF& pos)
 124 {
 125     PlacesItem* item = m_model->placesItem(index);
 126     if (!item) {
 127         return;
 128     }
 129
 130     KMenu menu(this);
 131
 132     QAction* emptyTrashAction = 0;
 133     QAction* addAction = 0;
 134     QAction* mainSeparator = 0;
 135     QAction* editAction = 0;
 136     QAction* teardownAction = 0;
 137     QAction* ejectAction = 0;
 138
 139     const QString label = item->text();
 140
 141     const bool isDevice = !item->udi().isEmpty();
 142     if (isDevice) {
 143         ejectAction = m_model->ejectAction(index);
 144         if (ejectAction) {
 145             ejectAction->setParent(&menu);
 146             menu.addAction(ejectAction);
 147         }
 148
 149         teardownAction = m_model->teardownAction(index);
 150         if (teardownAction) {
 151             teardownAction->setParent(&menu);
 152             menu.addAction(teardownAction);
 153         }
 154
 155         if (teardownAction || ejectAction) {
 156             mainSeparator = menu.addSeparator();
 157         }
 158     } else {
 159         if (item->url() == KUrl("trash:/")) {
 160             emptyTrashAction = menu.addAction(KIcon("trash-empty"), i18nc("@action:inmenu", "Empty Trash"));
 161             KConfig trashConfig("trashrc", KConfig::SimpleConfig);
 162             emptyTrashAction->setEnabled(!trashConfig.group("Status").readEntry("Empty", true));
 163             menu.addSeparator();
 164         }
 165         addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
 166         mainSeparator = menu.addSeparator();
 167         editAction = menu.addAction(KIcon("document-properties"), i18nc("@item:inmenu", "Edit '%1'...", label));
 168     }
 169
 170     if (!addAction) {
 171         addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
 172     }
 173
 174     QAction* openInNewTabAction = menu.addAction(i18nc("@item:inmenu", "Open '%1' in New Tab", label));
 175     openInNewTabAction->setIcon(KIcon("tab-new"));
 176
 177     QAction* removeAction = 0;
 178     if (!isDevice && !item->isSystemItem()) {
 179         removeAction = menu.addAction(KIcon("edit-delete"), i18nc("@item:inmenu", "Remove '%1'", label));
 180     }
 181
 182     QAction* hideAction = menu.addAction(i18nc("@item:inmenu", "Hide '%1'", label));
 183     hideAction->setCheckable(true);
 184     hideAction->setChecked(item->isHidden());
 185
 186     QAction* showAllAction = 0;
 187     if (m_model->hiddenCount() > 0) {
 188         if (!mainSeparator) {
 189             mainSeparator = menu.addSeparator();
 190         }
 191         showAllAction = menu.addAction(i18nc("@item:inmenu", "Show All Entries"));
 192         showAllAction->setCheckable(true);
 193         showAllAction->setChecked(m_model->hiddenItemsShown());
 194     }
 195
 196     menu.addSeparator();
 197     foreach (QAction* action, customContextMenuActions()) {
 198         menu.addAction(action);
 199     }
 200
 201     QAction* action = menu.exec(pos.toPoint());
 202     if (action) {
 203         if (action == emptyTrashAction) {
 204             emptyTrash();
 205         } else if (action == addAction) {
 206             addEntry();
 207         } else if (action == editAction) {
 208             editEntry(index);
 209         } else if (action == removeAction) {
 210             m_model->removeItem(index);
 211         } else if (action == hideAction) {
 212             item->setHidden(hideAction->isChecked());
 213         } else if (action == openInNewTabAction) {
 214             const KUrl url = m_model->item(index)->dataValue("url").value<KUrl>();
 215             emit placeMiddleClicked(url);
 216         } else if (action == showAllAction) {
 217             m_model->setHiddenItemsShown(showAllAction->isChecked());
 218         } else if (action == teardownAction) {
 219             m_model->requestTeardown(index);
 220         } else if (action == ejectAction) {
 221             m_model->requestEject(index);
 222         }
 223     }
 224
 225     selectClosestItem();
 226 }
 227
 228 void PlacesPanel::slotViewContextMenuRequested(const QPointF& pos)
 229 {
 230     KMenu menu(this);
 231
 232     QAction* addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
 233
 234     QAction* showAllAction = 0;
 235     if (m_model->hiddenCount() > 0) {
 236         showAllAction = menu.addAction(i18nc("@item:inmenu", "Show All Entries"));
 237         showAllAction->setCheckable(true);
 238         showAllAction->setChecked(m_model->hiddenItemsShown());
 239     }
 240
 241     menu.addSeparator();
 242     foreach (QAction* action, customContextMenuActions()) {
 243         menu.addAction(action);
 244     }
 245
 246     QAction* action = menu.exec(pos.toPoint());
 247     if (action) {
 248         if (action == addAction) {
 249             addEntry();
 250         } else if (action == showAllAction) {
 251             m_model->setHiddenItemsShown(showAllAction->isChecked());
 252         }
 253     }
 254
 255     selectClosestItem();
 256 }
 257
 258 void PlacesPanel::slotUrlsDropped(const KUrl& dest, QDropEvent* event, QWidget* parent)
 259 {
 260     Q_UNUSED(parent);
 261     const QString error = DragAndDropHelper::dropUrls(KFileItem(), dest, event);
 262     if (!error.isEmpty()) {
 263         emit errorMessage(error);
 264     }
 265
 266 }
 267
 268 void PlacesPanel::slotTrashUpdated(KJob* job)
 269 {
 270     if (job->error()) {
 271         emit errorMessage(job->errorString());
 272     }
 273     org::kde::KDirNotify::emitFilesAdded("trash:/");
 274 }
 275
 276 void PlacesPanel::emptyTrash()
 277 {
 278     const QString text = i18nc("@info", "Do you really want to empty the Trash? All items will be deleted.");
 279     const bool del = KMessageBox::warningContinueCancel(window(),
 280                                                         text,
 281                                                         QString(),
 282                                                         KGuiItem(i18nc("@action:button", "Empty Trash"),
 283                                                                  KIcon("user-trash"))
 284                                                        ) == KMessageBox::Continue;
 285     if (del) {
 286         QByteArray packedArgs;
 287         QDataStream stream(&packedArgs, QIODevice::WriteOnly);
 288         stream << int(1);
 289         KIO::Job *job = KIO::special(KUrl("trash:/"), packedArgs);
 290         KNotification::event("Trash: emptied", QString() , QPixmap() , 0, KNotification::DefaultEvent);
 291         job->ui()->setWindow(parentWidget());
 292         connect(job, SIGNAL(result(KJob*)), SLOT(slotTrashUpdated(KJob*)));
 293     }
 294 }
 295
 296 void PlacesPanel::addEntry()
 297 {
 298     const int index = m_controller->selectionManager()->currentItem();
 299     const KUrl url = m_model->data(index).value("url").value<KUrl>();
 300
 301     QPointer<PlacesItemEditDialog> dialog = new PlacesItemEditDialog(this);
 302     dialog->setCaption(i18nc("@title:window", "Add Places Entry"));
 303     dialog->setAllowGlobal(true);
 304     dialog->setUrl(url);
 305     if (dialog->exec() == QDialog::Accepted) {
 306         PlacesItem* item = m_model->createPlacesItem(dialog->text(), dialog->url(), dialog->icon());
 307
 308         // Insert the item as last item of the corresponding group.
 309         int i = 0;
 310         while (i < m_model->count() && m_model->placesItem(i)->group() != item->group()) {
 311             ++i;
 312         }
 313
 314         bool inserted = false;
 315         while (!inserted && i < m_model->count()) {
 316             if (m_model->placesItem(i)->group() != item->group()) {
 317                 m_model->insertItem(i, item);
 318                 inserted = true;
 319             }
 320             ++i;
 321         }
 322
 323         if (!inserted) {
 324             m_model->appendItem(item);
 325         }
 326     }
 327
 328     delete dialog;
 329 }
 330
 331 void PlacesPanel::editEntry(int index)
 332 {
 333     QHash<QByteArray, QVariant> data = m_model->data(index);
 334
 335     QPointer<PlacesItemEditDialog> dialog = new PlacesItemEditDialog(this);
 336     dialog->setCaption(i18nc("@title:window", "Edit Places Entry"));
 337     dialog->setIcon(data.value("iconName").toString());
 338     dialog->setText(data.value("text").toString());
 339     dialog->setUrl(data.value("url").value<KUrl>());
 340     dialog->setAllowGlobal(true);
 341     if (dialog->exec() == QDialog::Accepted) {
 342         PlacesItem* oldItem = m_model->placesItem(index);
 343         if (oldItem) {
 344             oldItem->setText(dialog->text());
 345             oldItem->setUrl(dialog->url());
 346             oldItem->setIcon(dialog->icon());
 347         }
 348     }
 349
 350     delete dialog;
 351 }
 352
 353 void PlacesPanel::selectClosestItem()
 354 {
 355     const int index = m_model->closestItem(url());
 356     KItemListSelectionManager* selectionManager = m_controller->selectionManager();
 357     selectionManager->setCurrentItem(index);
 358     selectionManager->clearSelection();
 359     selectionManager->setSelected(index);
 360 }
 361
 362 #include "placespanel.moc"