previews: Add `EnableRemoteFolderThumbnail` option

This option allows to enable preview for locally mounted remote folders

Setting was added in kio: frameworks/kio/#c7d6ff8f218a0c063f762bd236453a7ae00b817e

diff --git a/src/settings/interface/previewssettingspage.cpp b/src/settings/interface/previewssettingspage.cpp
index dd1ce942e076ee94898addf935e2ce2b94dad308..217ce37e32141f59e437503b5c8d037364751a52 100644 (file)
--- a/src/settings/interface/previewssettingspage.cpp
+++ b/src/settings/interface/previewssettingspage.cpp
@@ -9,10 +9,13 @@
 #include "dolphin_generalsettings.h"
 #include "settings/servicemodel.h"
 
+#include <KContextualHelpButton>
 #include <KIO/PreviewJob>
 #include <KLocalizedString>
 #include <KPluginMetaData>
 
+#include <QCheckBox>
+#include <QFormLayout>
 #include <QHBoxLayout>
 #include <QLabel>
 #include <QListView>
@@ -26,6 +29,7 @@ namespace
 {
 const int DefaultMaxLocalPreviewSize = 0; // 0 MB
 const int DefaultMaxRemotePreviewSize = 0; // 0 MB
+const bool EnableRemoteFolderThumbnail = false;
 }
 
 PreviewsSettingsPage::PreviewsSettingsPage(QWidget *parent)
@@ -35,6 +39,7 @@ PreviewsSettingsPage::PreviewsSettingsPage(QWidget *parent)
     , m_enabledPreviewPlugins()
     , m_localFileSizeBox(nullptr)
     , m_remoteFileSizeBox(nullptr)
+    , m_enableRemoteFolderThumbnail(nullptr)
 {
     QVBoxLayout *topLayout = new QVBoxLayout(this);
 
@@ -53,42 +58,81 @@ PreviewsSettingsPage::PreviewsSettingsPage(QWidget *parent)
     m_listView->setVerticalScrollMode(QListView::ScrollPerPixel);
     m_listView->setUniformItemSizes(true);
 
-    QLabel *localFileSizeLabel = new QLabel(i18n("Skip previews for local files above:"), this);
+    // i18n: This label forms a full sentence together with the spinbox content.
+    // Depending on the option chosen in the spinbox, it reads "Show previews for [files below n MiB]"
+    // or "Show previews for [files of any size]".
+    QLabel *localFileSizeLabel = new QLabel(i18nc("@label:spinbox", "Show previews for"), this);
 
     m_localFileSizeBox = new QSpinBox(this);
     m_localFileSizeBox->setSingleStep(1);
+    m_localFileSizeBox->setPrefix(i18nc("used as a prefix in a spinbox showing e.g. 'Show previews for [files below 3 MiB]'", "files below "));
     m_localFileSizeBox->setSuffix(i18nc("Mebibytes; used as a suffix in a spinbox showing e.g. '3 MiB'", " MiB"));
     m_localFileSizeBox->setRange(0, 9999999); /* MB */
-    m_localFileSizeBox->setSpecialValueText(i18n("No limit"));
+    m_localFileSizeBox->setSpecialValueText(i18nc("e.g. 'Show previews for [files of any size]'", "files of any size"));
 
     QHBoxLayout *localFileSizeBoxLayout = new QHBoxLayout();
     localFileSizeBoxLayout->addWidget(localFileSizeLabel);
-    localFileSizeBoxLayout->addStretch(0);
     localFileSizeBoxLayout->addWidget(m_localFileSizeBox);
 
-    QLabel *remoteFileSizeLabel = new QLabel(i18nc("@label", "Skip previews for remote files above:"), this);
+    QLabel *remoteFileSizeLabel = new QLabel(i18nc("@label:spinbox", "Show previews for"), this);
 
     m_remoteFileSizeBox = new QSpinBox(this);
     m_remoteFileSizeBox->setSingleStep(1);
+    m_remoteFileSizeBox->setPrefix(i18nc("used as a prefix in a spinbox showing e.g. 'Show previews for [files below 3 MiB]'", "files below "));
     m_remoteFileSizeBox->setSuffix(i18nc("Mebibytes; used as a suffix in a spinbox showing e.g. '3 MiB'", " MiB"));
     m_remoteFileSizeBox->setRange(0, 9999999); /* MB */
-    m_remoteFileSizeBox->setSpecialValueText(i18n("No previews"));
+    m_remoteFileSizeBox->setSpecialValueText(i18nc("e.g. 'Show previews for [no file]'", "no file"));
 
     QHBoxLayout *remoteFileSizeBoxLayout = new QHBoxLayout();
     remoteFileSizeBoxLayout->addWidget(remoteFileSizeLabel);
-    remoteFileSizeBoxLayout->addStretch(0);
     remoteFileSizeBoxLayout->addWidget(m_remoteFileSizeBox);
 
+    // Enable remote folder thumbnail option
+    m_enableRemoteFolderThumbnail = new QCheckBox(i18nc("@option:check", "Show previews for folders"), this);
+
+    // Make the "Enable preview for remote folder" enabled only when "Remote file limit" is superior to 0
+    m_enableRemoteFolderThumbnail->setEnabled(m_remoteFileSizeBox->value() > 0);
+    connect(m_remoteFileSizeBox, &QSpinBox::valueChanged, this, [this](int i) {
+        m_enableRemoteFolderThumbnail->setEnabled(i > 0);
+    });
+
+    const auto helpButtonInfo = xi18nc("@info",
+                                       "<para>Creating <emphasis>previews</emphasis> for remote folders is "
+                                       "<emphasis strong='true'>very expensive</emphasis> in terms of network "
+                                       "resources.</para><para>Disable this if navigating remote folders in "
+                                       "Dolphin is slow or when accessing storage over metered connections.</para>");
+    auto contextualHelpButton = new KContextualHelpButton{helpButtonInfo, m_enableRemoteFolderThumbnail, this};
+
+    QHBoxLayout *enableRemoteFolderThumbnailLayout = new QHBoxLayout();
+    enableRemoteFolderThumbnailLayout->addWidget(m_enableRemoteFolderThumbnail);
+    enableRemoteFolderThumbnailLayout->addWidget(contextualHelpButton);
+
+    QFormLayout *formLayout = new QFormLayout(this);
+
+    QLabel *localGroupLabel = new QLabel(i18nc("@title:group", "Local storage:"));
+    // Makes sure it has the same height as the labeled sizeBoxLayout
+    localGroupLabel->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding);
+    formLayout->addRow(localGroupLabel, localFileSizeBoxLayout);
+
+    QLabel *remoteGroupLabel = new QLabel(i18nc("@title:group", "Remote storage:"));
+    remoteGroupLabel->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding);
+    formLayout->addRow(remoteGroupLabel, remoteFileSizeBoxLayout);
+
+    formLayout->addRow(QString(), enableRemoteFolderThumbnailLayout);
+
     topLayout->addWidget(showPreviewsLabel);
     topLayout->addWidget(m_listView);
-    topLayout->addLayout(localFileSizeBoxLayout);
-    topLayout->addLayout(remoteFileSizeBoxLayout);
+    topLayout->addLayout(formLayout);
+
+    // So that m_listView takes up all available space
+    topLayout->setStretchFactor(m_listView, 1);
 
     loadSettings();
 
     connect(m_listView, &QListView::clicked, this, &PreviewsSettingsPage::changed);
     connect(m_localFileSizeBox, &QSpinBox::valueChanged, this, &PreviewsSettingsPage::changed);
     connect(m_remoteFileSizeBox, &QSpinBox::valueChanged, this, &PreviewsSettingsPage::changed);
+    connect(m_enableRemoteFolderThumbnail, &QCheckBox::toggled, this, &PreviewsSettingsPage::changed);
 }
 
 PreviewsSettingsPage::~PreviewsSettingsPage()
@@ -124,6 +168,8 @@ void PreviewsSettingsPage::applySettings()
     const qulonglong maximumRemoteSize = static_cast<qulonglong>(m_remoteFileSizeBox->value()) * 1024 * 1024;
     globalConfig.writeEntry("MaximumRemoteSize", maximumRemoteSize, KConfigBase::Normal | KConfigBase::Global);
 
+    globalConfig.writeEntry("EnableRemoteFolderThumbnail", m_enableRemoteFolderThumbnail->isChecked(), KConfigBase::Normal | KConfigBase::Global);
+
     globalConfig.sync();
 }
 
@@ -131,6 +177,7 @@ void PreviewsSettingsPage::restoreDefaults()
 {
     m_localFileSizeBox->setValue(DefaultMaxLocalPreviewSize);
     m_remoteFileSizeBox->setValue(DefaultMaxRemotePreviewSize);
+    m_enableRemoteFolderThumbnail->setChecked(EnableRemoteFolderThumbnail);
 }
 
 void PreviewsSettingsPage::showEvent(QShowEvent *event)
@@ -174,6 +221,8 @@ void PreviewsSettingsPage::loadSettings()
     const qulonglong maxRemoteByteSize = globalConfig.readEntry("MaximumRemoteSize", defaultRemotePreview);
     const int maxRemoteMByteSize = maxRemoteByteSize / (1024 * 1024);
     m_remoteFileSizeBox->setValue(maxRemoteMByteSize);
+
+    m_enableRemoteFolderThumbnail->setChecked(globalConfig.readEntry("EnableRemoteFolderThumbnail", EnableRemoteFolderThumbnail));
 }
 
 #include "moc_previewssettingspage.cpp"

diff --git a/src/settings/interface/previewssettingspage.h b/src/settings/interface/previewssettingspage.h
index d6d22ae218d95dd2e63d025fc9878519b426443c..bfe92bac8f4371a59c644751b9bae03a1f1b7809 100644 (file)
--- a/src/settings/interface/previewssettingspage.h
+++ b/src/settings/interface/previewssettingspage.h
@@ -11,6 +11,7 @@
 
 #include "settings/settingspagebase.h"
 
+class QCheckBox;
 class QSpinBox;
 class QListView;
 class QModelIndex;
@@ -51,6 +52,7 @@ private:
     QStringList m_enabledPreviewPlugins;
     QSpinBox *m_localFileSizeBox;
     QSpinBox *m_remoteFileSizeBox;
+    QCheckBox *m_enableRemoteFolderThumbnail;
 };
 
 #endif