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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 class SidebarSettings;
  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 DolphinSettings {
  44 public:
  45     static DolphinSettings& instance();
  46
  47     GeneralSettings* generalSettings() const { return m_generalSettings; }
  48     IconsModeSettings* iconsModeSettings() const { return m_iconsModeSettings; }
  49     PreviewsModeSettings* previewsModeSettings() const { return m_previewsModeSettings; }
  50     DetailsModeSettings* detailsModeSettings() const { return m_detailsModeSettings; }
  51     SidebarSettings* sidebarSettings() const { return m_sidebarSettings; }
  52
  53     KBookmarkManager* bookmarkManager() const;
  54
  55     // TODO: should this really belong here or get moved to a derived KBookmarkManager?
  56     // Dolphin uses some lists where an index is given and the corresponding bookmark
  57     // should get retrieved...
  58     KBookmark bookmark(int index) const;
  59
  60     /** @see DolphinSettingsBase::save */
  61     virtual void save();
  62
  63     /**
  64      * TODO: just temporary until the port to KDE4 has been done
  65      *
  66      * Calculates the width and the height of the grid dependant from \a hint and
  67      * the current settings. The hint gives information about the wanted text
  68      * width, where a lower value indicates a smaller text width. Currently
  69      * in Dolphin the values 0, 1 and 2 are used. See also
  70      * DolhinIconsViewSettings::textWidthHint.
  71      *
  72      * The calculation of the grid width and grid height is a little bit tricky,
  73      * as the user model does not fit to the implementation model of QIconView. The user model
  74      * allows to specify icon-, preview- and text width sizes, whereas the implementation
  75      * model expects only a grid width and height. The nasty thing is that the specified
  76      * width and height varies dependant from the arrangement (e. g. the height is totally
  77      * ignored for the top-to-bottom arrangement inside QIconView).
  78      */
  79     void calculateGridSize(int hint);
  80
  81     /**
  82      * TODO: just temporary until the port to KDE4 has been done
  83      *
  84      * Returns the text width hint dependant from the given settings.
  85      * A lower value indicates a smaller text width. Currently
  86      * in Dolphin the values 0, 1 and 2 are used. The text width hint can
  87      * be used later for DolphinIconsViewSettings::calculateGridSize().
  88      */
  89     int textWidthHint() const;
  90
  91 protected:
  92     DolphinSettings();
  93     virtual ~DolphinSettings();
  94
  95 private:
  96     GeneralSettings* m_generalSettings;
  97     IconsModeSettings* m_iconsModeSettings;
  98     PreviewsModeSettings* m_previewsModeSettings;
  99     DetailsModeSettings* m_detailsModeSettings;
 100     SidebarSettings* m_sidebarSettings;
 101 };
 102
 103 #endif