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 = ((!info.requiresBaloo && !info.requiresIndexer) ||
 126                                 (info.requiresBaloo) ||
 127                                 (info.requiresIndexer && indexingEnabled)) && info.role != "text";
 128
 129             if (!enable) {
 130                 item->setFlags(item->flags() & ~Qt::ItemIsEnabled);
 131             }
 132         }
 133         QLabel* additionalViewOptionsLabel = new QLabel(i18n("Choose what to see on each file or folder:"));
 134         innerLayout->addWidget(additionalViewOptionsLabel);
 135         innerLayout->addWidget(m_listWidget);
 136     }
 137
 138     QHBoxLayout* sortingLayout = new QHBoxLayout();
 139     sortingLayout->setContentsMargins(0, 0, 0, 0);
 140     sortingLayout->addWidget(m_sortOrder);
 141     sortingLayout->addWidget(m_sorting);
 142
 143     layout->addRow(i18nc("@label:listbox", "View mode:"), m_viewMode);
 144     layout->addRow(i18nc("@label:listbox", "Sorting:"), sortingLayout);
 145
 146     layout->addItem(new QSpacerItem(0, Dolphin::VERTICAL_SPACER_HEIGHT, QSizePolicy::Fixed, QSizePolicy::Fixed));
 147
 148     layout->addRow(i18n("View options:"), m_sortFoldersFirst);
 149     layout->addRow(QString(), m_previewsShown);
 150     layout->addRow(QString(), m_showInGroups);
 151     layout->addRow(QString(), m_showHiddenFiles);
 152     layout->addRow(QString(), m_sortHiddenLast);
 153
 154     connect(m_viewMode, &QComboBox::currentIndexChanged,
 155             this, &ViewPropertiesDialog::slotViewModeChanged);
 156     connect(m_sorting, &QComboBox::currentIndexChanged,
 157             this, &ViewPropertiesDialog::slotSortingChanged);
 158     connect(m_sortOrder, &QComboBox::currentIndexChanged,
 159             this, &ViewPropertiesDialog::slotSortOrderChanged);
 160     connect(m_sortFoldersFirst, &QCheckBox::clicked,
 161             this, &ViewPropertiesDialog::slotSortFoldersFirstChanged);
 162     connect(m_sortHiddenLast, &QCheckBox::clicked,
 163             this, &ViewPropertiesDialog::slotSortHiddenLastChanged);
 164     connect(m_previewsShown, &QCheckBox::clicked,
 165             this, &ViewPropertiesDialog::slotShowPreviewChanged);
 166     connect(m_showInGroups, &QCheckBox::clicked,
 167             this, &ViewPropertiesDialog::slotGroupedSortingChanged);
 168     connect(m_showHiddenFiles, &QCheckBox::clicked,
 169             this, &ViewPropertiesDialog::slotShowHiddenFilesChanged);
 170
 171     // Only show the following settings if the view properties are remembered
 172     // for each directory:
 173     if (!useGlobalViewProps) {
 174         // create 'Apply View Properties To' group
 175         m_applyToCurrentFolder = new QRadioButton(i18nc("@option:radio Apply View Properties To",
 176                                                         "Current folder"));
 177         m_applyToCurrentFolder->setChecked(true);
 178         m_applyToSubFolders = new QRadioButton(i18nc("@option:radio Apply View Properties To",
 179                                                      "Current folder and sub-folders"));
 180         m_applyToAllFolders = new QRadioButton(i18nc("@option:radio Apply View Properties To",
 181                                                      "All folders"));
 182
 183         QButtonGroup* applyGroup = new QButtonGroup(this);
 184         applyGroup->addButton(m_applyToCurrentFolder);
 185         applyGroup->addButton(m_applyToSubFolders);
 186         applyGroup->addButton(m_applyToAllFolders);
 187
 188         layout->addItem(new QSpacerItem(0, Dolphin::VERTICAL_SPACER_HEIGHT, QSizePolicy::Fixed, QSizePolicy::Fixed));
 189
 190         layout->addRow(i18nc("@title:group", "Apply to:"), m_applyToCurrentFolder);
 191         layout->addRow(QString(), m_applyToSubFolders);
 192         layout->addRow(QString(), m_applyToAllFolders);
 193         layout->addRow(QString(), m_applyToAllFolders);
 194
 195         m_useAsDefault = new QCheckBox(i18nc("@option:check", "Use as default view settings"), this);
 196         layout->addRow(QString(), m_useAsDefault);
 197
 198         connect(m_applyToCurrentFolder, &QRadioButton::clicked,
 199                 this, &ViewPropertiesDialog::markAsDirty);
 200         connect(m_applyToSubFolders, &QRadioButton::clicked,
 201                 this, &ViewPropertiesDialog::markAsDirty);
 202         connect(m_applyToAllFolders, &QRadioButton::clicked,
 203                 this, &ViewPropertiesDialog::markAsDirty);
 204         connect(m_useAsDefault, &QCheckBox::clicked,
 205                 this, &ViewPropertiesDialog::markAsDirty);
 206     }
 207
 208     layout->addItem(new QSpacerItem(0, Dolphin::VERTICAL_SPACER_HEIGHT, QSizePolicy::Fixed, QSizePolicy::Fixed));
 209
 210     layout->addRow(additionalInfoBox);
 211
 212     auto buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel | QDialogButtonBox::Apply, this);
 213     connect(buttonBox, &QDialogButtonBox::accepted, this, &ViewPropertiesDialog::accept);
 214     connect(buttonBox, &QDialogButtonBox::rejected, this, &ViewPropertiesDialog::reject);
 215     layout->addWidget(buttonBox);
 216
 217     auto okButton = buttonBox->button(QDialogButtonBox::Ok);
 218     okButton->setShortcut(Qt::CTRL | Qt::Key_Return);
 219     okButton->setDefault(true);
 220
 221     auto applyButton = buttonBox->button(QDialogButtonBox::Apply);
 222     applyButton->setEnabled(false);
 223     connect(applyButton, &QPushButton::clicked, this, &ViewPropertiesDialog::slotApply);
 224     connect(this, &ViewPropertiesDialog::isDirtyChanged, applyButton, [applyButton](bool isDirty) {
 225         applyButton->setEnabled(isDirty);
 226     });
 227
 228     const KConfigGroup dialogConfig(KSharedConfig::openConfig(QStringLiteral("dolphinrc")), "ViewPropertiesDialog");
 229     KWindowConfig::restoreWindowSize(windowHandle(), dialogConfig);
 230
 231     loadSettings();
 232 }
 233
 234 ViewPropertiesDialog::~ViewPropertiesDialog()
 235 {
 236     m_isDirty = false;
 237     delete m_viewProps;
 238     m_viewProps = nullptr;
 239
 240     KConfigGroup dialogConfig(KSharedConfig::openConfig(QStringLiteral("dolphinrc")), "ViewPropertiesDialog");
 241     KWindowConfig::saveWindowSize(windowHandle(), dialogConfig);
 242 }
 243
 244 void ViewPropertiesDialog::accept()
 245 {
 246     applyViewProperties();
 247     QDialog::accept();
 248 }
 249
 250 void ViewPropertiesDialog::slotApply()
 251 {
 252     applyViewProperties();
 253     markAsDirty(false);
 254 }
 255
 256 void ViewPropertiesDialog::slotViewModeChanged(int index)
 257 {
 258     const QVariant itemData = m_viewMode->itemData(index);
 259     const DolphinView::Mode viewMode = static_cast<DolphinView::Mode>(itemData.toInt());
 260     m_viewProps->setViewMode(viewMode);
 261     markAsDirty(true);
 262 }
 263
 264 void ViewPropertiesDialog::slotSortingChanged(int index)
 265 {
 266     const QByteArray role = m_sorting->itemData(index).toByteArray();
 267     m_viewProps->setSortRole(role);
 268     markAsDirty(true);
 269 }
 270
 271 void ViewPropertiesDialog::slotSortOrderChanged(int index)
 272 {
 273     const Qt::SortOrder sortOrder = (index == 0) ? Qt::AscendingOrder : Qt::DescendingOrder;
 274     m_viewProps->setSortOrder(sortOrder);
 275     markAsDirty(true);
 276 }
 277
 278 void ViewPropertiesDialog::slotGroupedSortingChanged()
 279 {
 280     m_viewProps->setGroupedSorting(m_showInGroups->isChecked());
 281     markAsDirty(true);
 282 }
 283
 284 void ViewPropertiesDialog::slotSortFoldersFirstChanged()
 285 {
 286     const bool foldersFirst = m_sortFoldersFirst->isChecked();
 287     m_viewProps->setSortFoldersFirst(foldersFirst);
 288     markAsDirty(true);
 289 }
 290
 291 void ViewPropertiesDialog::slotSortHiddenLastChanged()
 292 {
 293     const bool hiddenLast = m_sortHiddenLast->isChecked();
 294     m_viewProps->setSortHiddenLast(hiddenLast);
 295     markAsDirty(true);
 296 }
 297
 298 void ViewPropertiesDialog::slotShowPreviewChanged()
 299 {
 300     const bool show = m_previewsShown->isChecked();
 301     m_viewProps->setPreviewsShown(show);
 302     markAsDirty(true);
 303 }
 304
 305 void ViewPropertiesDialog::slotShowHiddenFilesChanged()
 306 {
 307     const bool show = m_showHiddenFiles->isChecked();
 308     m_viewProps->setHiddenFilesShown(show);
 309     markAsDirty(true);
 310 }
 311
 312 void ViewPropertiesDialog::slotItemChanged(QListWidgetItem *item)
 313 {
 314     Q_UNUSED(item)
 315     markAsDirty(true);
 316 }
 317
 318 void ViewPropertiesDialog::markAsDirty(bool isDirty)
 319 {
 320     if (m_isDirty != isDirty) {
 321         m_isDirty = isDirty;
 322         Q_EMIT isDirtyChanged(isDirty);
 323     }
 324 }
 325
 326 void ViewPropertiesDialog::applyViewProperties()
 327 {
 328     // if nothing changed in the dialog, we have nothing to apply
 329     if (!m_isDirty) {
 330         return;
 331     }
 332
 333     // Update visible roles.
 334     {
 335         QList<QByteArray> visibleRoles;
 336         int index = 0;
 337         const QList<KFileItemModel::RoleInfo> rolesInfo = KFileItemModel::rolesInformation();
 338         for (const KFileItemModel::RoleInfo& info : rolesInfo) {
 339             const QListWidgetItem* item = m_listWidget->item(index);
 340              if (item->checkState() == Qt::Checked) {
 341                 visibleRoles.append(info.role);
 342             }
 343             ++index;
 344         }
 345
 346         m_viewProps->setVisibleRoles(visibleRoles);
 347     }
 348
 349     const bool applyToSubFolders = m_applyToSubFolders && m_applyToSubFolders->isChecked();
 350     if (applyToSubFolders) {
 351         const QString text(i18nc("@info", "The view properties of all sub-folders will be changed. Do you want to continue?"));
 352 #if KWIDGETSADDONS_VERSION >= QT_VERSION_CHECK(5, 100, 0)
 353         if (KMessageBox::questionTwoActions(this, text, {},
 354                                             KStandardGuiItem::cont(),
 355                                             KStandardGuiItem::cancel()) == KMessageBox::SecondaryAction) {
 356 #else
 357         if (KMessageBox::questionYesNo(this, text, {},
 358                                        KStandardGuiItem::cont(),
 359                                        KStandardGuiItem::cancel()) == KMessageBox::No) {
 360 #endif
 361             return;
 362         }
 363
 364         ViewPropsProgressInfo* info = new ViewPropsProgressInfo(m_dolphinView,
 365                                                                 m_dolphinView->url(),
 366                                                                 *m_viewProps);
 367         info->setAttribute(Qt::WA_DeleteOnClose);
 368         info->setWindowModality(Qt::NonModal);
 369         info->show();
 370     }
 371
 372     const bool applyToAllFolders = m_applyToAllFolders && m_applyToAllFolders->isChecked();
 373
 374     // If the user selected 'Apply To All Folders' the view properties implicitly
 375     // are also used as default for new folders.
 376     const bool useAsDefault = applyToAllFolders || (m_useAsDefault && m_useAsDefault->isChecked());
 377     if (useAsDefault) {
 378         // For directories where no .directory file is available, the .directory
 379         // file stored for the global view properties is used as fallback. To update
 380         // this file we temporary turn on the global view properties mode.
 381         Q_ASSERT(!GeneralSettings::globalViewProps());
 382
 383         GeneralSettings::setGlobalViewProps(true);
 384         ViewProperties defaultProps(m_dolphinView->url());
 385         defaultProps.setDirProperties(*m_viewProps);
 386         defaultProps.save();
 387         GeneralSettings::setGlobalViewProps(false);
 388     }
 389
 390     if (applyToAllFolders) {
 391         const QString text(i18nc("@info", "The view properties of all folders will be changed. Do you want to continue?"));
 392 #if KWIDGETSADDONS_VERSION >= QT_VERSION_CHECK(5, 100, 0)
 393         if (KMessageBox::questionTwoActions(this, text, {},
 394                                             KStandardGuiItem::cont(),
 395                                             KStandardGuiItem::cancel()) == KMessageBox::SecondaryAction) {
 396 #else
 397         if (KMessageBox::questionYesNo(this, text, {},
 398                                        KStandardGuiItem::cont(),
 399                                        KStandardGuiItem::cancel()) == KMessageBox::No) {
 400 #endif
 401             return;
 402         }
 403
 404         // Updating the global view properties time stamp in the general settings makes
 405         // all existing viewproperties invalid, as they have a smaller time stamp.
 406         GeneralSettings* settings = GeneralSettings::self();
 407         settings->setViewPropsTimestamp(QDateTime::currentDateTime());
 408         settings->save();
 409     }
 410
 411     m_dolphinView->setViewMode(m_viewProps->viewMode());
 412     m_dolphinView->setSortRole(m_viewProps->sortRole());
 413     m_dolphinView->setSortOrder(m_viewProps->sortOrder());
 414     m_dolphinView->setSortFoldersFirst(m_viewProps->sortFoldersFirst());
 415     m_dolphinView->setSortHiddenLast(m_viewProps->sortHiddenLast());
 416     m_dolphinView->setGroupedSorting(m_viewProps->groupedSorting());
 417     m_dolphinView->setVisibleRoles(m_viewProps->visibleRoles());
 418     m_dolphinView->setPreviewsShown(m_viewProps->previewsShown());
 419     m_dolphinView->setHiddenFilesShown(m_viewProps->hiddenFilesShown());
 420
 421     m_viewProps->save();
 422
 423     markAsDirty(false);
 424 }
 425
 426 void ViewPropertiesDialog::loadSettings()
 427 {
 428     // Load view mode
 429     switch (m_viewProps->viewMode()) {
 430     case DolphinView::IconsView:   m_viewMode->setCurrentIndex(0); break;
 431     case DolphinView::CompactView: m_viewMode->setCurrentIndex(1); break;
 432     case DolphinView::DetailsView: m_viewMode->setCurrentIndex(2); break;
 433     default: break;
 434     }
 435
 436     // Load sort order and sorting
 437     const int sortOrderIndex = (m_viewProps->sortOrder() == Qt::AscendingOrder) ? 0 : 1;
 438     m_sortOrder->setCurrentIndex(sortOrderIndex);
 439
 440     const QList<KFileItemModel::RoleInfo> rolesInfo = KFileItemModel::rolesInformation();
 441     int sortRoleIndex = 0;
 442     for (int i = 0; i < rolesInfo.count(); ++i) {
 443         if (rolesInfo[i].role == m_viewProps->sortRole()) {
 444             sortRoleIndex = i;
 445             break;
 446         }
 447     }
 448     m_sorting->setCurrentIndex(sortRoleIndex);
 449
 450     m_sortFoldersFirst->setChecked(m_viewProps->sortFoldersFirst());
 451     m_sortHiddenLast->setChecked(m_viewProps->sortHiddenLast());
 452
 453     // Load show preview, show in groups and show hidden files settings
 454     m_previewsShown->setChecked(m_viewProps->previewsShown());
 455     m_showInGroups->setChecked(m_viewProps->groupedSorting());
 456     m_showHiddenFiles->setChecked(m_viewProps->hiddenFilesShown());
 457     markAsDirty(false);
 458 }
 459