KMCommand Class Reference

#include <kmcommands.h>

Inheritance diagram for KMCommand:

Public Types
enum	Result { Undefined, OK, Canceled, Failed }

Public Slots
void	start ()

Signals
void	completed (KMCommand *command)
void	messagesTransfered (KMCommand::Result result)

Public Member Functions
	KMCommand (QWidget *parent=0)
	KMCommand (QWidget *parent, const Akonadi::Item &)
	KMCommand (QWidget *parent, const QList< Akonadi::Item > &msgList)
virtual	~KMCommand ()
Result	result () const
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

Protected Member Functions
virtual Akonadi::ItemFetchJob *	createFetchJob (const Akonadi::Item::List &items)
bool	deletesItself () const
bool	emitsCompletedItself () const
Akonadi::ItemFetchScope &	fetchScope ()
QWidget *	parentWidget () const
Akonadi::Item	retrievedMessage () const
const QList< Akonadi::Item >	retrievedMsgs () const
void	setDeletesItself (bool deletesItself)
void	setEmitsCompletedItself (bool emitsCompletedItself)
void	setResult (Result result)
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)

Protected Attributes
QList< Akonadi::Item >	mRetrievedMsgs

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

Detailed Description

Small helper structure which encapsulates the KMMessage created when creating a reply, and.

Definition at line 48 of file kmcommands.h.

Member Enumeration Documentation

enum KMCommand::Result

Enumerator
Undefined
OK
Canceled
Failed

Definition at line 53 of file kmcommands.h.

Constructor & Destructor Documentation

KMCommand::KMCommand ( QWidget *  parent = 0 )

explicit

Definition at line 178 of file kmcommands.cpp.

KMCommand::KMCommand	(	QWidget *	parent,
		const Akonadi::Item &	msg
	)

Definition at line 184 of file kmcommands.cpp.

KMCommand::KMCommand	(	QWidget *	parent,
		const QList< Akonadi::Item > &	msgList
	)

Definition at line 193 of file kmcommands.cpp.

KMCommand::~KMCommand ( )

virtual

Definition at line 202 of file kmcommands.cpp.

Member Function Documentation

void KMCommand::completed ( KMCommand *  command )

signal

Emitted when the command has completed.

Akonadi::ItemFetchJob * KMCommand::createFetchJob ( const Akonadi::Item::List &  items )

protectedvirtual

Definition at line 277 of file kmcommands.cpp.

bool KMCommand::deletesItself ( ) const

inlineprotected

Definition at line 94 of file kmcommands.h.

bool KMCommand::emitsCompletedItself ( ) const

inlineprotected

Definition at line 103 of file kmcommands.h.

Akonadi::ItemFetchScope& KMCommand::fetchScope ( )

inlineprotected

Allows to configure how much data should be retrieved of the messages.

Definition at line 85 of file kmcommands.h.

void KMCommand::messagesTransfered ( KMCommand::Result  result )

signal

Parameters

result

The status of the command.

QWidget * KMCommand::parentWidget ( ) const

protected

Definition at line 226 of file kmcommands.cpp.

KMCommand::Result KMCommand::result

(

)

const

Returns the result of the command.

Only call this method from the slot connected to completed().

Definition at line 206 of file kmcommands.cpp.

Akonadi::Item KMCommand::retrievedMessage ( ) const

protected

Definition at line 219 of file kmcommands.cpp.

const QList< Akonadi::Item > KMCommand::retrievedMsgs ( ) const

protected

Definition at line 214 of file kmcommands.cpp.

void KMCommand::setDeletesItself ( bool  deletesItself )

inlineprotected

Specify whether the subclass takes care of the deletion of the object.

By default the base class will delete the object.

Parameters

deletesItself

true if the subclass takes care of deletion, false if the base class should take care of deletion

Definition at line 100 of file kmcommands.h.

void KMCommand::setEmitsCompletedItself ( bool  emitsCompletedItself )

inlineprotected

Specify whether the subclass takes care of emitting the completed() signal.

By default the base class will emit this signal.

Parameters

emitsCompletedItself

true if the subclass emits the completed signal, false if the base class should emit the signal

Definition at line 110 of file kmcommands.h.

void KMCommand::setResult ( Result  result )

inlineprotected

Use this to set the result of the command.

Parameters

result

The result of the command.

Definition at line 116 of file kmcommands.h.

void KMCommand::start ( )

slot

Definition at line 233 of file kmcommands.cpp.

Member Data Documentation

QList<Akonadi::Item> KMCommand::mRetrievedMsgs

protected

Definition at line 137 of file kmcommands.h.

---

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

• kmcommands.h
• kmcommands.cpp