KGrGameIO Class Reference

#include <kgrgameio.h>

Inheritance diagram for KGrGameIO:

Public Member Functions
	KGrGameIO (QWidget *pView)
IOStatus	fetchGameListData (const Owner o, const QString &dir, QList< KGrGameData * > &gameList, QString &filePath)
IOStatus	fetchLevelData (const QString &dir, const QString &prefix, const int level, KGrLevelData &d, QString &filePath)
bool	readLevelData (const QString &dir, const QString &prefix, const int levelNo, KGrLevelData &d)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static bool	safeRename (QWidget *theView, const QString &oldName, const QString &newName)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

The KGrGameIO class handles I/O for text-files containing KGoldrunner games and levels.

The games and levels that are released with KGoldrunner are installed in a "System" directory (e.g. .../share/apps/kgoldrunner/system). Those that the user composes or edits are stored in a "User" directory (e.g. $HOME/.kde/share/apps/kgoldrunner/user).

The class handles files in either KGoldrunner 2 format or KGoldrunner 3 format. In KGoldrunner 2 format, the data for games is in file "games.dat" and the data for levels is in multiple files "levels/<prefix><nnn>.grl". Each level-file has at least one line containing codes for the level's layout and can have optional extra lines containing a level name and a hint. In KGoldrunner 3 format, each game is in one file called "game_<prefix>.txt", containing the game-data and the data for all levels. The data formats are the same as for KGoldrunner 2, except that the first character of each line indicates what kind of data is in the rest of the line. "G" = game data, "L" = start of level data, with the level-number following the "L", and " " = level data, with line 1 being the layout codes, line 2 (optional) the level name and lines >2 (optional) the hint.

This class is used by the game and its editor and is also used by a utility program that finds game names, level names and hints and rewrites them in a format suitable for extracting strings that KDE translators can use.

KGoldrunner Game-File IO

Definition at line 58 of file kgrgameio.h.

Constructor & Destructor Documentation

KGrGameIO::KGrGameIO

(

QWidget *

pView

)

Default constructor.

Parameters

pView

The view or widget used as a parent for error messages.

Definition at line 27 of file kgrgameio.cpp.

Member Function Documentation

IOStatus KGrGameIO::fetchGameListData	(	const Owner	o,
		const QString &	dir,
		QList< KGrGameData * > &	gameList,
		QString &	filePath
	)

Find and read data for games, into a list of KGrGameData structures.

Definition at line 34 of file kgrgameio.cpp.

IOStatus KGrGameIO::fetchLevelData	(	const QString &	dir,
		const QString &	prefix,
		const int	level,
		KGrLevelData &	d,
		QString &	filePath
	)

Find and read data for a level of a game, into a KGrLevelData structure.

Returns an OK or error status, but does not display error messages.

Definition at line 182 of file kgrgameio.cpp.

bool KGrGameIO::readLevelData	(	const QString &	dir,
		const QString &	prefix,
		const int	levelNo,
		KGrLevelData &	d
	)

Find and read data for a level of a game.

Can display error messages.

Definition at line 151 of file kgrgameio.cpp.

bool KGrGameIO::safeRename ( QWidget *  theView, const QString &  oldName, const QString &  newName  )

static

Definition at line 356 of file kgrgameio.cpp.

---

The documentation for this class was generated from the following files:

• kgrgameio.h
• kgrgameio.cpp