src/uisupport/settingspage.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 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 //! A SettingsPage is a page in the settings dialog.
  27 class SettingsPage : public QWidget {
  28   Q_OBJECT
  29
  30   public:
  31     SettingsPage(const QString &category, const QString &name, QWidget *parent = 0);
  32     virtual ~SettingsPage() {};
  33     virtual QString category() const;
  34     virtual QString title() const;
  35
  36     bool hasChanged() const;
  37
  38     //! Called immediately before save() is called.
  39     /** Derived classes should return false if saving is not possible (e.g. the current settings are invalid).
  40      *  \return false, if the SettingsPage cannot be saved in its current state.
  41      */
  42     virtual bool aboutToSave();
  43
  44   public slots:
  45     virtual void save() = 0;
  46     virtual void load() = 0;
  47     virtual void defaults() = 0;
  48
  49   protected slots:
  50     //! Calling this slot is equivalent to calling changeState(true).
  51     void changed();
  52
  53   protected:
  54     //! This should be called whenever the widget state changes from unchanged to change or the other way round.
  55     void changeState(bool hasChanged = true);
  56
  57   signals:
  58     //! Emitted whenever the widget state changes.
  59     void changed(bool hasChanged);
  60
  61   private:
  62     QString _category, _title;
  63     bool _changed;
  64 };
  65
  66 #endif