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 setSortFoldersFirst(bool foldersFirst);
  63     bool sortFoldersFirst() const;
  64
  65     /**
  66      * Sets the additional information for the current set view-mode.
  67      * Note that the additional-info property is the only property where
  68      * the value is dependent from another property (in this case the view-mode).
  69      */
  70     void setVisibleRoles(const QList<QByteArray>& info);
  71
  72     /**
  73      * Returns the additional information for the current set view-mode.
  74      * Note that the additional-info property is the only property where
  75      * the value is dependent from another property (in this case the view-mode).
  76      */
  77     QList<QByteArray> visibleRoles() const;
  78
  79     void setHeaderColumnWidths(const QList<int>& widths);
  80     QList<int> headerColumnWidths() const;
  81
  82     /**
  83      * Sets the directory properties view mode, show preview,
  84      * show hidden files, sorting and sort order like
  85      * set in \a props.
  86      */
  87     void setDirProperties(const ViewProperties& props);
  88
  89     /**
  90      * If \a autoSave is true, the properties are automatically
  91      * saved when the destructor is called. Per default autosaving
  92      * is enabled.
  93      */
  94     void setAutoSaveEnabled(bool autoSave);
  95     bool isAutoSaveEnabled() const;
  96
  97     void update();
  98
  99     /**
 100      * Saves the view properties for the directory specified
 101      * in the constructor. The method is automatically
 102      * invoked in the destructor, if
 103      * ViewProperties::isAutoSaveEnabled() returns true and
 104      * at least one property has been changed.
 105      */
 106     void save();
 107
 108     /**
 109      * @return True if properties for the given URL exist:
 110      *         As soon as the properties for an URL have been saved with
 111      *         ViewProperties::save(), true will be returned. If false is
 112      *         returned, the default view-properties are used.
 113      */
 114     bool exist() const;
 115
 116 private:
 117     /**
 118      * Returns the destination directory path where the view
 119      * properties are stored. \a subDir specifies the used sub
 120      * directory.
 121      */
 122     QString destinationDir(const QString& subDir) const;
 123
 124     /**
 125      * Returns the view-mode prefix when storing additional properties for
 126      * a view-mode.
 127      */
 128     QString viewModePrefix() const;
 129
 130     /**
 131      * Provides backward compatibility with .directory files created with
 132      * Dolphin < 2.0: Converts the old additionalInfo-property into
 133      * the visibleRoles-property and clears the additionalInfo-property.
 134      */
 135     void convertAdditionalInfo();
 136
 137     /**
 138      * Provides backward compatibility with .directory files created with
 139      * Dolphin < 2.1: Converts the old name-role "name" to the generic
 140      * role "text".
 141      */
 142     void convertNameRoleToTextRole();
 143
 144     /**
 145      * Provides backward compatibility with .directory files created with
 146      * Dolphin < 16.11.70: Converts the old name-role "date" to "modificationtime"
 147      */
 148
 149     void convertDateRoleToModificationTimeRole();
 150     /**
 151      * Returns true, if \a filePath is part of the home-path (see QDir::homePath()).
 152      */
 153     static bool isPartOfHome(const QString& filePath);
 154
 155     /**
 156      * @return A hash-value for an URL that can be used as directory name.
 157      *         Is used to be able to remember view-properties for long baloo-URLs.
 158      */
 159     static QString directoryHashForUrl(const QUrl &url);
 160
 161     Q_DISABLE_COPY(ViewProperties)
 162
 163 private:
 164     bool m_changedProps;
 165     bool m_autoSave;
 166     QString m_filePath;
 167     ViewPropertySettings* m_node;
 168 };
 169
 170 #endif