added SignalProxy::isSecure() to determine if all connections are secure (ssl encrypt...

[quassel.git] / src / common / syncableobject.h

diff --git a/src/common/syncableobject.h b/src/common/syncableobject.h
index f89c168..dfe3887 100644 (file)
--- a/src/common/syncableobject.h
+++ b/src/common/syncableobject.h
@@ -18,8 +18,8 @@
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef _SYNCABLEOBJECT_H_
-#define _SYNCABLEOBJECT_H_
+#ifndef SYNCABLEOBJECT_H
+#define SYNCABLEOBJECT_H
 
 #include <QDataStream>
 #include <QMetaType>
@@ -29,35 +29,58 @@
 class SyncableObject : public QObject {
   Q_OBJECT
 
-  public:
-    SyncableObject(QObject *parent = 0);
-    SyncableObject(const SyncableObject &other, QObject *parent = 0);
-
-    //! Stores the object's state into a QVariantMap.
-    /** The default implementation takes dynamic properties as well as getters that have
-     *  names starting with "init" and stores them in a QVariantMap. Override this method in
-     *  derived classes in order to store the object state in a custom form.
-     *  \Note: This is used by SignalProxy to transmit the state of the object to clients
-     *         that request the initial object state. Later updates use a different mechanism
-     *         and assume that the state is completely covered by properties and init* getters.
-     *         DO NOT OVERRIDE THIS unless you know exactly what you do!
-     *  \return The object's state in a QVariantMap
-     */
-    virtual QVariantMap toVariantMap();
-
-    //! Initialize the object's state from a given QVariantMap.
-    /** \see toVarianMap() for important information concerning this method.
-     */
-    virtual void fromVariantMap(const QVariantMap &map);
-
-  private:
-    bool setInitValue(const QString &property, const QVariant &value);
+public:
+  SyncableObject(QObject *parent = 0);
+  SyncableObject(const QString &objectName, QObject *parent = 0);
+  SyncableObject(const SyncableObject &other, QObject *parent = 0);
 
-};
+  //! Stores the object's state into a QVariantMap.
+  /** The default implementation takes dynamic properties as well as getters that have
+   *  names starting with "init" and stores them in a QVariantMap. Override this method in
+   *  derived classes in order to store the object state in a custom form.
+   *  \note  This is used by SignalProxy to transmit the state of the object to clients
+   *         that request the initial object state. Later updates use a different mechanism
+   *         and assume that the state is completely covered by properties and init* getters.
+   *         DO NOT OVERRIDE THIS unless you know exactly what you do!
+   *
+   *  \return The object's state in a QVariantMap
+   */
+  virtual QVariantMap toVariantMap();
+
+  //! Initialize the object's state from a given QVariantMap.
+  /** \see toVariantMap() for important information concerning this method.
+   */
+  virtual void fromVariantMap(const QVariantMap &properties);
+
+  virtual bool isInitialized() const;
+
+  virtual const QMetaObject *syncMetaObject() const { return metaObject(); };
+
+  inline void setAllowClientUpdates(bool allow) { _allowClientUpdates = allow; }
+  inline bool allowClientUpdates() const { return _allowClientUpdates; }
 
-QDataStream &operator<<(QDataStream &out, SyncableObject object);
-QDataStream &operator>>(QDataStream &in, SyncableObject &object);
+public slots:
+  virtual void setInitialized();
+  void requestUpdate(const QVariantMap &properties);
+  virtual void update(const QVariantMap &properties);
 
-Q_DECLARE_METATYPE(SyncableObject);
+protected:
+  void renameObject(const QString &newName);
+  SyncableObject &operator=(const SyncableObject &other);
+
+signals:
+  void initDone();
+  void updatedRemotely();
+  void updated(const QVariantMap &properties);
+  void updateRequested(const QVariantMap &properties);
+  void objectRenamed(QString newName, QString oldName);
+
+private:
+  bool setInitValue(const QString &property, const QVariant &value);
+
+  bool _initialized;
+  bool _allowClientUpdates;
+
+};
 
 #endif