diff options
Diffstat (limited to 'libkdegames/kgame/kgameerror.h')
-rw-r--r-- | libkdegames/kgame/kgameerror.h | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/libkdegames/kgame/kgameerror.h b/libkdegames/kgame/kgameerror.h new file mode 100644 index 00000000..2916e891 --- /dev/null +++ b/libkdegames/kgame/kgameerror.h @@ -0,0 +1,59 @@ +/* + This file is part of the KDE games library + Copyright (C) 2001 Andreas Beckermann ([email protected]) + Copyright (C) 2001 Martin Heni ([email protected]) + + 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. +*/ +/* + $Id$ +*/ +#ifndef __KGAMEERROR_H_ +#define __KGAMEERROR_H_ + +#include <qstring.h> + + +class KGameError +{ +public: + KGameError() { } + ~KGameError() { } + + enum ErrorCodes { + Cookie = 0, // Cookie mismatch + Version = 1 // Version mismatch + }; + + /** + * Generate an error message with Erorr Code = ErrCookie + **/ + static QByteArray errCookie(int localCookie, int remoteCookie); + static QByteArray errVersion(int remoteVersion); + + /** + * Create an erorr text using a QDataStream (QByteArray) which was + * created using @ref KGameError. This is the opposite function to all + * the errXYZ() function (e.g. @ref errVersion). + * You want to use this to generate the message that shall be + * displayed to the user. + * @return an error message + **/ + static QString errorText(int errorCode, QDataStream& message); + static QString errorText(int errorCode, const QByteArray& message); + +}; + +#endif |