KGameMouseIO Class Reference

#include <KGame/KGameIO>

Inheritance diagram for KGameMouseIO:

Signals
void	signalMouseEvent (KGameIO *io, QDataStream &stream, QMouseEvent *m, bool *eatevent)
Signals inherited from KGameIO
void	signalPrepareTurn (QDataStream &stream, bool turn, KGameIO *io, bool *send)

Public Member Functions
	KGameMouseIO (QWidget *parent, bool trackmouse=false)
	KGameMouseIO (QGraphicsScene *parent, bool trackmouse=false)
virtual	~KGameMouseIO ()
virtual int	rtti () const
void	setMouseTracking (bool b)
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)

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

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

Detailed Description

The KGameMouseIO class.

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

Author

Martin Heni <kde at heni-online.de>

Definition at line 271 of file kgameio.h.

Constructor & Destructor Documentation

KGameMouseIO::KGameMouseIO ( QWidget *  parent, bool  trackmouse = false  )

explicit

Creates a mouse IO device.

It captures all mouse event of the given widget and forwards them to the signal handler signalMouseEvent. Example:

KGameMouseIO *input;
input=new KGameMouseIO(mView);
connect(input,SIGNAL(signalMouseEvent(KGameIO *,QDataStream &,QMouseEvent *,bool *)),
       this,SLOT(slotMouseInput(KGameIO *,QDataStream &,QMouseEvent *,bool *)));

Parameters

parent	The widget whose events should be captured
trackmouse	enables mouse tracking (gives mouse move events)

Definition at line 203 of file kgameio.cpp.

KGameMouseIO::KGameMouseIO ( QGraphicsScene *  parent, bool  trackmouse = false  )

explicit

Definition at line 214 of file kgameio.cpp.

KGameMouseIO::~KGameMouseIO ( )

virtual

Definition at line 225 of file kgameio.cpp.

Member Function Documentation

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

protected

Internal event filter.

Definition at line 247 of file kgameio.cpp.

int KGameMouseIO::rtti ( ) const

virtual

The idendification of the IO.

Returns

MouseIO

Implements KGameIO.

Definition at line 234 of file kgameio.cpp.

void KGameMouseIO::setMouseTracking

(

bool

b

)

Manually activate or deactivate mouse tracking.

Parameters

b	true = tracking on

Definition at line 239 of file kgameio.cpp.

void KGameMouseIO::signalMouseEvent ( KGameIO *  io, QDataStream &  stream, QMouseEvent *  m, bool *  eatevent  )

signal

Signal handler for mouse events.

This function is called on every mouse 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.

See also

signalKeyEvent Example:

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

Parameters

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

---

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

• kgameio.h
• kgameio.cpp