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 class KBookmark;
  25 class KBookmarkManager;
  26 class GeneralSettings;
  27 class IconsModeSettings;
  28 class DetailsModeSettings;
  29
  30 /**
  31  * @brief Manages and stores all settings from Dolphin.
  32  *
  33  * The following properties are stored:
  34  * - home Url
  35  * - default view mode
  36  * - Url navigator state (editable or not)
  37  * - split view
  38  * - bookmarks
  39  * - properties for icons and details view
  40  */
  41 class DolphinSettings {
  42 public:
  43     static DolphinSettings& instance();
  44
  45     GeneralSettings* generalSettings() const { return m_generalSettings; }
  46     IconsModeSettings* iconsModeSettings() const { return m_iconsModeSettings; }
  47     DetailsModeSettings* detailsModeSettings() const { return m_detailsModeSettings; }
  48
  49     KBookmarkManager* bookmarkManager() const;
  50
  51     // TODO: should this really belong here or get moved to a derived KBookmarkManager?
  52     // Dolphin uses some lists where an index is given and the corresponding bookmark
  53     // should get retrieved...
  54     KBookmark bookmark(int index) const;
  55
  56     /** @see DolphinSettingsBase::save */
  57     virtual void save();
  58
  59     /**
  60      * TODO: just temporary until the port to KDE4 has been done
  61      *
  62      * Calculates the width and the height of the grid dependant from \a hint and
  63      * the current settings. The hint gives information about the wanted text
  64      * width, where a lower value indicates a smaller text width. Currently
  65      * in Dolphin the values 0, 1 and 2 are used. See also
  66      * DolhinIconsViewSettings::textWidthHint.
  67      *
  68      * The calculation of the grid width and grid height is a little bit tricky,
  69      * as the user model does not fit to the implementation model of QIconView. The user model
  70      * allows to specify icon-, preview- and text width sizes, whereas the implementation
  71      * model expects only a grid width and height. The nasty thing is that the specified
  72      * width and height varies dependant from the arrangement (e. g. the height is totally
  73      * ignored for the top-to-bottom arrangement inside QIconView).
  74      */
  75     void calculateGridSize(int hint);
  76
  77     /**
  78      * TODO: just temporary until the port to KDE4 has been done
  79      *
  80      * Returns the text width hint dependant from the given settings.
  81      * A lower value indicates a smaller text width. Currently
  82      * in Dolphin the values 0, 1 and 2 are used. The text width hint can
  83      * be used later for DolphinIconsViewSettings::calculateGridSize().
  84      */
  85     int textWidthHint() const;
  86
  87 protected:
  88     DolphinSettings();
  89     virtual ~DolphinSettings();
  90
  91 private:
  92     GeneralSettings* m_generalSettings;
  93     IconsModeSettings* m_iconsModeSettings;
  94     DetailsModeSettings* m_detailsModeSettings;
  95 };
  96
  97 #endif