libkdegames/kgame

KGameDebugDialog Class Reference

#include <KGameDebugDialog>

Inheritance diagram for KGameDebugDialog:

Detailed Description

Definition at line 37 of file kgamedebugdialog.h.


Public Slots
void	slotClearMessages ()
void	slotUnsetKGame ()
void	slotUpdateGameData ()
void	slotUpdatePlayerData ()
void	slotUpdatePlayerList ()
Signals
void	signalRequestIdName (int messageid, bool userid, QString &name)
Public Member Functions
	KGameDebugDialog (KGame g, QWidget parent, bool modal=false)
void	setKGame (const KGame *g)
	~KGameDebugDialog ()
Protected Slots
void	slotHideId ()
void	slotMessageUpdate (int msgid, quint32 receiver, quint32 sender)
void	slotShowId ()
void	slotUpdatePlayerData (QListWidgetItem *item)
Protected Member Functions
void	addPlayer (KPlayer *p)
void	clearGameData ()
void	clearPages ()
void	clearPlayerData ()
void	removePlayer (QListWidgetItem *item)
bool	showId (int msgid)

Constructor & Destructor Documentation

KGameDebugDialog::KGameDebugDialog	(	KGame *	g,
		QWidget *	parent,
		bool	modal = `false`
	)

Definition at line 126 of file kgamedebugdialog.cpp.

KGameDebugDialog::~KGameDebugDialog ( )

Definition at line 144 of file kgamedebugdialog.cpp.

Member Function Documentation

void KGameDebugDialog::addPlayer ( KPlayer * p ) [protected]

Add a new player to the player list.

Definition at line 484 of file kgamedebugdialog.cpp.

void KGameDebugDialog::clearGameData ( ) [protected]

Clear the data view of the KGame object.

Definition at line 298 of file kgamedebugdialog.cpp.

void KGameDebugDialog::clearPages ( ) [protected]

Definition at line 447 of file kgamedebugdialog.cpp.

void KGameDebugDialog::clearPlayerData ( ) [protected]

Clear the data of the player view.

Note that the player list is NOT cleared.

Definition at line 280 of file kgamedebugdialog.cpp.

void KGameDebugDialog::removePlayer ( QListWidgetItem * item ) [protected]

Remove a player from the list.

Definition at line 495 of file kgamedebugdialog.cpp.

void KGameDebugDialog::setKGame ( const KGame * g )

Automatically connects the KGame object to all error dependant slots.

Create a KGameErrorDialog object, call this function and forget everything.

Parameters:

The KGame which will emit the erorrs (or not ;-) )

Definition at line 455 of file kgamedebugdialog.cpp.

bool KGameDebugDialog::showId ( int msgid ) [protected]

Returns:: Whether messages with this msgid shall be displayed or not

Definition at line 565 of file kgamedebugdialog.cpp.

void KGameDebugDialog::signalRequestIdName	(	int	messageid,
		bool	userid,
		QString &	name
	)			`[signal]`

This signal is emitted when the "debug messages" page couldn't find the name of a message id.

This is usually the case for user-defined messages. KGameDebugDialog asks you to give the msgid a name.

Parameters:

	messageid	The ID of the message. As given to KGame::sendMessage
	userid	User defined msgIds are internally increased by KGameMessage::IdUser. You don't have to care about this but if this signal is emitted with userid=false (shouldn't happen) then the name of an internal message as defined in KGameMessage::GameMessageIds couldn't be found.
	name	The name of the msgid. You have to fill this!

void KGameDebugDialog::slotClearMessages ( ) [slot]

Definition at line 534 of file kgamedebugdialog.cpp.

void KGameDebugDialog::slotHideId ( ) [protected, slot]

Definition at line 553 of file kgamedebugdialog.cpp.

void KGameDebugDialog::slotMessageUpdate	(	int	msgid,
		quint32	receiver,
		quint32	sender
	)			`[protected, slot]`

A message has been received - see KGame::signalMessageUpdate.

Definition at line 511 of file kgamedebugdialog.cpp.

void KGameDebugDialog::slotShowId ( ) [protected, slot]

Definition at line 539 of file kgamedebugdialog.cpp.

void KGameDebugDialog::slotUnsetKGame ( ) [slot]

Unsets a KGame which has been set using setKGame before.

This is called automatically when the KGame object is destroyed and you normally don't have to call this yourself.

Note that setKGame also unsets an already existing KGame object if exising.

Definition at line 475 of file kgamedebugdialog.cpp.

void KGameDebugDialog::slotUpdateGameData ( ) [slot]

Update the data of the KGame object.

Definition at line 335 of file kgamedebugdialog.cpp.

void KGameDebugDialog::slotUpdatePlayerData ( QListWidgetItem * item ) [protected, slot]

Update the data of the player specified in item.

Parameters:

item

The QListWidgetItem of the player to be updated. Note that the text of this item MUST be the ID of the player

Definition at line 387 of file kgamedebugdialog.cpp.

void KGameDebugDialog::slotUpdatePlayerData ( ) [slot]

Update the properties of the currently selected player.

Definition at line 314 of file kgamedebugdialog.cpp.

void KGameDebugDialog::slotUpdatePlayerList ( ) [slot]

Updates the list of players and calls clearPlayerData.

Note that after this call NO player is selected anymore.

Definition at line 322 of file kgamedebugdialog.cpp.

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

libkdegames/kgame

KGameDebugDialog Class Reference

Detailed Description

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation

libkdegames/kgame

API Reference