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

Protected Member Functions
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 Attributes
QList< Akonadi::Item >	mRetrievedMsgs

Detailed Description

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

Definition at line 44 of file kmcommands.h.

Member Enumeration Documentation

enum KMCommand::Result

Enumerator
Undefined
OK
Canceled
Failed

Definition at line 49 of file kmcommands.h.

Constructor & Destructor Documentation

KMCommand::KMCommand ( QWidget *  parent = 0 )

explicit

Definition at line 179 of file kmcommands.cpp.

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

Definition at line 185 of file kmcommands.cpp.

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

Definition at line 194 of file kmcommands.cpp.

KMCommand::~KMCommand ( )

virtual

Definition at line 203 of file kmcommands.cpp.

Member Function Documentation

void KMCommand::completed ( KMCommand *  command )

signal

Emitted when the command has completed.

bool KMCommand::deletesItself ( ) const

inlineprotected

Definition at line 88 of file kmcommands.h.

bool KMCommand::emitsCompletedItself ( ) const

inlineprotected

Definition at line 97 of file kmcommands.h.

Akonadi::ItemFetchScope& KMCommand::fetchScope ( )

inlineprotected

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

Definition at line 79 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 227 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 207 of file kmcommands.cpp.

Akonadi::Item KMCommand::retrievedMessage ( ) const

protected

Definition at line 220 of file kmcommands.cpp.

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

protected

Definition at line 215 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 94 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 104 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 110 of file kmcommands.h.

void KMCommand::start ( )

slot

Definition at line 234 of file kmcommands.cpp.

Member Data Documentation

QList<Akonadi::Item> KMCommand::mRetrievedMsgs

protected

Definition at line 131 of file kmcommands.h.

---

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

• kmcommands.h
• kmcommands.cpp