-/***************************************************************************
- * Copyright (C) 2008-2012 by Peter Penz <peter.penz19@gmail.com> *
- * *
- * Based on KFilePlacesView from kdelibs: *
- * Copyright (C) 2007 Kevin Ottens <ervin@kde.org> *
- * Copyright (C) 2007 David Faure <faure@kde.org> *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2008-2012 Peter Penz <peter.penz19@gmail.com>
+ * SPDX-FileCopyrightText: 2021 Kai Uwe Broulik <kde@broulik.de>
+ *
+ * Based on KFilePlacesView from kdelibs:
+ * SPDX-FileCopyrightText: 2007 Kevin Ottens <ervin@kde.org>
+ * SPDX-FileCopyrightText: 2007 David Faure <faure@kde.org>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#include "placespanel.h"
-#include <KConfigGroup>
-#include <KDebug>
-#include <KDirNotify>
-#include <KIcon>
+#include "dolphin_generalsettings.h"
+#include "dolphin_placespanelsettings.h"
+#include "dolphinplacesmodelsingleton.h"
+#include "settings/dolphinsettingsdialog.h"
+#include "views/draganddrophelper.h"
+
+#include <KFilePlacesModel>
+#include <KIO/DropJob>
#include <KIO/Job>
-#include <KIO/JobUiDelegate>
-#include <KLocale>
-#include <kitemviews/kitemlistcontainer.h>
-#include <kitemviews/kitemlistcontroller.h>
-#include <kitemviews/kitemlistselectionmanager.h>
-#include <kitemviews/kstandarditem.h>
-#include <kitemviews/kstandarditemlistview.h>
-#include <KMenu>
-#include <KMessageBox>
-#include <KNotification>
-#include "placesitemeditdialog.h"
-#include "placesitemlistgroupheader.h"
-#include "placesitemmodel.h"
-#include <views/draganddrophelper.h>
-#include <QVBoxLayout>
+#include <KLocalizedString>
+#include <KProtocolManager>
+
+#include <QIcon>
+#include <QMenu>
+#include <QMimeData>
#include <QShowEvent>
-PlacesPanel::PlacesPanel(QWidget* parent) :
- Panel(parent),
- m_controller(0),
- m_model(0)
+#include <Solid/StorageAccess>
+
+PlacesPanel::PlacesPanel(QWidget *parent)
+ : KFilePlacesView(parent)
{
+ setDropOnPlaceEnabled(true);
+ connect(this, &PlacesPanel::urlsDropped, this, &PlacesPanel::slotUrlsDropped);
+
+ setAutoResizeItemsEnabled(false);
+
+ setTeardownFunction([this](const QModelIndex &index) {
+ slotTearDownRequested(index);
+ });
+
+ m_configureTrashAction = new QAction(QIcon::fromTheme(QStringLiteral("configure")), i18nc("@action:inmenu", "Configure Trash…"));
+ m_configureTrashAction->setPriority(QAction::HighPriority);
+ connect(m_configureTrashAction, &QAction::triggered, this, &PlacesPanel::slotConfigureTrash);
+ addAction(m_configureTrashAction);
+
+ connect(this, &PlacesPanel::contextMenuAboutToShow, this, &PlacesPanel::slotContextMenuAboutToShow);
+
+ connect(this, &PlacesPanel::iconSizeChanged, this, [](const QSize &newSize) {
+ int iconSize = qMin(newSize.width(), newSize.height());
+ if (iconSize == 0) {
+ // Don't store 0 size, let's keep -1 for default/small/automatic
+ iconSize = -1;
+ }
+ PlacesPanelSettings *settings = PlacesPanelSettings::self();
+ settings->setIconSize(iconSize);
+ settings->save();
+ });
}
-PlacesPanel::~PlacesPanel()
+PlacesPanel::~PlacesPanel() = default;
+
+void PlacesPanel::setUrl(const QUrl &url)
{
+ // KFilePlacesView::setUrl no-ops when no model is set but we only set it in showEvent()
+ // Remember the URL and set it in showEvent
+ m_url = url;
+ KFilePlacesView::setUrl(url);
}
-bool PlacesPanel::urlChanged()
+QList<QAction *> PlacesPanel::customContextMenuActions() const
{
- return true;
+ return m_customContextMenuActions;
}
-void PlacesPanel::showEvent(QShowEvent* event)
+void PlacesPanel::setCustomContextMenuActions(const QList<QAction *> &actions)
{
- if (event->spontaneous()) {
- Panel::showEvent(event);
- return;
+ m_customContextMenuActions = actions;
+}
+
+void PlacesPanel::proceedWithTearDown()
+{
+ if (m_indexToTearDown.isValid()) {
+ auto *placesModel = static_cast<KFilePlacesModel *>(model());
+ placesModel->requestTeardown(m_indexToTearDown);
+ } else {
+ qWarning() << "Places entry to tear down is no longer valid";
+ }
+}
+
+void PlacesPanel::readSettings()
+{
+ if (GeneralSettings::autoExpandFolders()) {
+ setDragAutoActivationDelay(750);
+ } else {
+ setDragAutoActivationDelay(0);
}
- if (!m_controller) {
- // Postpone the creating of the controller to the first show event.
- // This assures that no performance and memory overhead is given when the folders panel is not
- // used at all and stays invisible.
- m_model = new PlacesItemModel(this);
- m_model->setGroupedSorting(true);
- m_model->setSortRole("group");
+ const int iconSize = qMax(0, PlacesPanelSettings::iconSize());
+ setIconSize(QSize(iconSize, iconSize));
+}
- KStandardItemListView* view = new KStandardItemListView();
- view->setGroupHeaderCreator(new KItemListGroupHeaderCreator<PlacesItemListGroupHeader>());
+void PlacesPanel::showEvent(QShowEvent *event)
+{
+ if (!event->spontaneous() && !model()) {
+ readSettings();
- m_controller = new KItemListController(m_model, view, this);
- m_controller->setSelectionBehavior(KItemListController::SingleSelection);
- connect(m_controller, SIGNAL(itemActivated(int)), this, SLOT(slotItemActivated(int)));
- connect(m_controller, SIGNAL(itemMiddleClicked(int)), this, SLOT(slotItemMiddleClicked(int)));
- connect(m_controller, SIGNAL(itemContextMenuRequested(int,QPointF)), this, SLOT(slotItemContextMenuRequested(int,QPointF)));
- connect(m_controller, SIGNAL(viewContextMenuRequested(QPointF)), this, SLOT(slotViewContextMenuRequested(QPointF)));
+ auto *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
+ setModel(placesModel);
- KItemListContainer* container = new KItemListContainer(m_controller, this);
- container->setEnabledFrame(false);
+ connect(placesModel, &KFilePlacesModel::errorMessage, this, &PlacesPanel::errorMessage);
+ connect(placesModel, &KFilePlacesModel::teardownDone, this, &PlacesPanel::slotTearDownDone);
- QVBoxLayout* layout = new QVBoxLayout(this);
- layout->setMargin(0);
- layout->addWidget(container);
+ connect(placesModel, &QAbstractItemModel::rowsInserted, this, &PlacesPanel::slotRowsInserted);
+ connect(placesModel, &QAbstractItemModel::rowsAboutToBeRemoved, this, &PlacesPanel::slotRowsAboutToBeRemoved);
- selectClosestItem();
+ for (int i = 0; i < model()->rowCount(); ++i) {
+ connectDeviceSignals(model()->index(i, 0, QModelIndex()));
+ }
+
+ setUrl(m_url);
}
- Panel::showEvent(event);
+ KFilePlacesView::showEvent(event);
}
-void PlacesPanel::slotItemActivated(int index)
+static bool isInternalDrag(const QMimeData *mimeData)
{
- const KUrl url = m_model->data(index).value("url").value<KUrl>();
- if (!url.isEmpty()) {
- emit placeActivated(url);
+ const auto formats = mimeData->formats();
+ for (const auto &format : formats) {
+ // from KFilePlacesModel::_k_internalMimetype
+ if (format.startsWith(QLatin1String("application/x-kfileplacesmodel-"))) {
+ return true;
+ }
}
+ return false;
}
-void PlacesPanel::slotItemMiddleClicked(int index)
+void PlacesPanel::dragMoveEvent(QDragMoveEvent *event)
{
- const KUrl url = m_model->data(index).value("url").value<KUrl>();
- if (!url.isEmpty()) {
- emit placeMiddleClicked(url);
+ const QModelIndex index = indexAt(event->position().toPoint());
+ if (index.isValid()) {
+ auto *placesModel = static_cast<KFilePlacesModel *>(model());
+
+ // Reject drag ontop of a non-writable protocol
+ // We don't know whether we're dropping inbetween or ontop of a place
+ // so still allow internal drag events so that re-arranging still works.
+ const QUrl url = placesModel->url(index);
+ if (url.isValid() && !isInternalDrag(event->mimeData()) && !KProtocolManager::supportsWriting(url)) {
+ event->setDropAction(Qt::IgnoreAction);
+ }
}
+
+ KFilePlacesView::dragMoveEvent(event);
}
-void PlacesPanel::slotItemContextMenuRequested(int index, const QPointF& pos)
+void PlacesPanel::slotConfigureTrash()
{
- const QHash<QByteArray, QVariant> data = m_model->data(index);
- const QString label = data.value("text").toString();
-
- KMenu menu(this);
-
- QAction* emptyTrashAction = 0;
- QAction* addAction = 0;
- QAction* mainSeparator = 0;
- QAction* editAction = 0;
- QAction* tearDownAction = 0;
- QAction* ejectAction = 0;
-
- const bool isSystemItem = m_model->isSystemItem(index);
- const bool isDevice = !data.value("udi").toString().isEmpty();
- if (isDevice) {
- ejectAction = m_model->ejectAction(index);
- if (ejectAction) {
- ejectAction->setParent(&menu);
- menu.addAction(ejectAction);
- }
-
- tearDownAction = m_model->tearDownAction(index);
- if (tearDownAction) {
- tearDownAction->setParent(&menu);
- menu.addAction(tearDownAction);
- }
+ const QUrl url = currentIndex().data(KFilePlacesModel::UrlRole).toUrl();
- if (tearDownAction || ejectAction) {
- mainSeparator = menu.addSeparator();
- }
- } else {
- if (data.value("url").value<KUrl>() == KUrl("trash:/")) {
- emptyTrashAction = menu.addAction(KIcon("trash-empty"), i18nc("@action:inmenu", "Empty Trash"));
- KConfig trashConfig("trashrc", KConfig::SimpleConfig);
- emptyTrashAction->setEnabled(!trashConfig.group("Status").readEntry("Empty", true));
- menu.addSeparator();
- }
- addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
- if (!isSystemItem) {
- mainSeparator = menu.addSeparator();
- editAction = menu.addAction(KIcon("document-properties"), i18nc("@item:inmenu", "Edit Entry '%1'...", label));
- }
- }
+ DolphinSettingsDialog *settingsDialog = new DolphinSettingsDialog(url, this);
+ settingsDialog->setCurrentPage(settingsDialog->trashSettings);
+ settingsDialog->setAttribute(Qt::WA_DeleteOnClose);
+ settingsDialog->show();
+}
- if (!addAction) {
- addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
+void PlacesPanel::slotUrlsDropped(const QUrl &dest, QDropEvent *event, QWidget *parent)
+{
+ KIO::DropJob *job = DragAndDropHelper::dropUrls(dest, event, parent);
+ if (job) {
+ connect(job, &KIO::DropJob::result, this, [this](KJob *job) {
+ if (job->error() && job->error() != KIO::ERR_USER_CANCELED) {
+ Q_EMIT errorMessage(job->errorString());
+ }
+ });
}
+}
- QAction* hideAction = menu.addAction(i18nc("@item:inmenu", "Hide Entry '%1'", label));
- hideAction->setCheckable(true);
- //hideEntry->setChecked(data.value("hidden").toBool());
+void PlacesPanel::slotContextMenuAboutToShow(const QModelIndex &index, QMenu *menu)
+{
+ Q_UNUSED(menu);
- QAction* showAllAction = 0;
- if (m_model->hiddenCount() > 0) {
- if (!mainSeparator) {
- mainSeparator = menu.addSeparator();
- }
- showAllAction = menu.addAction(i18nc("@item:inmenu", "Show All Entries"));
- showAllAction->setCheckable(true);
- //showAllEntries->setChecked(showAll)
- }
+ auto *placesModel = static_cast<KFilePlacesModel *>(model());
+ const QUrl url = placesModel->url(index);
+ const Solid::Device device = placesModel->deviceForIndex(index);
- QAction* removeAction = 0;
- if (!isDevice && !isSystemItem) {
- removeAction = menu.addAction(KIcon("edit-delete"), i18nc("@item:inmenu", "Remove Entry '%1'", label));
- }
+ m_configureTrashAction->setVisible(url.scheme() == QLatin1String("trash"));
- menu.addSeparator();
- foreach (QAction* action, customContextMenuActions()) {
- menu.addAction(action);
- }
-
- QAction* action = menu.exec(pos.toPoint());
- if (action) {
- if (action == emptyTrashAction) {
- emptyTrash();
- } else if (action == addAction) {
- addEntry();
- } else if (action == editAction) {
- editEntry(index);
- } else if (action == removeAction) {
- m_model->removeItem(index);
- } else if (action == hideAction) {
- } else if (action == showAllAction) {
- } else if (action == tearDownAction) {
- } else if (action == ejectAction) {
+ // show customContextMenuActions only on the view's context menu
+ if (!url.isValid() && !device.isValid()) {
+ addActions(m_customContextMenuActions);
+ } else {
+ const auto actions = this->actions();
+ for (QAction *action : actions) {
+ if (m_customContextMenuActions.contains(action)) {
+ removeAction(action);
+ }
}
}
-
- selectClosestItem();
}
-void PlacesPanel::slotViewContextMenuRequested(const QPointF& pos)
+void PlacesPanel::slotTearDownRequested(const QModelIndex &index)
{
- KMenu menu(this);
+ auto *placesModel = static_cast<KFilePlacesModel *>(model());
- QAction* addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
- menu.addSeparator();
- foreach (QAction* action, customContextMenuActions()) {
- menu.addAction(action);
+ Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
+ if (!storageAccess) {
+ return;
}
- QAction* action = menu.exec(pos.toPoint());
- if (action == addAction) {
- addEntry();
- }
+ m_indexToTearDown = QPersistentModelIndex(index);
- selectClosestItem();
+ // disconnect the Solid::StorageAccess::teardownRequested
+ // to prevent emitting PlacesPanel::storageTearDownExternallyRequested
+ // after we have emitted PlacesPanel::storageTearDownRequested
+ disconnect(storageAccess, &Solid::StorageAccess::teardownRequested, this, &PlacesPanel::slotTearDownRequestedExternally);
+ Q_EMIT storageTearDownRequested(storageAccess->filePath());
}
-void PlacesPanel::slotUrlsDropped(const KUrl& dest, QDropEvent* event, QWidget* parent)
+void PlacesPanel::slotTearDownRequestedExternally(const QString &udi)
{
- Q_UNUSED(parent);
- const QString error = DragAndDropHelper::dropUrls(KFileItem(), dest, event);
- if (!error.isEmpty()) {
- emit errorMessage(error);
- }
+ Q_UNUSED(udi);
+ auto *storageAccess = static_cast<Solid::StorageAccess *>(sender());
+ Q_EMIT storageTearDownExternallyRequested(storageAccess->filePath());
}
-void PlacesPanel::slotTrashUpdated(KJob* job)
+void PlacesPanel::slotTearDownDone(const QModelIndex &index, Solid::ErrorType error, const QVariant &errorData)
{
- if (job->error()) {
- // TODO: Show error-string inside Dolphin, don't use job->ui->showErrorMessage().
+ Q_UNUSED(errorData); // All error handling is currently done in frameworks.
+
+ if (index == m_indexToTearDown) {
+ if (error == Solid::ErrorType::NoError) {
+ // No error; it must have been unmounted successfully
+ Q_EMIT storageTearDownSuccessful();
+ }
+ m_indexToTearDown = QPersistentModelIndex();
}
- org::kde::KDirNotify::emitFilesAdded("trash:/");
}
-void PlacesPanel::emptyTrash()
+void PlacesPanel::slotRowsInserted(const QModelIndex &parent, int first, int last)
{
- const QString text = i18nc("@info", "Do you really want to empty the Trash? All items will be deleted.");
- const bool del = KMessageBox::warningContinueCancel(window(),
- text,
- QString(),
- KGuiItem(i18nc("@action:button", "Empty Trash"),
- KIcon("user-trash"))
- ) == KMessageBox::Continue;
- if (del) {
- QByteArray packedArgs;
- QDataStream stream(&packedArgs, QIODevice::WriteOnly);
- stream << int(1);
- KIO::Job *job = KIO::special(KUrl("trash:/"), packedArgs);
- KNotification::event("Trash: emptied", QString() , QPixmap() , 0, KNotification::DefaultEvent);
- job->ui()->setWindow(parentWidget());
- connect(job, SIGNAL(result(KJob*)), SLOT(slotTrashUpdated(KJob*)));
+ for (int i = first; i <= last; ++i) {
+ connectDeviceSignals(model()->index(first, 0, parent));
}
}
-void PlacesPanel::addEntry()
+void PlacesPanel::slotRowsAboutToBeRemoved(const QModelIndex &parent, int first, int last)
{
- const int index = m_controller->selectionManager()->currentItem();
- const KUrl url = m_model->data(index).value("url").value<KUrl>();
-
- QPointer<PlacesItemEditDialog> dialog = new PlacesItemEditDialog(this);
- dialog->setCaption(i18nc("@title:window", "Add Places Entry"));
- dialog->setAllowGlobal(true);
- dialog->setUrl(url);
- if (dialog->exec() == QDialog::Accepted) {
- KStandardItem* item = createStandardItemFromDialog(dialog);
-
- // Insert the item as last item of the corresponding group.
- int i = 0;
- while (i < m_model->count() && m_model->item(i)->group() != item->group()) {
- ++i;
- }
+ auto *placesModel = static_cast<KFilePlacesModel *>(model());
- bool inserted = false;
- while (!inserted && i < m_model->count()) {
- if (m_model->item(i)->group() != item->group()) {
- m_model->insertItem(i, item);
- inserted = true;
- }
- ++i;
- }
+ for (int i = first; i <= last; ++i) {
+ const QModelIndex index = placesModel->index(i, 0, parent);
- if (!inserted) {
- m_model->appendItem(item);
+ Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
+ if (!storageAccess) {
+ continue;
}
- }
-
- delete dialog;
-}
-void PlacesPanel::editEntry(int index)
-{
- QHash<QByteArray, QVariant> data = m_model->data(index);
-
- QPointer<PlacesItemEditDialog> dialog = new PlacesItemEditDialog(this);
- dialog->setCaption(i18nc("@title:window", "Edit Places Entry"));
- dialog->setIcon(data.value("iconName").toString());
- dialog->setText(data.value("text").toString());
- dialog->setUrl(data.value("url").value<KUrl>());
- dialog->setAllowGlobal(true);
- if (dialog->exec() == QDialog::Accepted) {
- KStandardItem* oldItem = m_model->item(index);
- if (oldItem) {
- KStandardItem* item = createStandardItemFromDialog(dialog);
- // Although the user might have changed the URL of the item in a way
- // that another group should be assigned, we still apply the old
- // group to keep the same position for the item.
- item->setGroup(oldItem->group());
- m_model->replaceItem(index, item);
- }
+ disconnect(storageAccess, &Solid::StorageAccess::teardownRequested, this, nullptr);
}
-
- delete dialog;
-}
-
-void PlacesPanel::selectClosestItem()
-{
- const int index = m_model->closestItem(url());
- KItemListSelectionManager* selectionManager = m_controller->selectionManager();
- selectionManager->setCurrentItem(index);
- selectionManager->clearSelection();
- selectionManager->setSelected(index);
}
-KStandardItem* PlacesPanel::createStandardItemFromDialog(PlacesItemEditDialog* dialog) const
+void PlacesPanel::connectDeviceSignals(const QModelIndex &index)
{
- Q_ASSERT(dialog);
+ auto *placesModel = static_cast<KFilePlacesModel *>(model());
- const KUrl newUrl = dialog->url();
- KStandardItem* item = new KStandardItem();
- item->setIcon(KIcon(dialog->icon()));
- item->setText(dialog->text());
- item->setDataValue("url", newUrl);
- item->setGroup(m_model->groupName(newUrl));
+ Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
+ if (!storageAccess) {
+ return;
+ }
- return item;
+ connect(storageAccess, &Solid::StorageAccess::teardownRequested, this, &PlacesPanel::slotTearDownRequestedExternally);
}
-#include "placespanel.moc"
+#include "moc_placespanel.cpp"
projects / dolphin.git / blobdiff