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 (QGraphicsScene *parent, bool trackmouse=false)
	KGameMouseIO (QWidget *parent, bool trackmouse=false)
int	rtti () const override
void	setMouseTracking (bool b)
Public Member Functions inherited from KGameIO
	KGameIO ()
	KGameIO (KPlayer *)
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)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
bool	eventFilter (QObject *o, QEvent *e) override
Protected Member Functions inherited from KGameIO
	KGameIO (KGameIOPrivate &dd, KPlayer *player=nullptr)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const 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 }
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList

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 276 of file kgameio.h.

Constructor & Destructor Documentation

KGameMouseIO() [1/2]

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

KGameMouseIO() [2/2]

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

explicit

Definition at line 190 of file kgameio.cpp.

~KGameMouseIO()

KGameMouseIO::~KGameMouseIO ( )

override

Definition at line 200 of file kgameio.cpp.

Member Function Documentation

eventFilter()

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

overrideprotectedvirtual

Internal event filter.

Reimplemented from QObject.

Definition at line 219 of file kgameio.cpp.

rtti()

int KGameMouseIO::rtti ( ) const

overridevirtual

The identification of the IO.

Returns

MouseIO

Implements KGameIO.

Definition at line 207 of file kgameio.cpp.

setMouseTracking()

void KGameMouseIO::setMouseTracking

(

bool

b

)

Manually activate or deactivate mouse tracking.

Parameters

b	true = tracking on

Definition at line 212 of file kgameio.cpp.

signalMouseEvent

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