1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/*
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 <qvariant.h>
#include <qnamespace.h>
#include <qmap.h>
#include <qvaluevector.h>
#include <kdemacros.h>
class QWidget;
namespace KExtHighscore
{
//-----------------------------------------------------------------------------
/**
* This class defines how to convert and how to display
* a highscore element (such as the score, the date, ...) or a player
* info (such as the player name, the best score, ...).
*/
class KDE_EXPORT Item
{
public:
/**
* Possible display format.
* <ul>
* <li> @p NoFormat : no formatting (default) </li>
* <li> @p OneDecimal : with one decimal (only for Double) </li>
* <li> @p Percentage : with one decimal + % (only for Double) </li>
* <li> @p MinuteTime : MM:SS ie 3600 is 00:00, 1 is 59:59 and 0 is
* undefined (only for UInt, Int and Double) </li>
* <li> @p DateTime : date and time according to locale (only for
* DateTime) </li>
* </ul>
*/
enum Format { NoFormat, OneDecimal, Percentage, MinuteTime,
DateTime };
/**
* Possible special value for display format.
* <ul>
* <li> @p NoSpecial : no special value ; a null DateTime is replaced by
* "--" (default) </li>
* <li> ZeroNotDefined : 0 is replaced by "--" (only for UInt, Int and
* Double) </li>
* <li> @p NegativeNotDefined : negative values are replaced by "--" (only
* for Int and Double) </li>
* <li> @p DefaultNotDefined : default value is replaced by "--" </li>
* <li> @p Anonymous : replace the special value ItemBase::ANONYMOUS
* by i18n("anonymous") (only for String) </li>
* </ul>
*/
enum Special { NoSpecial, ZeroNotDefined, NegativeNotDefined,
DefaultNotDefined, Anonymous };
/**
* Constructor.
*
* @param def default value ; the QVariant also gives the type of data.
* Be sure to cast the value to the required type (for e.g. with uint).
* @param label the label corresponding to the item. If empty, the item
* is not shown.
* @param alignment the alignment of the item.
*/
Item(const QVariant &def = QVariant::Invalid,
const QString &label = QString::null, int alignment = Qt::AlignRight);
virtual ~Item();
/**
* Set the display format.
* @see Format
*/
void setPrettyFormat(Format format);
/**
* Set the special value for display.
* @see Special
*/
void setPrettySpecial(Special special);
/**
* @return if the item is shown.
*/
bool isVisible() const { return !_label.isEmpty(); }
/**
* Set the label.
*/
void setLabel(const QString &label) { _label = label; }
/**
* @return the label.
*/
QString label() const { return _label; }
/**
* @return the alignment.
*/
int alignment() const { return _alignment; }
/**
* Set default value.
*/
void setDefaultValue(const QVariant &value) { _default = value; }
/**
* @return the default value.
*/
const QVariant &defaultValue() const { return _default; }
/**
* @return the converted value (by default the value is left
* unchanged). Most of the time you don't need to reimplement this method.
*
* @param i the element index ("rank" for score / "id" for player)
* @param value the value to convert
*/
virtual QVariant read(uint i, const QVariant &value) const;
/**
* @return the string to be displayed. You may need to reimplement this
* method for special formatting (different from the standard ones).
*
* @param i the element index ("rank" for score / "id" for player)
* @param value the value to convert
*/
virtual QString pretty(uint i, const QVariant &value) const;
private:
QVariant _default;
QString _label;
int _alignment;
Format _format;
Special _special;
class ItemPrivate;
ItemPrivate *d;
static QString timeFormat(uint);
};
//-----------------------------------------------------------------------------
/**
* Possible score type.
* @p Won the game has been won.
* @p Lost the game has been lost or has been aborted.
* @p Draw the game is a draw.
*/
enum ScoreType { Won = 0, Lost = -1, Draw = -2 };
/**
* This class contains data for a score. You should not inherit from
* this class but reimplement the methods in Highscores.
*/
class KDE_EXPORT Score
{
public:
Score(ScoreType type = Won);
~Score();
/**
* @return the game type.
*/
ScoreType type() const { return _type; }
/**
* Set the game type.
*/
void setType(ScoreType type) { _type = type; }
/**
* @return the data associated with the named Item.
*/
const QVariant &data(const QString &name) const;
/**
* Set the data associated with the named Item. Note that the
* value should have the type of the default value of the
* Item.
*/
void setData(const QString &name, const QVariant &value);
/**
* @return the score value.
*
* Equivalent to <pre>data("score").toUInt()</pre>.
*/
uint score() const { return data("score").toUInt(); }
/**
* Set the score value.
*
* Equivalent to <pre>setData("score", score)</pre>.
*/
void setScore(uint score) { setData("score", score); }
/**
* @return true if this is the worst possible score (ie the default
* argument of ScoreItem).
*/
bool isTheWorst() const;
/**
* Comparison operator.
*
* @see Manager::isStrictlyLess
*/
bool operator <(const Score &score);
private:
ScoreType _type;
QMap<QString, QVariant> _data;
class ScorePrivate;
ScorePrivate *d;
friend class MultiplayerScores;
friend QDataStream &operator <<(QDataStream &stream, const Score &score);
friend QDataStream &operator >>(QDataStream &stream, Score &score);
};
KDE_EXPORT QDataStream &operator <<(QDataStream &stream, const Score &score);
KDE_EXPORT QDataStream &operator >>(QDataStream &stream, Score &score);
/**
* This class is used to store and show scores for multiplayer games.
*
* Example of use:
* Initialize the class:
* <pre>
* KExtHighscore::MultiScore ms(2);
* ms.setPlayerName(0, "player 1");
* ms.setPlayerName(1, "player 2");
* </pre>
* At the end of each game, add the score of each players:
* <pre>
* KExtHighscore::Score score(KExtHighscore::Won);
* score.setScore(100);
* ms.addScore(0, score);
* score.setType(KExtHighscore::Lost);
* score.setScore(20);
* ms.addScore(1, score);
* </pre>
*/
class KDE_EXPORT MultiplayerScores
{
public:
MultiplayerScores();
~MultiplayerScores();
/**
* Set the number of players and clear the scores.
*/
void setPlayerCount(uint nb);
/**
* Set the name of player.
*/
void setName(uint player, const QString &name);
/**
* Add the score of player.
*/
void addScore(uint player, const Score &score);
/**
* Clear all scores.
*/
void clear();
/**
* Show scores.
*/
void show(QWidget *parent);
private:
QValueVector<uint> _nbGames;
QValueVector<Score> _scores;
class MultiplayerScoresPrivate;
MultiplayerScoresPrivate *d;
friend QDataStream &operator <<(QDataStream &stream,
const MultiplayerScores &score);
friend QDataStream &operator >>(QDataStream &stream,
MultiplayerScores &score);
};
KDE_EXPORT QDataStream &operator <<(QDataStream &stream, const MultiplayerScores &score);
KDE_EXPORT QDataStream &operator >>(QDataStream &stream, MultiplayerScores &score);
} // namespace
#endif
|