Kopete::MessageHandler Class Reference

#include <kopetemessagehandler.h>

Inheritance diagram for Kopete::MessageHandler:

Public Member Functions
	MessageHandler ()
virtual	~MessageHandler ()=0
virtual int	capabilities ()
virtual void	handleMessage (MessageEvent *event)
void	handleMessageInternal (MessageEvent *event)
MessageHandler *	next ()
void	setNext (MessageHandler *next)
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)
virtual bool	eventFilter (QObject *watched, QEvent *event)
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

Additional Inherited Members
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)
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)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Author

Richard Smith kde@m.nosp@m.etaf.nosp@m.oo.co.nosp@m..uk

An object which sits between the protocol and the chat window which intercepts and processes messages on their way through.

This class implements Handler role in the Chain of Responsibility pattern. The Client role will be filled by the Kopete::MessageHandlerChain class.

Definition at line 44 of file kopetemessagehandler.h.

Constructor & Destructor Documentation

Kopete::MessageHandler::MessageHandler

(

)

Definition at line 32 of file kopetemessagehandler.cpp.

Kopete::MessageHandler::~MessageHandler ( )

pure virtual

Definition at line 37 of file kopetemessagehandler.cpp.

Member Function Documentation

int Kopete::MessageHandler::capabilities ( )

virtual

Gets the rich-text capabilities of this message handling object.

The default implementation returns next()->capabilities().

Definition at line 52 of file kopetemessagehandler.cpp.

void Kopete::MessageHandler::handleMessage ( MessageEvent *  event )

virtual

Performs any processing necessary on the message.

Parameters

event

The message event to process. Should not be null.

Overriders of this handler must cause (possibly asynchronously) one of the following to happen:

• event->discard() to be called
• event->continue() to be called
• this base class implementation to be called (equivalent to event->continue() but faster)

The base class implementation passes the event on to the next handler in the chain.

Note

If you store event, be aware that it could be deleted at any time, and either connect to the discarded(Kopete::MessageEvent*) signal or store it in a QPointer.

Reimplemented in Kopete::SimpleMessageHandler.

Definition at line 63 of file kopetemessagehandler.cpp.

void Kopete::MessageHandler::handleMessageInternal

(

MessageEvent *

event

)

Definition at line 57 of file kopetemessagehandler.cpp.

MessageHandler * Kopete::MessageHandler::next

(

)

Returns

the next handler in the chain

Definition at line 42 of file kopetemessagehandler.cpp.

void Kopete::MessageHandler::setNext

(

MessageHandler *

next

)

Definition at line 47 of file kopetemessagehandler.cpp.

---

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

• kopetemessagehandler.h
• kopetemessagehandler.cpp