libkdegames Library API Documentation

KGameMouseIO Class Reference

The KGameMouseIO class. More...

#include <kgameio.h>

Inheritance diagram for KGameMouseIO:

KGameIO QObject List of all members.

Signals

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

Public Member Functions

 KGameMouseIO (QWidget *parent, bool trackmouse=false)
void setMouseTracking (bool b)
virtual int rtti () const

Protected Member Functions

bool eventFilter (QObject *o, QEvent *e)

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 <martin@heni-online.de>

Definition at line 248 of file kgameio.h.


Constructor & Destructor Documentation

KGameMouseIO::KGameMouseIO QWidget parent,
bool  trackmouse = false
 

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 170 of file kgameio.cpp.

References KGameMouseIO().

Referenced by KGameMouseIO().


Member Function Documentation

void KGameMouseIO::setMouseTracking bool  b  ) 
 

Manually activate or deactivate mouse tracking.

Parameters:
b true = tracking on

Definition at line 194 of file kgameio.cpp.

References setMouseTracking().

Referenced by setMouseTracking().

int KGameMouseIO::rtti  )  const [virtual]
 

The idendification of the IO.

Returns:
MouseIO

Implements KGameIO.

Definition at line 189 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 Q_INT32 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

Referenced by eventFilter().

bool KGameMouseIO::eventFilter QObject o,
QEvent e
[protected]
 

Internal event filter.

Definition at line 202 of file kgameio.cpp.

References eventFilter(), KGameIO::player(), and signalMouseEvent().

Referenced by eventFilter().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkdegames Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Sep 21 12:08:03 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003