X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/7fec7ff9a096d288b66fce2699c7b8bc71f6fbbb..abf17941f7:/src/viewproperties.h

diff --git a/src/viewproperties.h b/src/viewproperties.h
index 98d5a94b2..b4d9500bc 100644
--- a/src/viewproperties.h
+++ b/src/viewproperties.h
@@ -1,6 +1,6 @@
 /***************************************************************************
- *   Copyright (C) 2006 by Peter Penz                                      *
- *   peter.penz@gmx.at                                                     *
+ *   Copyright (C) 2006 by Peter Penz (<peter.penz@gmx.at>)                *
+ *   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  *
@@ -15,7 +15,7 @@
  *   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.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  ***************************************************************************/
 
 #ifndef VIEWPROPERTIES_H
@@ -30,34 +30,40 @@
 class QFile;
 
 /**
- * @short Maintains the view properties like 'view mode' or 'show hidden files' for a directory.
+ * @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:
  *
- * The view properties are automatically stored inside
- * the directory as hidden file called '.dolphinview'. To read out the view properties
- * just construct an instance by passing the Url 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 '.dolphinview' file is automatically updated
+ *
+ * When modifying a view property, the '.directory' file is automatically updated
  * inside the destructor.
  *
- * @author Peter Penz
+ * 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.
  */
-// TODO: provide detailed design description, as mapping the user model to
-// the physical modal is not trivial.
 class ViewProperties
 {
 public:
-    ViewProperties(KUrl url);
+    explicit ViewProperties(const KUrl& url);
     virtual ~ViewProperties();
 
     void setViewMode(DolphinView::Mode mode);
     DolphinView::Mode viewMode() const;
 
-    void setShowHiddenFilesEnabled(bool show);
-    bool isShowHiddenFilesEnabled() const;
+    void setShowPreview(bool show);
+    bool showPreview() const;
+
+    void setShowHiddenFiles(bool show);
+    bool showHiddenFiles() const;
 
     void setSorting(DolphinView::Sorting sorting);
     DolphinView::Sorting sorting() const;
@@ -65,21 +71,46 @@ public:
     void setSortOrder(Qt::SortOrder sortOrder);
     Qt::SortOrder sortOrder() const;
 
-    void setValidForSubDirs(bool valid);
-    bool isValidForSubDirs() 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();
 
-    ViewProperties& operator = (const ViewProperties& props);
+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;
+
+    ViewProperties(const ViewProperties& props);
+    ViewProperties& operator= (const ViewProperties& props);
 
 private:
     bool m_changedProps;
     bool m_autoSave;
-    bool m_subDirValidityHidden;
     QString m_filepath;
     ViewPropertySettings* m_node;
 };