kmail
KMail::ActionScheduler Class Reference
List of all members.Detailed Description
Definition at line 49 of file actionscheduler.h.
Public Types | |
enum | ReturnCode { ResultOk, ResultError, ResultCriticalError } |
Public Slots | |
void | actionMessage (KMFilterAction::ReturnCode=KMFilterAction::GoOn) |
void | copyMessageFinished (KMCommand *command) |
Signals | |
void | result (ReturnCode) |
void | filtered (Q_UINT32) |
Public Member Functions | |
ActionScheduler (KMFilterMgr::FilterSet set, QValueList< KMFilter * > filters, KMHeaders *headers=0, KMFolder *srcFolder=0) | |
~ActionScheduler () | |
void | setAutoDestruct (bool) |
void | setAlwaysMatch (bool) |
void | setDefaultDestinationFolder (KMFolder *) |
void | setSourceFolder (KMFolder *) |
void | setFilterList (QValueList< KMFilter * > filters) |
void | setAccountId (uint id) |
void | clearAccountId () |
void | execFilters (const QValueList< Q_UINT32 > serNums) |
void | execFilters (const QPtrList< KMMsgBase > msgList) |
void | execFilters (KMMsgBase *msgBase) |
void | execFilters (Q_UINT32 serNum) |
bool | ignoreChanges (bool ignore) |
Static Public Member Functions | |
static QString | debug () |
static bool | isEnabled () |
Member Function Documentation
void ActionScheduler::setAutoDestruct | ( | bool | ) |
The action scheduler will be deleted after the finish signal is emitted if this property is set to true.
Definition at line 137 of file actionscheduler.cpp.
void ActionScheduler::setAlwaysMatch | ( | bool | ) |
void ActionScheduler::setDefaultDestinationFolder | ( | KMFolder * | ) |
void ActionScheduler::setSourceFolder | ( | KMFolder * | ) |
Set a folder to monitor for new messages to filter.
Definition at line 152 of file actionscheduler.cpp.
void ActionScheduler::setFilterList | ( | QValueList< KMFilter * > | filters | ) |
Set a list of filters to work with The current list will not be updated until the queue of messages left to process is empty.
Definition at line 169 of file actionscheduler.cpp.
void KMail::ActionScheduler::setAccountId | ( | uint | id | ) | [inline] |
Set the id of the account associated with this scheduler.
Definition at line 81 of file actionscheduler.h.
void KMail::ActionScheduler::clearAccountId | ( | ) | [inline] |
Clear the id of the account associated with this scheduler.
Definition at line 84 of file actionscheduler.h.
void ActionScheduler::execFilters | ( | const QValueList< Q_UINT32 > | serNums | ) |
bool ActionScheduler::ignoreChanges | ( | bool | ignore | ) |
Allow or deny manipulations on the message to be filtered.
This is needed when using pipe-through filters, because the changes made by the filter have to be written back. The old value before applying the new value is returned.
Definition at line 807 of file actionscheduler.cpp.
void KMail::ActionScheduler::result | ( | ReturnCode | ) | [signal] |
Emitted when filtering is completed.
void ActionScheduler::actionMessage | ( | KMFilterAction::ReturnCode | = KMFilterAction::GoOn |
) | [slot] |
Called back by asynchronous actions when they have completed.
Definition at line 595 of file actionscheduler.cpp.
void ActionScheduler::copyMessageFinished | ( | KMCommand * | command | ) | [slot] |
Called back by asynchronous copy actions when they have completed.
Definition at line 726 of file actionscheduler.cpp.
The documentation for this class was generated from the following files: