adding new settings for proper message redirection

[quassel.git] / src / uisupport / settingspage.h

diff --git a/src/uisupport/settingspage.h b/src/uisupport/settingspage.h
index 926d4d7..2c5ffb4 100644 (file)
--- a/src/uisupport/settingspage.h
+++ b/src/uisupport/settingspage.h
@@ -23,37 +23,75 @@
 
 #include <QWidget>
 
+class QCheckBox;
+
 //! A SettingsPage is a page in the settings dialog.
+/** The SettingsDlg provides suitable standard buttons, such as Ok, Apply, Cancel, Restore Defaults and Reset.
+ *  Some pages might also be used in standalone dialogs or other containers. A SettingsPage provides suitable
+ *  slots and signals to allow interaction with the container.
+ */
 class SettingsPage : public QWidget {
   Q_OBJECT
 
-  public:
-    SettingsPage(const QString &category, const QString &name, QWidget *parent = 0);
-    virtual ~SettingsPage() {};
-    virtual QString category() const;
-    virtual QString title() const;
-
-    virtual bool hasChanged() const = 0;
+public:
+  SettingsPage(const QString &category, const QString &name, QWidget *parent = 0);
+  virtual ~SettingsPage() {};
+  
+  //! The category of this settings page.
+  inline virtual QString category() const { return _category; }
+  
+  //! The title of this settings page.
+  inline virtual QString title() const { return _title; }
+  
+  //! Derived classes need to define this and return true if they have default settings.
+  /** If this method returns true, the "Restore Defaults" button in the SettingsDlg is
+   *  enabled. You also need to provide an implementation of defaults() then.
+   *
+   * The default implementation returns false.
+     */
+  inline virtual bool hasDefaults() const { return false; }
+  
+  //! Check if there are changes in the page, compared to the state saved in permanent storage.
+  inline bool hasChanged() const { return _changed; }
+  
+  //! Called immediately before save() is called.
+  /** Derived classes should return false if saving is not possible (e.g. the current settings are invalid).
+   *  \return false, if the SettingsPage cannot be saved in its current state.
+   */
+  inline virtual bool aboutToSave() { return true; }
 
-  public slots:
-    virtual void save() = 0;
-    virtual void load() = 0;
-    virtual void defaults() = 0;
+  //! sets checked state depending on \checked and stores the value for later comparision
+  static void load(QCheckBox *box, bool checked);
+  static bool hasChanged(QCheckBox *box);
 
-  protected slots:
-    //! Calling this slot is equivalent to emitting changed(true).
-    void changed();
+public slots:
+  //! Save settings to permanent storage.
+  virtual void save() = 0;
+  
+  //! Load settings from permanent storage, overriding any changes the user might have made in the dialog.
+  virtual void load() = 0;
 
-  protected:
-    //! This should be called whenever the widget state changes from unchanged to change or the other way round.
-    void changeState(bool hasChanged = true);
+  //! Restore defaults, overriding any changes the user might have made in the dialog.
+  /** The default implementation does nothing.
+   */
+  inline virtual void defaults() {}
+                        
+protected slots:
+  //! Calling this slot is equivalent to calling setChangedState(true).
+  inline void changed() { setChangedState(true); }
+  
+  //! This should be called whenever the widget state changes from unchanged to change or the other way round.
+  void setChangedState(bool hasChanged = true);
+  
+signals:
+  //! Emitted whenever the widget state changes.
+  void changed(bool hasChanged);
+  
+private:
+  QString _category, _title;
+  bool _changed;
+};
 
-  signals:
-    void changed(bool hasChanged);
 
-  private:
-    QString _category, _title;
-    bool _changed;
-};
 
 #endif