-/***************************************************************************
- * 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;
/**
* 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
* (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);
void setGroupedSorting(bool grouped);
bool groupedSorting() const;
- void setSortRole(const QByteArray& role);
+ 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.
*/
QList<QByteArray> visibleRoles() const;
+ void setHeaderColumnWidths(const QList<int> &widths);
+ QList<int> headerColumnWidths() const;
+
/**
* Sets the directory properties view mode, show preview,
* show hidden files, sorting and sort order like
* set in \a props.
*/
- void setDirProperties(const ViewProperties& props);
+ void setDirProperties(const ViewProperties &props);
/**
* If \a autoSave is true, the properties are automatically
*/
void save();
- /**
- * Returns the URL of the directory, where the mirrored view properties
- * are stored into. Mirrored view properties are used if:
- * - there is no write access for storing the view properties into
- * the original directory
- * - for non local directories
- */
- static KUrl mirroredDirectory();
-
-private:
/**
* Returns the destination directory path where the view
* properties are stored. \a subDir specifies the used sub
* directory.
*/
- QString destinationDir(const QString& subDir) const;
+ QString destinationDir(const QString &subDir) const;
+private:
/**
* Returns the view-mode prefix when storing additional properties for
* a view-mode.
*/
QString viewModePrefix() const;
+ /**
+ * Provides backward compatibility with .directory files created with
+ * Dolphin < 2.0: Converts the old additionalInfo-property into
+ * the visibleRoles-property and clears the additionalInfo-property.
+ */
+ void convertAdditionalInfo();
+
+ /**
+ * Provides backward compatibility with .directory files created with
+ * Dolphin < 2.1: Converts the old name-role "name" to the generic
+ * role "text".
+ */
+ 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 QString& filePath);
+ 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 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)
bool m_changedProps;
bool m_autoSave;
QString m_filePath;
- ViewPropertySettings* m_node;
+ ViewPropertySettings *m_node;
};
#endif
projects / dolphin.git / blobdiff