kexthighscore.h

Go to the documentation of this file.

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

#include "kexthighscore_item.h"

#include <kurl.h>
#include <libkdegames_export.h>

#include <QtCore/QVector>



namespace KExtHighscore
{

class Score;
class Item;

class ManagerPrivate;
extern ManagerPrivate *internal;

KDEGAMES_EXPORT uint gameType();

KDEGAMES_EXPORT void setGameType(uint gameType);

KDEGAMES_EXPORT bool configure(QWidget *parent);

KDEGAMES_EXPORT void show(QWidget *parent);

KDEGAMES_EXPORT void submitScore(const Score &score, QWidget *widget);

KDEGAMES_EXPORT Score lastScore();

KDEGAMES_EXPORT Score firstScore();

class KDEGAMES_EXPORT Manager
{
 public:
    explicit Manager(uint nbGameTypes = 1, uint maxNbEntries = 10);
    virtual ~Manager();
    
    void setWWHighscores(const KUrl &url, const QString &version);

    void setTrackLostGames(bool track);
    
    void setTrackDrawGames(bool track);

    void setShowStatistics(bool show);
    
    void setShowDrawGamesStatistic(bool show);

    enum ScoreTypeBound { ScoreNotBound, ScoreBound };
    void setScoreHistogram(const QVector<uint> &scores, ScoreTypeBound type);

    enum ShowMode { AlwaysShow,          
                    NeverShow,           
                    ShowForHigherScore,  
                    ShowForHighestScore  
                  };
    void setShowMode(ShowMode mode);

    enum ScoreType { Normal, MinuteTime };
    void setScoreType(ScoreType type);

    enum ItemType { ScoreDefault, MeanScoreDefault, BestScoreDefault,
                    ElapsedTime };
    static Item *createItem(ItemType type);

    void setScoreItem(uint worstScore, Item *item);

    void addScoreItem(const QString &name, Item *item);

    enum PlayerItemType { MeanScore, BestScore };
    void setPlayerItem(PlayerItemType type, Item *item);

    virtual bool isStrictlyLess(const Score &s1, const Score &s2) const;

    enum LabelType { Standard, I18N, WW, Icon };

    virtual QString gameTypeLabel(uint gameType, LabelType type) const;

 protected:
    virtual void convertLegacy(uint gameType) { Q_UNUSED(gameType); }

    void submitLegacyScore(const Score &score) const;

    virtual void additionalQueryItems(KUrl &url, const Score &score) const
        { Q_UNUSED(url); Q_UNUSED(score); }

    static void addToQueryURL(KUrl &url, const QString &item,
                              const QString &content);

    friend class ManagerPrivate;

 private:
    Manager(const Manager &);
    Manager &operator =(const Manager &);
};

} // namespace

#endif