src/settings/viewpropertiesdialog.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2006 Peter Penz <peter.penz@gmx.at>
   3  * SPDX-FileCopyrightText: 2018 Elvis Angelaccio <elvis.angelaccio@kde.org>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-or-later
   6  */
   7
   8 #include "viewpropertiesdialog.h"
   9
  10 #include "dolphin_generalsettings.h"
  11 #include "global.h"
  12 #include "kitemviews/kfileitemmodel.h"
  13 #include "viewpropsprogressinfo.h"
  14 #include "views/dolphinview.h"
  15
  16 #include <KCollapsibleGroupBox>
  17 #include <KLocalizedString>
  18 #include <KMessageBox>
  19 #include <KWindowConfig>
  20
  21 #include <kwidgetsaddons_version.h>
  22
  23 #if HAVE_BALOO
  24 #include <Baloo/IndexerConfig>
  25 #endif
  26
  27 #include <QButtonGroup>
  28 #include <QCheckBox>
  29 #include <QComboBox>
  30 #include <QFormLayout>
  31 #include <QLabel>
  32 #include <QListWidget>
  33 #include <QPushButton>
  34 #include <QRadioButton>
  35 #include <QSpacerItem>
  36
  37 #include <views/viewproperties.h>
  38
  39 ViewPropertiesDialog::ViewPropertiesDialog(DolphinView *dolphinView)
  40     : QDialog(dolphinView)
  41     , m_isDirty(false)
  42     , m_dolphinView(dolphinView)
  43     , m_viewProps(nullptr)
  44     , m_viewMode(nullptr)
  45     , m_sortOrder(nullptr)
  46     , m_sorting(nullptr)
  47     , m_sortFoldersFirst(nullptr)
  48     , m_sortHiddenLast(nullptr)
  49     , m_previewsShown(nullptr)
  50     , m_showInGroups(nullptr)
  51     , m_showHiddenFiles(nullptr)
  52     , m_applyToCurrentFolder(nullptr)
  53     , m_applyToSubFolders(nullptr)
  54     , m_applyToAllFolders(nullptr)
  55     , m_useAsDefault(nullptr)
  56 {
  57     Q_ASSERT(dolphinView);
  58     const bool useGlobalViewProps = GeneralSettings::globalViewProps();
  59
  60     setWindowTitle(i18nc("@title:window", "View Display Style"));
  61
  62     const QUrl &url = dolphinView->url();
  63     m_viewProps = new ViewProperties(url);
  64     m_viewProps->setAutoSaveEnabled(false);
  65
  66     auto layout = new QFormLayout(this);
  67     // Otherwise the dialog won't resize when we collapse the KCollapsibleGroupBox.
  68     layout->setSizeConstraint(QLayout::SetFixedSize);
  69
  70     // create 'Properties' group containing view mode, sorting, sort order and show hidden files
  71     m_viewMode = new QComboBox();
  72     m_viewMode->addItem(QIcon::fromTheme(QStringLiteral("view-list-icons")), i18nc("@item:inlistbox", "Icons"), DolphinView::IconsView);
  73     m_viewMode->addItem(QIcon::fromTheme(QStringLiteral("view-list-details")), i18nc("@item:inlistbox", "Compact"), DolphinView::CompactView);
  74     m_viewMode->addItem(QIcon::fromTheme(QStringLiteral("view-list-tree")), i18nc("@item:inlistbox", "Details"), DolphinView::DetailsView);
  75
  76     m_sortOrder = new QComboBox();
  77     m_sortOrder->addItem(i18nc("@item:inlistbox Sort", "Ascending"));
  78     m_sortOrder->addItem(i18nc("@item:inlistbox Sort", "Descending"));
  79
  80     m_sorting = new QComboBox();
  81     const QList<KFileItemModel::RoleInfo> rolesInfo = KFileItemModel::rolesInformation();
  82     for (const KFileItemModel::RoleInfo &info : rolesInfo) {
  83         m_sorting->addItem(info.translation, info.role);
  84     }
  85
  86     m_sortFoldersFirst = new QCheckBox(i18nc("@option:check", "Show folders first"));
  87     m_sortHiddenLast = new QCheckBox(i18nc("@option:check", "Show hidden files last"));
  88     m_previewsShown = new QCheckBox(i18nc("@option:check", "Show preview"));
  89     m_showInGroups = new QCheckBox(i18nc("@option:check", "Show in groups"));
  90     m_showHiddenFiles = new QCheckBox(i18nc("@option:check", "Show hidden files"));
  91
  92     auto additionalInfoBox = new KCollapsibleGroupBox();
  93     additionalInfoBox->setTitle(i18nc("@title:group", "Additional Information"));
  94     auto innerLayout = new QVBoxLayout(additionalInfoBox);
  95
  96     {
  97         QList<QByteArray> visibleRoles = m_viewProps->visibleRoles();
  98         const bool useDefaultRoles = (m_viewProps->viewMode() == DolphinView::DetailsView) && visibleRoles.isEmpty();
  99         if (useDefaultRoles) {
 100             // Using the details view without any additional information (-> additional column)
 101             // makes no sense and leads to a usability problem as no viewport area is available
 102             // anymore. Hence as fallback provide at least a size and date column.
 103             visibleRoles.clear();
 104             visibleRoles.append("text");
 105             visibleRoles.append("size");
 106             visibleRoles.append("modificationtime");
 107             m_viewProps->setVisibleRoles(visibleRoles);
 108         }
 109
 110         // Add checkboxes
 111         bool indexingEnabled = false;
 112 #if HAVE_BALOO
 113         Baloo::IndexerConfig config;
 114         indexingEnabled = config.fileIndexingEnabled();
 115 #endif
 116
 117         m_listWidget = new QListWidget();
 118         connect(m_listWidget, &QListWidget::itemChanged, this, &ViewPropertiesDialog::slotItemChanged);
 119         m_listWidget->setSelectionMode(QAbstractItemView::NoSelection);
 120         const QList<KFileItemModel::RoleInfo> rolesInfo = KFileItemModel::rolesInformation();
 121         for (const KFileItemModel::RoleInfo &info : rolesInfo) {
 122             QListWidgetItem *item = new QListWidgetItem(info.translation, m_listWidget);
 123             item->setCheckState(visibleRoles.contains(info.role) ? Qt::Checked : Qt::Unchecked);
 124
 125             const bool enable =
 126                 ((!info.requiresBaloo && !info.requiresIndexer) || (info.requiresBaloo) || (info.requiresIndexer && indexingEnabled)) && info.role != "text";
 127
 128             if (!enable) {
 129                 item->setFlags(item->flags() & ~Qt::ItemIsEnabled);
 130             }
 131         }
 132         QLabel *additionalViewOptionsLabel = new QLabel(i18n("Choose what to see on each file or folder:"));
 133         innerLayout->addWidget(additionalViewOptionsLabel);
 134         innerLayout->addWidget(m_listWidget);
 135     }
 136
 137     QHBoxLayout *sortingLayout = new QHBoxLayout();
 138     sortingLayout->setContentsMargins(0, 0, 0, 0);
 139     sortingLayout->addWidget(m_sortOrder);
 140     sortingLayout->addWidget(m_sorting);
 141
 142     layout->addRow(i18nc("@label:listbox", "View mode:"), m_viewMode);
 143     layout->addRow(i18nc("@label:listbox", "Sorting:"), sortingLayout);
 144
 145     layout->addItem(new QSpacerItem(0, Dolphin::VERTICAL_SPACER_HEIGHT, QSizePolicy::Fixed, QSizePolicy::Fixed));
 146
 147     layout->addRow(i18n("View options:"), m_sortFoldersFirst);
 148     layout->addRow(QString(), m_previewsShown);
 149     layout->addRow(QString(), m_showInGroups);
 150     layout->addRow(QString(), m_showHiddenFiles);
 151     layout->addRow(QString(), m_sortHiddenLast);
 152
 153     connect(m_viewMode, &QComboBox::currentIndexChanged, this, &ViewPropertiesDialog::slotViewModeChanged);
 154     connect(m_sorting, &QComboBox::currentIndexChanged, this, &ViewPropertiesDialog::slotSortingChanged);
 155     connect(m_sortOrder, &QComboBox::currentIndexChanged, this, &ViewPropertiesDialog::slotSortOrderChanged);
 156     connect(m_sortFoldersFirst, &QCheckBox::clicked, this, &ViewPropertiesDialog::slotSortFoldersFirstChanged);
 157     connect(m_sortHiddenLast, &QCheckBox::clicked, this, &ViewPropertiesDialog::slotSortHiddenLastChanged);
 158     connect(m_previewsShown, &QCheckBox::clicked, this, &ViewPropertiesDialog::slotShowPreviewChanged);
 159     connect(m_showInGroups, &QCheckBox::clicked, this, &ViewPropertiesDialog::slotGroupedSortingChanged);
 160     connect(m_showHiddenFiles, &QCheckBox::clicked, this, &ViewPropertiesDialog::slotShowHiddenFilesChanged);
 161
 162     // Only show the following settings if the view properties are remembered
 163     // for each directory:
 164     if (!useGlobalViewProps) {
 165         // create 'Apply View Properties To' group
 166         m_applyToCurrentFolder = new QRadioButton(i18nc("@option:radio Apply View Properties To", "Current folder"));
 167         m_applyToCurrentFolder->setChecked(true);
 168         m_applyToSubFolders = new QRadioButton(i18nc("@option:radio Apply View Properties To", "Current folder and sub-folders"));
 169         m_applyToAllFolders = new QRadioButton(i18nc("@option:radio Apply View Properties To", "All folders"));
 170
 171         QButtonGroup *applyGroup = new QButtonGroup(this);
 172         applyGroup->addButton(m_applyToCurrentFolder);
 173         applyGroup->addButton(m_applyToSubFolders);
 174         applyGroup->addButton(m_applyToAllFolders);
 175
 176         layout->addItem(new QSpacerItem(0, Dolphin::VERTICAL_SPACER_HEIGHT, QSizePolicy::Fixed, QSizePolicy::Fixed));
 177
 178         layout->addRow(i18nc("@title:group", "Apply to:"), m_applyToCurrentFolder);
 179         layout->addRow(QString(), m_applyToSubFolders);
 180         layout->addRow(QString(), m_applyToAllFolders);
 181         layout->addRow(QString(), m_applyToAllFolders);
 182
 183         m_useAsDefault = new QCheckBox(i18nc("@option:check", "Use as default view settings"), this);
 184         layout->addRow(QString(), m_useAsDefault);
 185
 186         connect(m_applyToCurrentFolder, &QRadioButton::clicked, this, &ViewPropertiesDialog::markAsDirty);
 187         connect(m_applyToSubFolders, &QRadioButton::clicked, this, &ViewPropertiesDialog::markAsDirty);
 188         connect(m_applyToAllFolders, &QRadioButton::clicked, this, &ViewPropertiesDialog::markAsDirty);
 189         connect(m_useAsDefault, &QCheckBox::clicked, this, &ViewPropertiesDialog::markAsDirty);
 190     }
 191
 192     layout->addItem(new QSpacerItem(0, Dolphin::VERTICAL_SPACER_HEIGHT, QSizePolicy::Fixed, QSizePolicy::Fixed));
 193
 194     layout->addRow(additionalInfoBox);
 195
 196     auto buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Apply, this);
 197     connect(buttonBox, &QDialogButtonBox::accepted, this, &ViewPropertiesDialog::accept);
 198     connect(buttonBox, &QDialogButtonBox::rejected, this, &ViewPropertiesDialog::reject);
 199     layout->addWidget(buttonBox);
 200
 201     auto okButton = buttonBox->button(QDialogButtonBox::Ok);
 202     okButton->setShortcut(Qt::CTRL | Qt::Key_Return);
 203     okButton->setDefault(true);
 204
 205     auto applyButton = buttonBox->button(QDialogButtonBox::Apply);
 206     applyButton->setEnabled(false);
 207     connect(applyButton, &QPushButton::clicked, this, &ViewPropertiesDialog::slotApply);
 208     connect(this, &ViewPropertiesDialog::isDirtyChanged, applyButton, [applyButton](bool isDirty) {
 209         applyButton->setEnabled(isDirty);
 210     });
 211
 212     const KConfigGroup dialogConfig(KSharedConfig::openConfig(QStringLiteral("dolphinrc")), "ViewPropertiesDialog");
 213     KWindowConfig::restoreWindowSize(windowHandle(), dialogConfig);
 214
 215     loadSettings();
 216 }
 217
 218 ViewPropertiesDialog::~ViewPropertiesDialog()
 219 {
 220     m_isDirty = false;
 221     delete m_viewProps;
 222     m_viewProps = nullptr;
 223
 224     KConfigGroup dialogConfig(KSharedConfig::openConfig(QStringLiteral("dolphinrc")), "ViewPropertiesDialog");
 225     KWindowConfig::saveWindowSize(windowHandle(), dialogConfig);
 226 }
 227
 228 void ViewPropertiesDialog::accept()
 229 {
 230     applyViewProperties();
 231     QDialog::accept();
 232 }
 233
 234 void ViewPropertiesDialog::slotApply()
 235 {
 236     applyViewProperties();
 237     markAsDirty(false);
 238 }
 239
 240 void ViewPropertiesDialog::slotViewModeChanged(int index)
 241 {
 242     const QVariant itemData = m_viewMode->itemData(index);
 243     const DolphinView::Mode viewMode = static_cast<DolphinView::Mode>(itemData.toInt());
 244     m_viewProps->setViewMode(viewMode);
 245     markAsDirty(true);
 246 }
 247
 248 void ViewPropertiesDialog::slotSortingChanged(int index)
 249 {
 250     const QByteArray role = m_sorting->itemData(index).toByteArray();
 251     m_viewProps->setSortRole(role);
 252     markAsDirty(true);
 253 }
 254
 255 void ViewPropertiesDialog::slotSortOrderChanged(int index)
 256 {
 257     const Qt::SortOrder sortOrder = (index == 0) ? Qt::AscendingOrder : Qt::DescendingOrder;
 258     m_viewProps->setSortOrder(sortOrder);
 259     markAsDirty(true);
 260 }
 261
 262 void ViewPropertiesDialog::slotGroupedSortingChanged()
 263 {
 264     m_viewProps->setGroupedSorting(m_showInGroups->isChecked());
 265     markAsDirty(true);
 266 }
 267
 268 void ViewPropertiesDialog::slotSortFoldersFirstChanged()
 269 {
 270     const bool foldersFirst = m_sortFoldersFirst->isChecked();
 271     m_viewProps->setSortFoldersFirst(foldersFirst);
 272     markAsDirty(true);
 273 }
 274
 275 void ViewPropertiesDialog::slotSortHiddenLastChanged()
 276 {
 277     const bool hiddenLast = m_sortHiddenLast->isChecked();
 278     m_viewProps->setSortHiddenLast(hiddenLast);
 279     markAsDirty(true);
 280 }
 281
 282 void ViewPropertiesDialog::slotShowPreviewChanged()
 283 {
 284     const bool show = m_previewsShown->isChecked();
 285     m_viewProps->setPreviewsShown(show);
 286     markAsDirty(true);
 287 }
 288
 289 void ViewPropertiesDialog::slotShowHiddenFilesChanged()
 290 {
 291     const bool show = m_showHiddenFiles->isChecked();
 292     m_viewProps->setHiddenFilesShown(show);
 293     markAsDirty(true);
 294 }
 295
 296 void ViewPropertiesDialog::slotItemChanged(QListWidgetItem *item)
 297 {
 298     Q_UNUSED(item)
 299     markAsDirty(true);
 300 }
 301
 302 void ViewPropertiesDialog::markAsDirty(bool isDirty)
 303 {
 304     if (m_isDirty != isDirty) {
 305         m_isDirty = isDirty;
 306         Q_EMIT isDirtyChanged(isDirty);
 307     }
 308 }
 309
 310 void ViewPropertiesDialog::applyViewProperties()
 311 {
 312     // if nothing changed in the dialog, we have nothing to apply
 313     if (!m_isDirty) {
 314         return;
 315     }
 316
 317     // Update visible roles.
 318     {
 319         QList<QByteArray> visibleRoles;
 320         int index = 0;
 321         const QList<KFileItemModel::RoleInfo> rolesInfo = KFileItemModel::rolesInformation();
 322         for (const KFileItemModel::RoleInfo &info : rolesInfo) {
 323             const QListWidgetItem *item = m_listWidget->item(index);
 324             if (item->checkState() == Qt::Checked) {
 325                 visibleRoles.append(info.role);
 326             }
 327             ++index;
 328         }
 329
 330         m_viewProps->setVisibleRoles(visibleRoles);
 331     }
 332
 333     const bool applyToSubFolders = m_applyToSubFolders && m_applyToSubFolders->isChecked();
 334     if (applyToSubFolders) {
 335         const QString text(i18nc("@info", "The view properties of all sub-folders will be changed. Do you want to continue?"));
 336 #if KWIDGETSADDONS_VERSION >= QT_VERSION_CHECK(5, 100, 0)
 337         if (KMessageBox::questionTwoActions(this, text, {}, KStandardGuiItem::cont(), KStandardGuiItem::cancel()) == KMessageBox::SecondaryAction) {
 338 #else
 339         if (KMessageBox::questionYesNo(this, text, {}, KStandardGuiItem::cont(), KStandardGuiItem::cancel()) == KMessageBox::No) {
 340 #endif
 341             return;
 342         }
 343
 344         ViewPropsProgressInfo *info = new ViewPropsProgressInfo(m_dolphinView, m_dolphinView->url(), *m_viewProps);
 345         info->setAttribute(Qt::WA_DeleteOnClose);
 346         info->setWindowModality(Qt::NonModal);
 347         info->show();
 348     }
 349
 350     const bool applyToAllFolders = m_applyToAllFolders && m_applyToAllFolders->isChecked();
 351
 352     // If the user selected 'Apply To All Folders' the view properties implicitly
 353     // are also used as default for new folders.
 354     const bool useAsDefault = applyToAllFolders || (m_useAsDefault && m_useAsDefault->isChecked());
 355     if (useAsDefault) {
 356         // For directories where no .directory file is available, the .directory
 357         // file stored for the global view properties is used as fallback. To update
 358         // this file we temporary turn on the global view properties mode.
 359         Q_ASSERT(!GeneralSettings::globalViewProps());
 360
 361         GeneralSettings::setGlobalViewProps(true);
 362         ViewProperties defaultProps(m_dolphinView->url());
 363         defaultProps.setDirProperties(*m_viewProps);
 364         defaultProps.save();
 365         GeneralSettings::setGlobalViewProps(false);
 366     }
 367
 368     if (applyToAllFolders) {
 369         const QString text(i18nc("@info", "The view properties of all folders will be changed. Do you want to continue?"));
 370 #if KWIDGETSADDONS_VERSION >= QT_VERSION_CHECK(5, 100, 0)
 371         if (KMessageBox::questionTwoActions(this, text, {}, KStandardGuiItem::cont(), KStandardGuiItem::cancel()) == KMessageBox::SecondaryAction) {
 372 #else
 373         if (KMessageBox::questionYesNo(this, text, {}, KStandardGuiItem::cont(), KStandardGuiItem::cancel()) == KMessageBox::No) {
 374 #endif
 375             return;
 376         }
 377
 378         // Updating the global view properties time stamp in the general settings makes
 379         // all existing viewproperties invalid, as they have a smaller time stamp.
 380         GeneralSettings *settings = GeneralSettings::self();
 381         settings->setViewPropsTimestamp(QDateTime::currentDateTime());
 382         settings->save();
 383     }
 384
 385     m_dolphinView->setViewMode(m_viewProps->viewMode());
 386     m_dolphinView->setSortRole(m_viewProps->sortRole());
 387     m_dolphinView->setSortOrder(m_viewProps->sortOrder());
 388     m_dolphinView->setSortFoldersFirst(m_viewProps->sortFoldersFirst());
 389     m_dolphinView->setSortHiddenLast(m_viewProps->sortHiddenLast());
 390     m_dolphinView->setGroupedSorting(m_viewProps->groupedSorting());
 391     m_dolphinView->setVisibleRoles(m_viewProps->visibleRoles());
 392     m_dolphinView->setPreviewsShown(m_viewProps->previewsShown());
 393     m_dolphinView->setHiddenFilesShown(m_viewProps->hiddenFilesShown());
 394
 395     m_viewProps->save();
 396
 397     markAsDirty(false);
 398 }
 399
 400 void ViewPropertiesDialog::loadSettings()
 401 {
 402     // Load view mode
 403     switch (m_viewProps->viewMode()) {
 404     case DolphinView::IconsView:
 405         m_viewMode->setCurrentIndex(0);
 406         break;
 407     case DolphinView::CompactView:
 408         m_viewMode->setCurrentIndex(1);
 409         break;
 410     case DolphinView::DetailsView:
 411         m_viewMode->setCurrentIndex(2);
 412         break;
 413     default:
 414         break;
 415     }
 416
 417     // Load sort order and sorting
 418     const int sortOrderIndex = (m_viewProps->sortOrder() == Qt::AscendingOrder) ? 0 : 1;
 419     m_sortOrder->setCurrentIndex(sortOrderIndex);
 420
 421     const QList<KFileItemModel::RoleInfo> rolesInfo = KFileItemModel::rolesInformation();
 422     int sortRoleIndex = 0;
 423     for (int i = 0; i < rolesInfo.count(); ++i) {
 424         if (rolesInfo[i].role == m_viewProps->sortRole()) {
 425             sortRoleIndex = i;
 426             break;
 427         }
 428     }
 429     m_sorting->setCurrentIndex(sortRoleIndex);
 430
 431     m_sortFoldersFirst->setChecked(m_viewProps->sortFoldersFirst());
 432     m_sortHiddenLast->setChecked(m_viewProps->sortHiddenLast());
 433
 434     // Load show preview, show in groups and show hidden files settings
 435     m_previewsShown->setChecked(m_viewProps->previewsShown());
 436     m_showInGroups->setChecked(m_viewProps->groupedSorting());
 437     m_showHiddenFiles->setChecked(m_viewProps->hiddenFilesShown());
 438     markAsDirty(false);
 439 }