kmail

KMCommand Class Reference

#include <kmcommands.h>

Inheritance diagram for KMCommand:

Detailed Description

Definition at line 47 of file kmcommands.h.


Public Types
enum	Result { Undefined, OK, Canceled, Failed }
Public Slots
void	slotProgress (unsigned long done, unsigned long total)
void	start ()
Signals
void	completed (KMCommand *command)
void	messagesTransfered (KMCommand::Result result)
Public Member Functions
void	keepFolderOpen (KMFolder *folder)
	KMCommand (QWidget parent, KMMessage message)
	KMCommand (QWidget parent, KMMsgBase msgBase)
	KMCommand (QWidget parent, const QList< KMMsgBase > &msgList)
	KMCommand (QWidget *parent=0)
Result	result () const
virtual	~KMCommand ()
Protected Member Functions
bool	deletesItself () const
bool	emitsCompletedItself () const
QWidget *	parentWidget () const
KMMessage *	retrievedMessage () const
const QList< KMMessage * >	retrievedMsgs () const
void	setDeletesItself (bool deletesItself)
void	setEmitsCompletedItself (bool emitsCompletedItself)
void	setResult (Result result)

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 )

Definition at line 164 of file kmcommands.cpp.

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

Definition at line 170 of file kmcommands.cpp.

KMCommand::KMCommand	(	QWidget *	parent,
		KMMsgBase *	msgBase
	)

Definition at line 176 of file kmcommands.cpp.

KMCommand::KMCommand	(	QWidget *	parent,
		KMMessage *	message
	)

Definition at line 183 of file kmcommands.cpp.

KMCommand::~KMCommand ( ) [virtual]

Definition at line 192 of file kmcommands.cpp.

Member Function Documentation

void KMCommand::completed ( KMCommand * command ) [signal]

Emitted when the command has completed.

Parameters:

result

The status of the command.

bool KMCommand::deletesItself ( ) const [inline, protected]

Definition at line 97 of file kmcommands.h.

bool KMCommand::emitsCompletedItself ( ) const [inline, protected]

Definition at line 106 of file kmcommands.h.

void KMCommand::keepFolderOpen ( KMFolder * folder )

These folders will be closed by the dtor, handy, if you need to keep a folder open during the lifetime of the command, but don't want to care about closing it again.

Definition at line 455 of file kmcommands.cpp.

void KMCommand::messagesTransfered ( KMCommand::Result result ) [signal]

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 203 of file kmcommands.cpp.

KMMessage * KMCommand::retrievedMessage ( ) const [protected]

Definition at line 222 of file kmcommands.cpp.

const QList< KMMessage * > KMCommand::retrievedMsgs ( ) const [protected]

Definition at line 217 of file kmcommands.cpp.

void KMCommand::setDeletesItself ( bool deletesItself ) [inline, protected]

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 103 of file kmcommands.h.

void KMCommand::setEmitsCompletedItself ( bool emitsCompletedItself ) [inline, protected]

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 113 of file kmcommands.h.

void KMCommand::setResult ( Result result ) [inline, protected]

Use this to set the result of the command.

Parameters:

result

The result of the command.

Definition at line 119 of file kmcommands.h.

void KMCommand::slotProgress	(	unsigned long	done,
		unsigned long	total
	)			`[slot]`

Definition at line 389 of file kmcommands.cpp.

void KMCommand::start ( ) [slot]

Definition at line 211 of file kmcommands.cpp.

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

kmail

KMCommand Class Reference

Detailed Description

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

kmail

kdepim