src/settings/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 GeneralSettings;
  27 class KFilePlacesModel;
  28
  29 // TODO: Remove this class completely and just work with the settings directly instead
  30
  31 /**
  32  * @brief Manages and stores all settings from Dolphin.
  33  *
  34  * The following properties are stored:
  35  * - home URL
  36  * - default view mode
  37  * - URL navigator state (editable or not)
  38  * - Text completion state
  39  * - split view
  40  * - properties for views
  41  */
  42 class LIBDOLPHINPRIVATE_EXPORT DolphinSettings
  43 {
  44 public:
  45     static DolphinSettings& instance();
  46
  47     GeneralSettings* generalSettings() const;
  48     KFilePlacesModel* placesModel() const;
  49     virtual void save();
  50
  51 protected:
  52     DolphinSettings();
  53     virtual ~DolphinSettings();
  54     friend class DolphinSettingsSingleton;
  55
  56 private:
  57     GeneralSettings* m_generalSettings;
  58     KFilePlacesModel* m_placesModel;
  59 };
  60
  61 inline GeneralSettings* DolphinSettings::generalSettings() const
  62 {
  63     return m_generalSettings;
  64 }
  65
  66 inline KFilePlacesModel* DolphinSettings::placesModel() const
  67 {
  68     return m_placesModel;
  69 }
  70
  71 #endif