kexthighscore_item.h

Go to the documentation of this file.

/*
    This file is part of the KDE games library
    Copyright (C) 2001-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 KEXTHIGHSCORE_ITEM_H
#define KEXTHIGHSCORE_ITEM_H

#include <QtCore/QVariant>
#include <QtCore/QMap>
#include <QtCore/QVector>
#include <libkdegames_export.h>
class QWidget;


namespace KExtHighscore
{

//-----------------------------------------------------------------------------
class KDEGAMES_EXPORT Item
{
 public:
    enum Format { NoFormat, OneDecimal, Percentage, MinuteTime,
                  DateTime };

    enum Special { NoSpecial, ZeroNotDefined, NegativeNotDefined,
                   DefaultNotDefined, Anonymous };

    explicit Item(const QVariant &def = QVariant::Invalid,
         const QString &label = QString(), Qt::AlignmentFlag alignment = Qt::AlignRight);

    virtual ~Item();

    void setPrettyFormat(Format format);

    void setPrettySpecial(Special special);

    bool isVisible() const    { return !_label.isEmpty(); }

    void setLabel(const QString &label) { _label = label; }

    QString label() const { return _label; }

    int alignment() const { return _alignment; }

    void setDefaultValue(const QVariant &value) { _default = value; }

    QVariant defaultValue() const { return _default; }

    virtual QVariant read(uint i, const QVariant &value) const;

    virtual QString pretty(uint i, const QVariant &value) const;

 private:
    QVariant _default;
    QString  _label;
    Qt::AlignmentFlag   _alignment;
    Format   _format;
    Special  _special;

    class ItemPrivate;
    ItemPrivate *d;

    static QString timeFormat(uint);
};

//-----------------------------------------------------------------------------
enum ScoreType { Won = 0, Lost = -1, Draw = -2 };

class Score;
KDEGAMES_EXPORT QDataStream &operator <<(QDataStream &stream, const Score &score);
KDEGAMES_EXPORT QDataStream &operator >>(QDataStream &stream, Score &score);

class KDEGAMES_EXPORT Score
{
 public:
    Score(ScoreType type = Won);

    ~Score();

    ScoreType type() const { return _type; }

    void setType(ScoreType type) { _type = type; }

    QVariant data(const QString &name) const;

    void setData(const QString &name, const QVariant &value);

    uint score() const { return data(QLatin1String("score")).toUInt(); }

    void setScore(uint score) { setData(QLatin1String("score"), score); }

    bool isTheWorst() const;

    bool operator <(const Score &score);

 private:
    ScoreType  _type;
    QMap<QString, QVariant> _data;

    class ScorePrivate;
    ScorePrivate *d;

    friend class MultiplayerScores;

    friend KDEGAMES_EXPORT QDataStream &operator <<(QDataStream &stream, const Score &score);
    friend KDEGAMES_EXPORT QDataStream &operator >>(QDataStream &stream, Score &score);
};

class MultiplayerScores;
KDEGAMES_EXPORT QDataStream &operator <<(QDataStream &stream, const MultiplayerScores &score);
KDEGAMES_EXPORT QDataStream &operator >>(QDataStream &stream, MultiplayerScores &score);

class KDEGAMES_EXPORT MultiplayerScores
{
 public:
    MultiplayerScores();

    ~MultiplayerScores();

    void setPlayerCount(uint nb);

    void setName(uint player, const QString &name);

    void addScore(uint player, const Score &score);

    void clear();

    void show(QWidget *parent);

 private:
    QVector<uint>  _nbGames;
    QVector<Score> _scores;

    class MultiplayerScoresPrivate;
    MultiplayerScoresPrivate *d;

    friend KDEGAMES_EXPORT QDataStream &operator <<(QDataStream &stream,
                                    const MultiplayerScores &score);
    friend KDEGAMES_EXPORT QDataStream &operator >>(QDataStream &stream,
                                    MultiplayerScores &score);
};

} // namespace

#endif