khighscore.h

/*
    This file is part of the TDE games library
    Copyright (C) 2001 Andreas Beckermann (b_mann@gmx.de)
    Copyright (C) 2003 Nicolas Hadacek <hadacek@kde.org>
 
    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.
*/
/*
    $Id$
*/
#ifndef __KHIGHSCORE_H__
#define __KHIGHSCORE_H__
 
#include <tqstring.h>
#include <tqobject.h>
#include <tdemacros.h>
class TDEConfig;
class KFileLock;
class KRawConfig;
class KHighscorePrivate;

class TDE_EXPORT KHighscore : public TQObject
{
    TQ_OBJECT
  
public:
    KHighscore(TQObject* parent = 0);

        KHighscore(bool forceLocal, TQObject *parent);

        void readCurrentConfig();

        static void init(const char *appname);

        bool lockForWriting(TQWidget *widget = 0);

        void writeAndUnlock();

        bool isLocked() const;

    ~KHighscore();

    void writeEntry(int entry, const TQString& key, const TQString& value);

    void writeEntry(int entry, const TQString& key, int value);

    void writeEntry(int entry, const TQString& key, const TQVariant &value);

    TQString readEntry(int entry, const TQString& key, const TQString& pDefault = TQString()) const;

    int readNumEntry(int entry, const TQString& key, int pDefault = -1) const;

    TQVariant readPropertyEntry(int entry, const TQString &key, const TQVariant &pDefault) const;

    bool hasEntry(int entry, const TQString& key) const;

    TQStringList readList(const TQString& key, int lastEntry = 20) const;

    void writeList(const TQString& key, const TQStringList& list);

    bool hasTable() const;

    void sync();

    void setHighscoreGroup(const TQString& groupname = TQString());

    const TQString& highscoreGroup() const;
 
protected:
    TQString group() const;

    TDEConfig* config() const;
 
        void init(bool forceLocal);
 
private:
    KHighscorePrivate* d;
 
        static KFileLock *_lock; // lock on system-wide highscore file
        static KRawConfig *_config; // config for system-wide highscore file
};
 
#endif