#include <KGame/KGameIO>

Inheritance diagram for KGameKeyIO:

Signals
void	signalKeyEvent (KGameIO io, QDataStream &stream, QKeyEvent m, bool *eatevent)

Signals inherited from KGameIO
void	signalPrepareTurn (QDataStream &stream, bool turn, KGameIO io, bool send)

Public Member Functions
	KGameKeyIO (QWidget *parent)

virtual	~KGameKeyIO ()

virtual int	rtti () const

Public Member Functions inherited from KGameIO
	KGameIO ()

	KGameIO (KPlayer *)

virtual	~KGameIO ()

void	Debug ()

KGame *	game () const

virtual void	initIO (KPlayer *p)

virtual void	notifyTurn (bool b)

KPlayer *	player () const

bool	sendInput (QDataStream &stream, bool transmit=true, quint32 sender=0)

void	setPlayer (KPlayer *p)

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)

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

Protected Member Functions
bool	eventFilter (QObject o, QEvent e)

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)

Additional Inherited Members
Public Types inherited from KGameIO
enum	IOMode { GenericIO =1, KeyIO =2, MouseIO =4, ProcessIO =8, ComputerIO =16 }

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)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

The KGameKeyIO class.

It is used to process keyboard input from a widget and create moves for the player it belongs to.

Author: Martin Heni <kde at heni-online.de>

Definition at line 192 of file kgameio.h.

Constructor & Destructor Documentation

KGameKeyIO::KGameKeyIO ( QWidget * parent )

Create a keyboard input devices.

All keyboards inputs of the given widgets are passed through a signal handler signalKeyEvent and can be used to generate a valid move for the player. Note the widget you pass to the constructor must be the main window of your application, e.g. view->parentWidget() as QT does not forward your keyevents otherwise. This means that this might be a different widget comapred to the one you use for mouse inputs! Example:

KGameKeyIO *input;
 input=new KGameKeyIO(myWidget);
 connect(input,SIGNAL(signalKeyEvent(KGameIO *,QDataStream &,QKeyEvent *,bool *)),
         this,SLOT(slotKeyInput(KGameIO *,QDataStream &,QKeyEvent *,bool *)));

Parameters

parent The parents widget whose keyboard events * should be grabbed

Definition at line 148 of file kgameio.cpp.

KGameKeyIO::~KGameKeyIO ( )

virtual

Definition at line 158 of file kgameio.cpp.

Member Function Documentation

bool KGameKeyIO::eventFilter	(	QObject *	o,
		QEvent *	e
	)

protectedvirtual

Internal method to process the events.

Reimplemented from QObject.

Definition at line 169 of file kgameio.cpp.

int KGameKeyIO::rtti ( ) const

virtual

The idendification of the IO.

Returns: KeyIO

Implements KGameIO.

Definition at line 167 of file kgameio.cpp.

void KGameKeyIO::signalKeyEvent	(	KGameIO *	io,
		QDataStream &	stream,
		QKeyEvent *	m,
		bool *	eatevent
	)

signal

Signal handler for keyboard events.

This function is called on every keyboard event. If appropriate it can generate a move for the player the device belongs to. If this is done and the event is eaten eatevent needs to be set to true. What move you generate (i.e. what you write to the stream) is totally up to you as it will not be evaluated but forwared to the player's/game's input move function Example:

KPlayer *player=input->player(); // Get the player
qint32 key=e->key();
stream << key;
eatevent=true;

Parameters

io	the IO device we belong to
stream	the stream where we write our move into
m	The QKeyEvent we can evaluate
eatevent	set this to true if we processed the event

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

libkdegames/libkdegamesprivate/kgame

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

libkdegames/libkdegamesprivate/kgame

kdegames API Reference

Search