libkdegames Library API Documentation

KExtHighscore Namespace Reference


Classes

class  Manager
 This class manages highscores and players entries (several players can share the same highscores list if the libkdegame library is built to support a common highscores file; NOTE that to correctly implement such feature we probably need a locking mechanism in KHighscore). More...
class  ShowItem
class  ScoresList
class  HighscoresList
class  HighscoresWidget
class  HighscoresDialog
class  LastMultipleScoresList
class  TotalMultipleScoresList
class  ConfigDialog
class  AskNameDialog
class  RankItem
class  NameItem
class  DateItem
class  SuccessPercentageItem
class  ItemContainer
class  ItemArray
 Manage a bunch of Item which are saved under the same group in KHighscores config file. More...
class  ScoreInfos
class  ConfigGroup
class  PlayerInfos
class  ManagerPrivate
class  Item
 This class defines how to convert and how to display a highscore element (such as the score, the date, . More...
class  Score
 This class contains data for a score. More...
class  MultiplayerScores
 This class is used to store and show scores for multiplayer games. More...
class  PlayersCombo
class  AdditionalTab
class  StatisticsTab
class  HistogramTab

Enumerations

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

Functions

uint gameType ()
void setGameType (uint gameType)
bool configure (QWidget *parent)
void show (QWidget *parent, int rank)
void submitScore (const Score &score, QWidget *widget)
void show (QWidget *parent)
Score lastScore ()
Score firstScore ()
QDataStreamoperator<< (QDataStream &s, const Score &score)
QDataStreamoperator>> (QDataStream &s, Score &score)
QDataStreamoperator<< (QDataStream &s, const MultiplayerScores &score)
QDataStreamoperator>> (QDataStream &s, MultiplayerScores &score)

Variables

ManagerPrivateinternal = 0
const char * HS_ID = "player id"
const char * HS_REGISTERED_NAME = "registered name"
const char * HS_KEY = "player key"
const char * HS_WW_ENABLED = "ww hs enabled"
const char * DUMMY_STRINGS []
const char * UNABLE_TO_CONTACT


Enumeration Type Documentation

enum KExtHighscore::ScoreType
 

Possible score type.

Won the game has been won. Lost the game has been lost or has been aborted. Draw the game is a draw.

Definition at line 169 of file kexthighscore_item.h.


Function Documentation

KDE_EXPORT uint KExtHighscore::gameType  ) 
 

Get the current game type.

Definition at line 38 of file kexthighscore.cpp.

References KExtHighscore::ManagerPrivate::checkFirst(), KExtHighscore::ManagerPrivate::gameType(), and internal.

KDE_EXPORT void KExtHighscore::setGameType uint  type  ) 
 

Set the current game type.

Definition at line 44 of file kexthighscore.cpp.

References internal, and KExtHighscore::ManagerPrivate::setGameType().

KDE_EXPORT bool KExtHighscore::configure QWidget parent  ) 
 

Configure the highscores.

Returns:
true if the configuration has been modified and saved

Definition at line 49 of file kexthighscore.cpp.

References KExtHighscore::ManagerPrivate::checkFirst(), KExtHighscore::ConfigDialog::hasBeenSaved(), and internal.

KDE_EXPORT void KExtHighscore::submitScore const Score &  score,
QWidget widget
 

Submit a score.

See Manager for usage example.

Parameters:
widget a widget used as parent for error message box.

Definition at line 66 of file kexthighscore.cpp.

References internal, show(), KExtHighscore::ManagerPrivate::showMode, and KExtHighscore::ManagerPrivate::submitScore().

KDE_EXPORT void KExtHighscore::show QWidget widget  ) 
 

Show the highscores lists.

Definition at line 86 of file kexthighscore.cpp.

References KExtHighscore::ManagerPrivate::checkFirst(), internal, and show().

KDE_EXPORT Score KExtHighscore::lastScore  ) 
 

Returns:
the last score in the local list of highscores. The worst possible score if there are less items than the maximum number.

Definition at line 92 of file kexthighscore.cpp.

References KExtHighscore::ManagerPrivate::checkFirst(), KExtHighscore::ManagerPrivate::hsConfig(), internal, KExtHighscore::ScoreInfos::maxNbEntries(), KHighscore::readCurrentConfig(), KExtHighscore::ManagerPrivate::readScore(), and KExtHighscore::ManagerPrivate::scoreInfos().

KDE_EXPORT Score KExtHighscore::firstScore  ) 
 

Returns:
the first score in the local list of highscores (the worst possible score if there is no entry).

Definition at line 100 of file kexthighscore.cpp.

References KExtHighscore::ManagerPrivate::checkFirst(), KExtHighscore::ManagerPrivate::hsConfig(), internal, KHighscore::readCurrentConfig(), and KExtHighscore::ManagerPrivate::readScore().


Variable Documentation

const char* KExtHighscore::DUMMY_STRINGS[]
 

Initial value:

 {
    I18N_NOOP("Undefined error."),
    I18N_NOOP("Missing argument(s)."),
    I18N_NOOP("Invalid argument(s)."),

    I18N_NOOP("Unable to connect to MySQL server."),
    I18N_NOOP("Unable to select database."),
    I18N_NOOP("Error on database query."),
    I18N_NOOP("Error on database insert."),

    I18N_NOOP("Nickname already registered."),
    I18N_NOOP("Nickname not registered."),
    I18N_NOOP("Invalid key."),
    I18N_NOOP("Invalid submit key."),

    I18N_NOOP("Invalid level."),

}

Definition at line 583 of file kexthighscore_internal.cpp.

const char* KExtHighscore::UNABLE_TO_CONTACT
 

Initial value:

    I18N_NOOP("Unable to contact world-wide highscore server")

Definition at line 602 of file kexthighscore_internal.cpp.

KDE Logo
This file is part of the documentation for libkdegames Library Version 3.4.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Oct 9 09:38:31 2005 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003