src/settings/settingspagebase.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 SETTINGSPAGEBASE_H
  22 #define SETTINGSPAGEBASE_H
  23
  24 #include <QWidget>
  25
  26 /**
  27  * @brief Base class for the settings pages of the Dolphin settings dialog.
  28  *
  29  * @author Peter Penz <peter.penz@gmx.at>
  30  */
  31 class SettingsPageBase : public QWidget
  32 {
  33     Q_OBJECT
  34
  35 public:
  36     explicit SettingsPageBase(QWidget* parent = 0);
  37     virtual ~SettingsPageBase();
  38
  39     /**
  40      * Must be implemented by a derived class to
  41      * persistently store the settings.
  42      */
  43     virtual void applySettings() = 0;
  44
  45     /**
  46      * Must be implemented by a derived class to
  47      * restored the settings to default values.
  48      */
  49     virtual void restoreDefaults() = 0;
  50
  51 signals:
  52     /** Is emitted if a setting has been changed. */
  53     void changed();
  54 };
  55
  56 #endif