Kopete::MessageEvent Class Reference

#include <kopetemessageevent.h>

Inheritance diagram for Kopete::MessageEvent:

Public Types
enum	EventState { Nothing, Applied, Ignored }

Public Slots
void	accept ()
void	apply ()
void	discard ()
void	ignore ()

Signals
void	accepted (Kopete::MessageEvent *event)
void	discarded (Kopete::MessageEvent *event)
void	done (Kopete::MessageEvent *)

Public Member Functions
	MessageEvent (const Kopete::Message &, QObject *parent=0L)
	~MessageEvent ()
Kopete::Message	message ()
void	setMessage (const Kopete::Message &message)
EventState	state ()
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

Olivier Goffart ogoff.nosp@m.art@.nosp@m.kde.o.nosp@m.rg

Richard Smith richa.nosp@m.rd@m.nosp@m.etafo.nosp@m.o.co.nosp@m..uk

Kopete::MessageEvent is used when a new messages arrives, it is caught by the UI. It contains just information about the message, and a signal when it is terminated (i.e. the message is read

Definition at line 41 of file kopetemessageevent.h.

Member Enumeration Documentation

enum Kopete::MessageEvent::EventState

The state of the event.

• Nothing means that the event has not been accepted or ignored
• Applied if the event has been applied
• Ignored if the event has been ignored

Enumerator
Nothing
Applied
Ignored

Definition at line 66 of file kopetemessageevent.h.

Constructor & Destructor Documentation

Kopete::MessageEvent::MessageEvent ( const Kopete::Message &  m, QObject *  parent = 0L  )

explicit

Definition at line 41 of file kopetemessageevent.cpp.

Kopete::MessageEvent::~MessageEvent

(

)

Definition at line 51 of file kopetemessageevent.cpp.

Member Function Documentation

void Kopete::MessageEvent::accept ( )

slot

Passes the event to the next handler.

Call this when you've finished processing this event

Definition at line 89 of file kopetemessageevent.cpp.

void Kopete::MessageEvent::accepted ( Kopete::MessageEvent *  event )

signal

The event has been accepted by its current handler.

Parameters

event

The event sending the signal.

void Kopete::MessageEvent::apply ( )

slot

Deprecated:

Use accept() instead to continue the processing of this event once the caller has moved to using MessageHandlers

execute the event

Definition at line 73 of file kopetemessageevent.cpp.

void Kopete::MessageEvent::discard ( )

slot

Discards the event.

If this event should not be processed any further, this function should be called to discard it.

Definition at line 94 of file kopetemessageevent.cpp.

void Kopete::MessageEvent::discarded ( Kopete::MessageEvent *  event )

signal

The event has been discarded.

Parameters

event

The event sending the signal.

void Kopete::MessageEvent::done ( Kopete::MessageEvent *  )

signal

The event has been processed.

void Kopete::MessageEvent::ignore ( )

slot

Deprecated:

Use discard() instead to destroy this event once the caller has moved to using MessageHandlers

ignore the event

Definition at line 79 of file kopetemessageevent.cpp.

Kopete::Message Kopete::MessageEvent::message

(

)

Returns

A copy of the message

Definition at line 58 of file kopetemessageevent.cpp.

void Kopete::MessageEvent::setMessage

(

const Kopete::Message &

message

)

Sets the message contained in this event.

Parameters

message

The new value for the message

Definition at line 63 of file kopetemessageevent.cpp.

MessageEvent::EventState Kopete::MessageEvent::state

(

)

Definition at line 68 of file kopetemessageevent.cpp.

---

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

• kopetemessageevent.h
• kopetemessageevent.cpp