kmail
KMCommand Class Reference
Inheritance diagram for KMCommand:

Detailed Description
Definition at line 38 of file kmcommands.h.
Public Types | |
enum | Result { Undefined, OK, Canceled, Failed } |
Public Slots | |
void | start () |
void | slotProgress (unsigned long done, unsigned long total) |
Signals | |
void | messagesTransfered (KMCommand::Result result) |
void | completed (KMCommand *command) |
Public Member Functions | |
KMCommand (QWidget *parent=0) | |
KMCommand (QWidget *parent, const QPtrList< KMMsgBase > &msgList) | |
KMCommand (QWidget *parent, KMMsgBase *msgBase) | |
KMCommand (QWidget *parent, KMMessage *message) | |
virtual | ~KMCommand () |
void | keepFolderOpen (KMFolder *folder) |
Result | result () |
Protected Member Functions | |
const QPtrList< KMMessage > | retrievedMsgs () const |
KMMessage * | retrievedMessage () const |
QWidget * | parentWidget () const |
bool | deletesItself () |
void | setDeletesItself (bool deletesItself) |
bool | emitsCompletedItself () |
void | setEmitsCompletedItself (bool emitsCompletedItself) |
void | setResult (Result result) |
Friends | |
class | LaterDeleterWithCommandCompletion |
Member Function Documentation
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 441 of file kmcommands.cpp.
KMCommand::Result KMCommand::result | ( | ) |
Returns the result of the command.
Only call this method from the slot connected to completed().
Definition at line 189 of file kmcommands.cpp.
void KMCommand::completed | ( | KMCommand * | command | ) | [signal] |
Emitted when the command has completed.
- Parameters:
-
result The status of the command.
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 94 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 104 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 110 of file kmcommands.h.
The documentation for this class was generated from the following files: