kgamepropertyhandler.h

Go to the documentation of this file.

/*
    This file is part of the KDE games library
    Copyright (C) 2001 Andreas Beckermann (b_mann@gmx.de)
    Copyright (C) 2001 Martin Heni (kde at heni-online.de)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef __KGAMEPROPERTYHANDLER_H_
#define __KGAMEPROPERTYHANDLER_H_

#include <QtCore/QObject>
#include <QtCore/QMultiHash>

#include "kgameproperty.h"
#include "../libkdegamesprivate_export.h"

class QDataStream;
class KGame;
//class KGamePropertyBase;

class KGamePropertyHandlerPrivate; // wow - what a name ;-)

class KDEGAMESPRIVATE_EXPORT KGamePropertyHandler : public QObject
{
    Q_OBJECT

public:
    KGamePropertyHandler(QObject* parent = 0);

    KGamePropertyHandler(int id, const QObject* receiver, const char* sendf, const char* emitf, QObject* parent = 0);
    ~KGamePropertyHandler();

    void registerHandler(int id, const QObject *receiver, const char * send, const char *emit); 

    bool processMessage(QDataStream &stream, int id, bool isSender );
    
    int id() const;
    
    bool addProperty(KGamePropertyBase *data, const QString& name=QString());

    bool removeProperty(KGamePropertyBase *data);

    int uniquePropertyId();


    virtual bool load(QDataStream &stream);

    virtual bool save(QDataStream &stream);
    
    bool sendProperty(QDataStream &s);

    void sendLocked(bool l);

    void emitSignal(KGamePropertyBase *data);

    QString propertyName(int id) const;

    KGamePropertyBase *find(int id);

    void clear();

    void setId(int id);//AB: TODO: make this protected in KGamePropertyHandler!!

    void unlockProperties();

    void setPolicy(KGamePropertyBase::PropertyPolicy p, bool userspace=true);

    void lockDirectEmit();

    void unlockDirectEmit();
  
    KGamePropertyBase::PropertyPolicy policy();

    void lockProperties();

    void flush();

        QMultiHash<int, KGamePropertyBase*> &dict() const; 

    QString propertyValue(KGamePropertyBase* property);


    void Debug();


Q_SIGNALS:
    void signalPropertyChanged(KGamePropertyBase *);

    void signalSendMessage(int msgid, QDataStream &, bool* sent); // AB shall we change bool* into bool& again?

    void signalRequestValue(KGamePropertyBase* property, QString& value);

private:
    friend class KGamePropertyHandlerPrivate;
    KGamePropertyHandlerPrivate *const d;

    Q_DISABLE_COPY(KGamePropertyHandler)
};

#endif