src/viewproperties.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz                                      *
   3  *   peter.penz@gmx.at                                                     *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  19  ***************************************************************************/
  20
  21 #ifndef VIEWPROPERTIES_H
  22 #define VIEWPROPERTIES_H
  23
  24 #include <dolphinview.h>
  25 #include <kurl.h>
  26 #include <qdatetime.h>
  27
  28 #include "directoryviewpropertysettings.h"
  29
  30 class QFile;
  31
  32 /**
  33  * @brief Maintains the view properties like 'view mode' or 'show hidden files' for a directory.
  34  *
  35  * The view properties are automatically stored inside
  36  * the directory as hidden file called '.dolphinview'. To read out the view properties
  37  * just construct an instance by passing the Url of the directory:
  38  *
  39  * \code
  40  * ViewProperties props(KUrl("/home/peter/Documents"));
  41  * const DolphinView::Mode mode = props.viewMode();
  42  * const bool showHiddenFiles = props.isShowHiddenFilesEnabled();
  43  * \endcode
  44  *
  45  * When modifying a view property, the '.dolphinview' file is automatically updated
  46  * inside the destructor.
  47  */
  48 class ViewProperties
  49 {
  50 public:
  51     explicit ViewProperties(const KUrl& url);
  52     virtual ~ViewProperties();
  53
  54     void setViewMode(DolphinView::Mode mode);
  55     DolphinView::Mode viewMode() const;
  56
  57     void setShowPreview(bool show);
  58     bool showPreview() const;
  59
  60     void setShowHiddenFiles(bool show);
  61     bool showHiddenFiles() const;
  62
  63     void setSorting(DolphinView::Sorting sorting);
  64     DolphinView::Sorting sorting() const;
  65
  66     void setSortOrder(Qt::SortOrder sortOrder);
  67     Qt::SortOrder sortOrder() const;
  68
  69     /**
  70      * Sets the directory properties view mode, show preview,
  71      * show hidden files, sorting and sort order like
  72      * set in \a props.
  73      */
  74     void setDirProperties(const ViewProperties& props);
  75
  76     /**
  77      * If \a autoSave is true, the properties are automatically
  78      * saved when the destructor is called. Per default autosaving
  79      * is enabled.
  80      */
  81     void setAutoSaveEnabled(bool autoSave);
  82     bool isAutoSaveEnabled() const;
  83
  84     void updateTimeStamp();
  85
  86     /**
  87      * Saves the view properties for the directory specified
  88      * in the constructor. The method is automatically
  89      * invoked in the destructor, if
  90      * ViewProperties::isAutoSaveEnabled() returns true and
  91      * at least one property has been changed.
  92      */
  93     void save();
  94
  95 private:
  96     /**
  97      * Returns the destination directory path where the view
  98      * properties are stored. \a subDir specifies the used sub
  99      * directory.
 100      */
 101     QString destinationDir(const QString& subDir) const;
 102
 103     ViewProperties(const ViewProperties& props);
 104     ViewProperties& operator= (const ViewProperties& props);
 105
 106 private:
 107     bool m_changedProps;
 108     bool m_autoSave;
 109     QString m_filepath;
 110     ViewPropertySettings* m_node;
 111 };
 112
 113 #endif