Sourcecode hierarchy cleanup: Move further files from src to src/views

svn path=/trunk/KDE/kdebase/apps/; revision=1154150

1 files changed, 163 insertions, 0 deletions

diff --git a/src/views/viewproperties.h b/src/views/viewproperties.h
new file mode 100644
index 000000000..bb476dc44
--- /dev/null
+++ b/src/views/viewproperties.h
@@ -0,0 +1,163 @@
+/***************************************************************************
+ *   Copyright (C) 2006-2010 by Peter Penz <[email protected]>             *
+ *   Copyright (C) 2006 by Aaron J. Seigo <[email protected]>                 *
+ *                                                                         *
+ *   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          *
+ ***************************************************************************/
+
+#ifndef VIEWPROPERTIES_H
+#define VIEWPROPERTIES_H
+
+#include <views/dolphinview.h>
+#include <kurl.h>
+#include <libdolphin_export.h>
+
+class ViewPropertySettings;
+/**
+ * @brief Maintains the view properties like 'view mode' or
+ *        'show hidden files' for a directory.
+ *
+ * The view properties are automatically stored as part of the file
+ * .directory inside the corresponding path. To read out the view properties
+ * just construct an instance by passing the path of the directory:
+ *
+ * \code
+ * ViewProperties props(KUrl("/home/peter/Documents"));
+ * const DolphinView::Mode mode = props.viewMode();
+ * const bool showHiddenFiles = props.isShowHiddenFilesEnabled();
+ * \endcode
+ *
+ * When modifying a view property, the '.directory' file is automatically updated
+ * inside the destructor.
+ *
+ * If no .directory file is available or the global view mode is turned on
+ * (see GeneralSettings::globalViewMode()), the values from the global .directory file
+ * are used for initialization.
+ */
+class LIBDOLPHINPRIVATE_EXPORT ViewProperties
+{
+public:
+    explicit ViewProperties(const KUrl& url);
+    virtual ~ViewProperties();
+
+    void setViewMode(DolphinView::Mode mode);
+    DolphinView::Mode viewMode() const;
+
+    void setShowPreview(bool show);
+    bool showPreview() const;
+
+    void setShowHiddenFiles(bool show);
+    bool showHiddenFiles() const;
+
+    void setCategorizedSorting(bool categorized);
+    bool categorizedSorting() const;
+
+    void setSorting(DolphinView::Sorting sorting);
+    DolphinView::Sorting sorting() const;
+
+    void setSortOrder(Qt::SortOrder sortOrder);
+    Qt::SortOrder sortOrder() const;
+
+    void setSortFoldersFirst(bool foldersFirst);
+    bool sortFoldersFirst() 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);
+
+    /**
+     * 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;
+
+    /**
+     * 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);
+
+    /**
+     * If \a autoSave is true, the properties are automatically
+     * saved when the destructor is called. Per default autosaving
+     * is enabled.
+     */
+    void setAutoSaveEnabled(bool autoSave);
+    bool isAutoSaveEnabled() const;
+
+    void updateTimeStamp();
+
+    /**
+     * Saves the view properties for the directory specified
+     * in the constructor. The method is automatically
+     * invoked in the destructor, if
+     * ViewProperties::isAutoSaveEnabled() returns true and
+     * at least one property has been changed.
+     */
+    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;
+
+    /**
+     * 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.
+     */
+    int encodedAdditionalInfo(int info) const;
+
+    /**
+     * 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).
+     */
+    int decodedAdditionalInfo() const;
+
+    Q_DISABLE_COPY(ViewProperties)
+
+private:
+    bool m_changedProps;
+    bool m_autoSave;
+    QString m_filePath;
+    ViewPropertySettings* m_node;
+};
+
+#endif