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 PreviewsModeSettings;
  29 class DetailsModeSettings;
  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  * - split view
  39  * - bookmarks
  40  * - properties for icons and details view
  41  */
  42 class DolphinSettings {
  43 public:
  44     static DolphinSettings& instance();
  45
  46     GeneralSettings* generalSettings() const { return m_generalSettings; }
  47     IconsModeSettings* iconsModeSettings() const { return m_iconsModeSettings; }
  48     PreviewsModeSettings* previewsModeSettings() const { return m_previewsModeSettings; }
  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     /**
  62      * TODO: just temporary until the port to KDE4 has been done
  63      *
  64      * Calculates the width and the height of the grid dependant from \a hint and
  65      * the current settings. The hint gives information about the wanted text
  66      * width, where a lower value indicates a smaller text width. Currently
  67      * in Dolphin the values 0, 1 and 2 are used. See also
  68      * DolhinIconsViewSettings::textWidthHint.
  69      *
  70      * The calculation of the grid width and grid height is a little bit tricky,
  71      * as the user model does not fit to the implementation model of QIconView. The user model
  72      * allows to specify icon-, preview- and text width sizes, whereas the implementation
  73      * model expects only a grid width and height. The nasty thing is that the specified
  74      * width and height varies dependant from the arrangement (e. g. the height is totally
  75      * ignored for the top-to-bottom arrangement inside QIconView).
  76      */
  77     void calculateGridSize(int hint);
  78
  79     /**
  80      * TODO: just temporary until the port to KDE4 has been done
  81      *
  82      * Returns the text width hint dependant from the given settings.
  83      * A lower value indicates a smaller text width. Currently
  84      * in Dolphin the values 0, 1 and 2 are used. The text width hint can
  85      * be used later for DolphinIconsViewSettings::calculateGridSize().
  86      */
  87     int textWidthHint() const;
  88
  89 protected:
  90     DolphinSettings();
  91     virtual ~DolphinSettings();
  92
  93 private:
  94     GeneralSettings* m_generalSettings;
  95     IconsModeSettings* m_iconsModeSettings;
  96     PreviewsModeSettings* m_previewsModeSettings;
  97     DetailsModeSettings* m_detailsModeSettings;
  98 };
  99
 100 #endif