khighscore.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) 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.
*/

#ifndef KHIGHSCORE_H
#define KHIGHSCORE_H

#include <libkdegames_export.h>

#include <QtCore/QObject>

class KConfig;

class KDEGAMES_EXPORT KHighscore : public QObject
{
    Q_OBJECT
    public:
        explicit KHighscore(bool forceLocal=true, QObject *parent=0);

        void readCurrentConfig();

        static void init(const char *appname);

        bool lockForWriting(QWidget *widget = 0);

        void writeAndUnlock();

        bool isLocked() const;

        ~KHighscore();

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

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

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

        QString readEntry(int entry, const QString& key, const QString& pDefault = QLatin1String("")) const;

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

        QVariant readPropertyEntry(int entry, const QString &key, const QVariant &pDefault) const;

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

        QStringList readList(const QString& key, int lastEntry = 20) const;

        void writeList(const QString& key, const QStringList& list);

        bool hasTable() const;

        void setHighscoreGroup(const QString& groupname = QLatin1String(""));

        QStringList groupList() const;

        QString highscoreGroup() const;

    protected:
        QString group() const;

        KConfig* config() const;

        void init(bool forceLocal);

    private:
        class KHighscorePrivate;
        KHighscorePrivate* const d;
};

#endif