src/uisupport/settingspage.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   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) version 3.                                           *
   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 _SETTINGSPAGE_H_
  22 #define _SETTINGSPAGE_H_
  23
  24 #include <QWidget>
  25
  26 class QCheckBox;
  27 class QComboBox;
  28 class QSpinBox;
  29
  30 //! A SettingsPage is a page in the settings dialog.
  31 /** The SettingsDlg provides suitable standard buttons, such as Ok, Apply, Cancel, Restore Defaults and Reset.
  32  *  Some pages might also be used in standalone dialogs or other containers. A SettingsPage provides suitable
  33  *  slots and signals to allow interaction with the container.
  34  *
  35  *  A derived class needs to keep track of its changed state. Whenever a child widget changes, it needs to be
  36  *  compared to its value in permanent storage, and the changed state updated accordingly by calling setChangedState().
  37  *  For most standard widgets, SettingsPage can do this automatically if desired. Such a child widget needs to have
  38  *  a dynamic property \c settingsKey that maps to the key in the client configuration file. This key is appended
  39  *  to settingsKey(), which must be set to a non-null value in a derived class. If the widget's key starts with '/',
  40  *  its key is treated as a global path starting from the root, rather than from settingsKey().
  41  *  A second dynamic property \c defaultValue can be defined in child widgets as well.
  42  *
  43  *  SettingsPage manages loading, saving, setting to default and setting the changed state for all automatic child widgets.
  44  *  Derived classes must be sure to call initAutoWidgets() *after* setupUi(); they also need to call the baseclass implementations
  45  *  of load(), save() and defaults() (preferably at the end of the derived function, since they call setChangedState(false)).
  46  *
  47  *  The following widgets can be handled for now:
  48  *    - QAbstractButton (isChecked(), e.g. for QCheckBox and QRadioButton)
  49  *    - QLineEdit, QTextEdit (text())
  50  *    - QComboBox (currentIndex())
  51  *    - QSpinBox (value())
  52  */
  53 class SettingsPage : public QWidget {
  54   Q_OBJECT
  55
  56 public:
  57   SettingsPage(const QString &category, const QString &name, QWidget *parent = 0);
  58   virtual ~SettingsPage() {};
  59
  60   //! The category of this settings page.
  61   inline virtual QString category() const { return _category; }
  62
  63   //! The title of this settings page.
  64   inline virtual QString title() const { return _title; }
  65
  66   //! The key this settings page stores its values under
  67   /** This needs to be overriden to enable automatic loading/saving/hasChanged checking of widgets.
  68    *  The child widgets' values will be stored in client settings under this key. Every widget that
  69    *  should be automatically handled needs to have a \c settingsKey property set, and should also provide
  70    *  a \c defaultValue property.
  71    *  You can return an empty string (as opposed to a null string) to use the config root as a base, and
  72    *  you can override this key for individual widgets by prefixing their SettingsKey with /.
  73    */
  74   inline virtual QString settingsKey() const { return QString(); }
  75
  76   //! Derived classes need to define this and return true if they have default settings.
  77   /** If this method returns true, the "Restore Defaults" button in the SettingsDlg is
  78    *  enabled. You also need to provide an implementation of defaults() then.
  79    *
  80    * The default implementation returns false.
  81      */
  82   inline virtual bool hasDefaults() const { return false; }
  83
  84   //! Check if there are changes in the page, compared to the state saved in permanent storage.
  85   inline bool hasChanged() const { return _changed || _autoWidgetsChanged; }
  86
  87   //! Called immediately before save() is called.
  88   /** Derived classes should return false if saving is not possible (e.g. the current settings are invalid).
  89    *  \return false, if the SettingsPage cannot be saved in its current state.
  90    */
  91   inline virtual bool aboutToSave() { return true; }
  92
  93   //! sets checked state depending on \checked and stores the value for later comparision
  94   static void load(QCheckBox *box, bool checked);
  95   static bool hasChanged(QCheckBox *box);
  96   static void load(QComboBox *box, int index);
  97   static bool hasChanged(QComboBox *box);
  98   static void load(QSpinBox *box, int value);
  99   static bool hasChanged(QSpinBox *box);
 100
 101 public slots:
 102   //! Save settings to permanent storage.
 103   /** This baseclass implementation saves the autoWidgets, so be sure to call it if you use
 104    *  this feature in your settingsPage!
 105    */
 106   virtual void save();
 107
 108   //! Load settings from permanent storage, overriding any changes the user might have made in the dialog.
 109   /** This baseclass implementation loads the autoWidgets, so be sure to call it if you use
 110    *  this feature in your settingsPage!
 111    */
 112   virtual void load();
 113
 114   //! Restore defaults, overriding any changes the user might have made in the dialog.
 115   /** This baseclass implementation loads the defaults of the autoWidgets (if available), so be sure
 116    *  to call it if you use this feature in your settingsPage!
 117    */
 118   virtual void defaults();
 119
 120 protected slots:
 121   //! Calling this slot is equivalent to calling setChangedState(true).
 122   inline void changed() { setChangedState(true); }
 123
 124   //! This should be called whenever the widget state changes from unchanged to change or the other way round.
 125   void setChangedState(bool hasChanged = true);
 126
 127 protected:
 128   void initAutoWidgets();
 129
 130 signals:
 131   //! Emitted whenever the widget state changes.
 132   void changed(bool hasChanged);
 133
 134 private slots:
 135   // for auto stuff
 136   void autoWidgetHasChanged();
 137
 138 private:
 139   void findAutoWidgets(QObject *parent, QObjectList *widgetList) const;
 140   QByteArray autoWidgetPropertyName(QObject *widget) const;
 141   QString autoWidgetSettingsKey(QObject *widget) const;
 142
 143   QString _category, _title;
 144   bool _changed, _autoWidgetsChanged;
 145   QObjectList _autoWidgets;
 146 };
 147
 148
 149
 150 #endif