src/dolphinsettings.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 DOLPHINSETTINGS_H
  22 #define DOLPHINSETTINGS_H
  23
  24 #include <libdolphin_export.h>
  25
  26 class KBookmark;
  27 class KBookmarkManager;
  28 class GeneralSettings;
  29 class IconsModeSettings;
  30 class DetailsModeSettings;
  31
  32 /**
  33  * @brief Manages and stores all settings from Dolphin.
  34  *
  35  * The following properties are stored:
  36  * - home Url
  37  * - default view mode
  38  * - Url navigator state (editable or not)
  39  * - split view
  40  * - bookmarks
  41  * - properties for icons and details view
  42  */
  43 class LIBDOLPHINPRIVATE_EXPORT DolphinSettings {
  44 public:
  45     static DolphinSettings& instance();
  46
  47     GeneralSettings* generalSettings() const { return m_generalSettings; }
  48     IconsModeSettings* iconsModeSettings() const { return m_iconsModeSettings; }
  49     DetailsModeSettings* detailsModeSettings() const { return m_detailsModeSettings; }
  50
  51     KBookmarkManager* bookmarkManager() const;
  52
  53     // TODO: should this really belong here or get moved to a derived KBookmarkManager?
  54     // Dolphin uses some lists where an index is given and the corresponding bookmark
  55     // should get retrieved...
  56     KBookmark bookmark(int index) const;
  57
  58     /** @see DolphinSettingsBase::save */
  59     virtual void save();
  60
  61 protected:
  62     DolphinSettings();
  63     virtual ~DolphinSettings();
  64
  65 private:
  66     GeneralSettings* m_generalSettings;
  67     IconsModeSettings* m_iconsModeSettings;
  68     DetailsModeSettings* m_detailsModeSettings;
  69 };
  70
  71 #endif