]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/views/viewproperties.h
Merge remote-tracking branch 'fork/work/zakharafoniam/useful-groups'
[dolphin.git] / src / views / viewproperties.h
index d794edf655164a70926216af0dd3764880134f97..ac9ee4bb6082917a72215069a951a45c4c5806d5 100644 (file)
@@ -1,29 +1,17 @@
-/***************************************************************************
- *   Copyright (C) 2006-2010 by Peter Penz <peter.penz19@gmail.com>        *
- *   Copyright (C) 2006 by Aaron J. Seigo <aseigo@kde.org>                 *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2006-2010 Peter Penz <peter.penz19@gmail.com>
+ * SPDX-FileCopyrightText: 2006 Aaron J. Seigo <aseigo@kde.org>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #ifndef VIEWPROPERTIES_H
 #define VIEWPROPERTIES_H
 
-#include <views/dolphinview.h>
-#include <KUrl>
-#include <libdolphin_export.h>
+#include "dolphin_export.h"
+#include "views/dolphinview.h"
+
+#include <QUrl>
 
 class ViewPropertySettings;
 /**
@@ -35,7 +23,7 @@ class ViewPropertySettings;
  * just construct an instance by passing the path of the directory:
  *
  * \code
- * ViewProperties props(KUrl("/home/peter/Documents"));
+ * ViewProperties props(QUrl::fromLocalFile("/home/peter/Documents"));
  * const DolphinView::Mode mode = props.viewMode();
  * const bool hiddenFilesShown = props.hiddenFilesShown();
  * \endcode
@@ -47,10 +35,10 @@ class ViewPropertySettings;
  * (see GeneralSettings::globalViewMode()), the values from the global .directory file
  * are used for initialization.
  */
-class LIBDOLPHINPRIVATE_EXPORT ViewProperties
+class DOLPHIN_EXPORT ViewProperties
 {
 public:
-    explicit ViewProperties(const KUrl& url);
+    explicit ViewProperties(const QUrl &url);
     virtual ~ViewProperties();
 
     void setViewMode(DolphinView::Mode mode);
@@ -65,21 +53,33 @@ public:
     void setGroupedSorting(bool grouped);
     bool groupedSorting() const;
 
-    void setSortRole(const QByteArrayrole);
+    void setSortRole(const QByteArray &role);
     QByteArray sortRole() const;
 
     void setSortOrder(Qt::SortOrder sortOrder);
     Qt::SortOrder sortOrder() const;
 
+    void setGroupRole(const QByteArray &role);
+    QByteArray groupRole() const;
+
+    void setGroupOrder(Qt::SortOrder groupOrder);
+    Qt::SortOrder groupOrder() const;
+
     void setSortFoldersFirst(bool foldersFirst);
     bool sortFoldersFirst() const;
 
+    void setSortHiddenLast(bool hiddenLast);
+    bool sortHiddenLast() const;
+
+    void setDynamicViewPassed(bool dynamicViewPassed);
+    bool dynamicViewPassed() const;
+
     /**
      * Sets the additional information for the current set view-mode.
      * Note that the additional-info property is the only property where
      * the value is dependent from another property (in this case the view-mode).
      */
-    void setVisibleRoles(const QList<QByteArray>info);
+    void setVisibleRoles(const QList<QByteArray> &info);
 
     /**
      * Returns the additional information for the current set view-mode.
@@ -88,7 +88,7 @@ public:
      */
     QList<QByteArray> visibleRoles() const;
 
-    void setHeaderColumnWidths(const QList<int>widths);
+    void setHeaderColumnWidths(const QList<int> &widths);
     QList<int> headerColumnWidths() const;
 
     /**
@@ -96,7 +96,7 @@ public:
      * show hidden files, sorting and sort order like
      * set in \a props.
      */
-    void setDirProperties(const ViewPropertiesprops);
+    void setDirProperties(const ViewProperties &props);
 
     /**
      * If \a autoSave is true, the properties are automatically
@@ -117,22 +117,14 @@ public:
      */
     void save();
 
-    /**
-     * @return True if properties for the given URL exist:
-     *         As soon as the properties for an URL have been saved with
-     *         ViewProperties::save(), true will be returned. If false is
-     *         returned, the default view-properties are used.
-     */
-    bool exist() const;
-
-private:
     /**
      * Returns the destination directory path where the view
      * properties are stored. \a subDir specifies the used sub
      * directory.
      */
-    QString destinationDir(const QStringsubDir) const;
+    QString destinationDir(const QString &subDir) const;
 
+private:
     /**
      * Returns the view-mode prefix when storing additional properties for
      * a view-mode.
@@ -153,16 +145,27 @@ private:
      */
     void convertNameRoleToTextRole();
 
+    /**
+     * Provides backward compatibility with .directory files created with
+     * Dolphin < 16.11.70: Converts the old name-role "date" to "modificationtime"
+     */
+
+    void convertDateRoleToModificationTimeRole();
     /**
      * Returns true, if \a filePath is part of the home-path (see QDir::homePath()).
      */
-    static bool isPartOfHome(const QStringfilePath);
+    static bool isPartOfHome(const QString &filePath);
 
     /**
      * @return A hash-value for an URL that can be used as directory name.
      *         Is used to be able to remember view-properties for long baloo-URLs.
      */
-    static QString directoryHashForUrl(const KUrl& url);
+    static QString directoryHashForUrl(const QUrl &url);
+
+    /** @returns a ViewPropertySettings object with properties loaded for the directory at @param filePath. Ownership is returned to the caller. */
+    ViewPropertySettings *loadProperties(const QString &folderPath) const;
+    /** @returns a ViewPropertySettings object with the globally configured default values. Ownership is returned to the caller. */
+    ViewPropertySettings *defaultProperties() const;
 
     Q_DISABLE_COPY(ViewProperties)
 
@@ -170,7 +173,7 @@ private:
     bool m_changedProps;
     bool m_autoSave;
     QString m_filePath;
-    ViewPropertySettingsm_node;
+    ViewPropertySettings *m_node;
 };
 
 #endif