X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/a5cf21ff06aff44cde563eaceae3c6cef452ee48..refs/heads/master:/src/views/viewproperties.h diff --git a/src/views/viewproperties.h b/src/views/viewproperties.h index bb476dc44..ac9ee4bb6 100644 --- a/src/views/viewproperties.h +++ b/src/views/viewproperties.h @@ -1,29 +1,17 @@ -/*************************************************************************** - * Copyright (C) 2006-2010 by Peter Penz * - * Copyright (C) 2006 by Aaron J. Seigo * - * * - * 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 + * SPDX-FileCopyrightText: 2006 Aaron J. Seigo + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ #ifndef VIEWPROPERTIES_H #define VIEWPROPERTIES_H -#include -#include -#include +#include "dolphin_export.h" +#include "views/dolphinview.h" + +#include class ViewPropertySettings; /** @@ -35,9 +23,9 @@ 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 showHiddenFiles = props.isShowHiddenFilesEnabled(); + * const bool hiddenFilesShown = props.hiddenFilesShown(); * \endcode * * When modifying a view property, the '.directory' file is automatically updated @@ -47,53 +35,68 @@ 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); DolphinView::Mode viewMode() const; - void setShowPreview(bool show); - bool showPreview() const; + void setPreviewsShown(bool show); + bool previewsShown() const; - void setShowHiddenFiles(bool show); - bool showHiddenFiles() const; + void setHiddenFilesShown(bool show); + bool hiddenFilesShown() const; - void setCategorizedSorting(bool categorized); - bool categorizedSorting() const; + void setGroupedSorting(bool grouped); + bool groupedSorting() const; - void setSorting(DolphinView::Sorting sorting); - DolphinView::Sorting sorting() const; + 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 setAdditionalInfo(const KFileItemDelegate::InformationList& info); + void setVisibleRoles(const QList &info); /** * Returns 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). */ - KFileItemDelegate::InformationList additionalInfo() const; + QList visibleRoles() const; + + void setHeaderColumnWidths(const QList &widths); + QList 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 @@ -103,7 +106,7 @@ public: void setAutoSaveEnabled(bool autoSave); bool isAutoSaveEnabled() const; - void updateTimeStamp(); + void update(); /** * Saves the view properties for the directory specified @@ -115,41 +118,54 @@ public: 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 + * Returns the destination directory path where the view + * properties are stored. \a subDir specifies the used sub + * directory. */ - static KUrl mirroredDirectory(); + QString destinationDir(const QString &subDir) const; private: /** - * Returns the destination directory path where the view - * properties are stored. \a subDir specifies the used sub - * directory. + * 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" */ - QString destinationDir(const QString& subDir) const; + void convertDateRoleToModificationTimeRole(); /** - * Returns the encoded additional information that can be stored - * in the .directory file. See ViewProperties::decodedAdditionalInfo() - * for the coding format. - * @param info Additional information for the current view mode. + * Returns true, if \a filePath is part of the home-path (see QDir::homePath()). */ - int encodedAdditionalInfo(int info) const; + static bool isPartOfHome(const QString &filePath); /** - * Returns the decoded additional information from the .directory - * file by respecting the current set view mode. The additional - * information from the .directory file is an integer value, where: - * - Byte 0 stores the additional info for the details view - * - Byte 1 stores the additional info for the icons view - * - Byte 2 stores the additional info for the column view - * The additional information property is the only property that is - * dependent from another property (in this case the view-mode). + * @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. */ - int decodedAdditionalInfo() const; + 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) @@ -157,7 +173,7 @@ private: bool m_changedProps; bool m_autoSave; QString m_filePath; - ViewPropertySettings* m_node; + ViewPropertySettings *m_node; }; #endif