X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsyncableobject.h;h=482470a51ae3d41170031f5706f21bc44e830373;hp=4ce8c91de647c2661a93e8108f9fa7ea49dd9b08;hb=99934fe47293f61e1e62ecc0f0d49f958a992c32;hpb=2e6dc76ae100a6b8e1b1661e422995f90083500e diff --git a/src/common/syncableobject.h b/src/common/syncableobject.h index 4ce8c91d..482470a5 100644 --- a/src/common/syncableobject.h +++ b/src/common/syncableobject.h @@ -29,29 +29,56 @@ 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 toVariantMap() 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 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; } + +public slots: + virtual void setInitialized(); + void requestUpdate(const QVariantMap &properties); + void update(const QVariantMap &properties); + +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; };