src/mastersettings.h

   1 /*
   2   Copyright (c) 2006 Paolo Capriotti <p.capriotti@gmail.com>
   3             (c) 2006 Maurizio Monge <maurizio.monge@kdemail.net>
   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
  11 #ifndef MASTERSETTINGS_H
  12 #define MASTERSETTINGS_H
  13
  14 #include <memory>
  15 #include <iostream>
  16 #include <list>
  17 #include <QDir>
  18
  19 #include "settings.h"
  20
  21 class MasterSettings : public QObject
  22                      , public Settings {
  23 Q_OBJECT
  24 public:
  25   enum LookupType {
  26     PathLookup,
  27     StandardDirsLookup
  28   };
  29 private:
  30   struct Observer {
  31     QObject* object;
  32     const char* dependency;
  33     const char* method;
  34
  35     Observer(QObject* obj, const char* meth, const char* dep)
  36     : object(obj)
  37     , dependency(dep)
  38     , method(meth) { }
  39   };
  40   typedef std::list<Observer> ObserverList;
  41
  42   ObserverList m_observers;
  43   QString m_filename;
  44   mutable QDomDocument m_doc;
  45
  46   void setupObserver(Observer&);
  47 private Q_SLOTS:
  48   void objectDestroyed(QObject* o);
  49
  50 protected:
  51   virtual QDomElement node() const;
  52
  53 public:
  54   MasterSettings(const QString& file, LookupType lookup = StandardDirsLookup);
  55
  56   /**
  57     * Bind to the local configuration file.
  58     */
  59   MasterSettings();
  60   ~MasterSettings();
  61
  62   /**
  63     * Set up an observer to be notified whenever settings change.
  64     * \param observer The object to be notified.
  65     * \param method The callback method for the notification, specified as a C string.
  66     * \note @a method should be just the method name (no parentheses, no SLOT macro).
  67     */
  68   void onChange(QObject* observer, const char* method);
  69
  70   /**
  71     * Set up an observer to be notified whenever settings change.
  72     * \param observer The object to be notified.
  73     * \param method The callback method for the notification, specified as a C string.
  74     * \param dependency A C string representing a type (inheriting from QObject). Objects
  75     *                   of this type will be notified before @a observer.
  76     * \note @a method should be just the method name (no parentheses, no SLOT macro).
  77     */
  78   void onChange(QObject* observer, const char* method, const char* dependency);
  79
  80   void changed();
  81   void sync();
  82   QString filename() const;
  83 };
  84
  85 MasterSettings& settings();
  86
  87 #endif // MASTERSETTINGS_H