src/views/viewproperties.h

   1 /*
   2  * SPDX-FileCopyrightText: 2006-2010 Peter Penz <peter.penz19@gmail.com>
   3  * SPDX-FileCopyrightText: 2006 Aaron J. Seigo <aseigo@kde.org>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-or-later
   6  */
   7
   8 #ifndef VIEWPROPERTIES_H
   9 #define VIEWPROPERTIES_H
  10
  11 #include "dolphin_export.h"
  12 #include "views/dolphinview.h"
  13
  14 #include <QUrl>
  15
  16 class ViewPropertySettings;
  17 /**
  18  * @brief Maintains the view properties like 'view mode' or
  19  *        'show hidden files' for a directory.
  20  *
  21  * The view properties are automatically stored as part of the file
  22  * .directory inside the corresponding path. To read out the view properties
  23  * just construct an instance by passing the path of the directory:
  24  *
  25  * \code
  26  * ViewProperties props(QUrl::fromLocalFile("/home/peter/Documents"));
  27  * const DolphinView::Mode mode = props.viewMode();
  28  * const bool hiddenFilesShown = props.hiddenFilesShown();
  29  * \endcode
  30  *
  31  * When modifying a view property, the '.directory' file is automatically updated
  32  * inside the destructor.
  33  *
  34  * If no .directory file is available or the global view mode is turned on
  35  * (see GeneralSettings::globalViewMode()), the values from the global .directory file
  36  * are used for initialization.
  37  */
  38 class DOLPHIN_EXPORT ViewProperties
  39 {
  40 public:
  41     explicit ViewProperties(const QUrl &url);
  42     virtual ~ViewProperties();
  43
  44     void setViewMode(DolphinView::Mode mode);
  45     DolphinView::Mode viewMode() const;
  46
  47     void setPreviewsShown(bool show);
  48     bool previewsShown() const;
  49
  50     void setHiddenFilesShown(bool show);
  51     bool hiddenFilesShown() const;
  52
  53     void setGroupedSorting(bool grouped);
  54     bool groupedSorting() const;
  55
  56     void setSortRole(const QByteArray &role);
  57     QByteArray sortRole() const;
  58
  59     void setSortOrder(Qt::SortOrder sortOrder);
  60     Qt::SortOrder sortOrder() const;
  61
  62     void setGroupRole(const QByteArray &role);
  63     QByteArray groupRole() const;
  64
  65     void setGroupOrder(Qt::SortOrder groupOrder);
  66     Qt::SortOrder groupOrder() const;
  67
  68     void setSortFoldersFirst(bool foldersFirst);
  69     bool sortFoldersFirst() const;
  70
  71     void setSortHiddenLast(bool hiddenLast);
  72     bool sortHiddenLast() const;
  73
  74     void setDynamicViewPassed(bool dynamicViewPassed);
  75     bool dynamicViewPassed() const;
  76
  77     /**
  78      * Sets the additional information for the current set view-mode.
  79      * Note that the additional-info property is the only property where
  80      * the value is dependent from another property (in this case the view-mode).
  81      */
  82     void setVisibleRoles(const QList<QByteArray> &info);
  83
  84     /**
  85      * Returns the additional information for the current set view-mode.
  86      * Note that the additional-info property is the only property where
  87      * the value is dependent from another property (in this case the view-mode).
  88      */
  89     QList<QByteArray> visibleRoles() const;
  90
  91     void setHeaderColumnWidths(const QList<int> &widths);
  92     QList<int> headerColumnWidths() const;
  93
  94     /**
  95      * Sets the directory properties view mode, show preview,
  96      * show hidden files, sorting and sort order like
  97      * set in \a props.
  98      */
  99     void setDirProperties(const ViewProperties &props);
 100
 101     /**
 102      * If \a autoSave is true, the properties are automatically
 103      * saved when the destructor is called. Per default autosaving
 104      * is enabled.
 105      */
 106     void setAutoSaveEnabled(bool autoSave);
 107     bool isAutoSaveEnabled() const;
 108
 109     void update();
 110
 111     /**
 112      * Saves the view properties for the directory specified
 113      * in the constructor. The method is automatically
 114      * invoked in the destructor, if
 115      * ViewProperties::isAutoSaveEnabled() returns true and
 116      * at least one property has been changed.
 117      */
 118     void save();
 119
 120     /**
 121      * Returns the destination directory path where the view
 122      * properties are stored. \a subDir specifies the used sub
 123      * directory.
 124      */
 125     QString destinationDir(const QString &subDir) const;
 126
 127 private:
 128     /**
 129      * Returns the view-mode prefix when storing additional properties for
 130      * a view-mode.
 131      */
 132     QString viewModePrefix() const;
 133
 134     /**
 135      * Provides backward compatibility with .directory files created with
 136      * Dolphin < 2.0: Converts the old additionalInfo-property into
 137      * the visibleRoles-property and clears the additionalInfo-property.
 138      */
 139     void convertAdditionalInfo();
 140
 141     /**
 142      * Provides backward compatibility with .directory files created with
 143      * Dolphin < 2.1: Converts the old name-role "name" to the generic
 144      * role "text".
 145      */
 146     void convertNameRoleToTextRole();
 147
 148     /**
 149      * Provides backward compatibility with .directory files created with
 150      * Dolphin < 16.11.70: Converts the old name-role "date" to "modificationtime"
 151      */
 152
 153     void convertDateRoleToModificationTimeRole();
 154     /**
 155      * Returns true, if \a filePath is part of the home-path (see QDir::homePath()).
 156      */
 157     static bool isPartOfHome(const QString &filePath);
 158
 159     /**
 160      * @return A hash-value for an URL that can be used as directory name.
 161      *         Is used to be able to remember view-properties for long baloo-URLs.
 162      */
 163     static QString directoryHashForUrl(const QUrl &url);
 164
 165     /** @returns a ViewPropertySettings object with properties loaded for the directory at @param filePath. Ownership is returned to the caller. */
 166     ViewPropertySettings *loadProperties(const QString &folderPath) const;
 167     /** @returns a ViewPropertySettings object with the globally configured default values. Ownership is returned to the caller. */
 168     ViewPropertySettings *defaultProperties() const;
 169
 170     Q_DISABLE_COPY(ViewProperties)
 171
 172 private:
 173     bool m_changedProps;
 174     bool m_autoSave;
 175     QString m_filePath;
 176     ViewPropertySettings *m_node;
 177 };
 178
 179 #endif