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