1 /***************************************************************************
2 * Copyright (C) 2005-08 by the Quassel IRC Team *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #ifndef SYNCABLEOBJECT_H
22 #define SYNCABLEOBJECT_H
24 #include <QDataStream>
27 #include <QVariantMap>
29 class SyncableObject : public QObject {
33 SyncableObject(QObject *parent = 0);
34 SyncableObject(const QString &objectName, QObject *parent = 0);
35 SyncableObject(const SyncableObject &other, QObject *parent = 0);
37 //! Stores the object's state into a QVariantMap.
38 /** The default implementation takes dynamic properties as well as getters that have
39 * names starting with "init" and stores them in a QVariantMap. Override this method in
40 * derived classes in order to store the object state in a custom form.
41 * \note This is used by SignalProxy to transmit the state of the object to clients
42 * that request the initial object state. Later updates use a different mechanism
43 * and assume that the state is completely covered by properties and init* getters.
44 * DO NOT OVERRIDE THIS unless you know exactly what you do!
46 * \return The object's state in a QVariantMap
48 virtual QVariantMap toVariantMap();
50 //! Initialize the object's state from a given QVariantMap.
51 /** \see toVariantMap() for important information concerning this method.
53 virtual void fromVariantMap(const QVariantMap &properties);
55 virtual bool isInitialized() const;
57 virtual const QMetaObject *syncMetaObject() const { return metaObject(); };
59 inline void setAllowClientUpdates(bool allow) { _allowClientUpdates = allow; }
60 inline bool allowClientUpdates() const { return _allowClientUpdates; }
63 virtual void setInitialized();
64 void requestUpdate(const QVariantMap &properties);
65 virtual void update(const QVariantMap &properties);
68 void renameObject(const QString &newName);
69 SyncableObject &operator=(const SyncableObject &other);
73 void updatedRemotely();
74 void updated(const QVariantMap &properties);
75 void updateRequested(const QVariantMap &properties);
76 void objectRenamed(QString newName, QString oldName);
79 bool setInitValue(const QString &property, const QVariant &value);
82 bool _allowClientUpdates;