kmail
KMail::ActionScheduler Class Reference
#include <actionscheduler.h>
Public Types | |
| enum | ReturnCode { ResultOk, ResultError, ResultCriticalError } |
Public Slots | |
| void | actionMessage (KMFilterAction::ReturnCode=KMFilterAction::GoOn) |
| void | copyMessageFinished (KMCommand *command) |
Signals | |
| void | filtered (Q_UINT32) |
| void | result (ReturnCode) |
Public Member Functions | |
| ActionScheduler (KMFilterMgr::FilterSet set, QValueList< KMFilter * > filters, KMHeaders *headers=0, KMFolder *srcFolder=0) | |
| void | clearAccountId () |
| void | execFilters (Q_UINT32 serNum) |
| void | execFilters (KMMsgBase *msgBase) |
| void | execFilters (const QPtrList< KMMsgBase > msgList) |
| void | execFilters (const QValueList< Q_UINT32 > serNums) |
| bool | ignoreChanges (bool ignore) |
| void | setAccountId (uint id) |
| void | setAlwaysMatch (bool) |
| void | setAutoDestruct (bool) |
| void | setDefaultDestinationFolder (KMFolder *) |
| void | setFilterList (QValueList< KMFilter * > filters) |
| void | setSourceFolder (KMFolder *) |
| ~ActionScheduler () | |
Static Public Member Functions | |
| static QString | debug () |
| static bool | isEnabled () |
Detailed Description
Definition at line 49 of file actionscheduler.h.
Member Enumeration Documentation
Definition at line 54 of file actionscheduler.h.
Constructor & Destructor Documentation
| ActionScheduler::ActionScheduler | ( | KMFilterMgr::FilterSet | set, | |
| QValueList< KMFilter * > | filters, | |||
| KMHeaders * | headers = 0, |
|||
| KMFolder * | srcFolder = 0 | |||
| ) |
Definition at line 64 of file actionscheduler.cpp.
| ActionScheduler::~ActionScheduler | ( | ) |
Definition at line 121 of file actionscheduler.cpp.
Member Function Documentation
| void ActionScheduler::actionMessage | ( | KMFilterAction::ReturnCode | res = KMFilterAction::GoOn |
) | [slot] |
Called back by asynchronous actions when they have completed.
Definition at line 617 of file actionscheduler.cpp.
| 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::copyMessageFinished | ( | KMCommand * | command | ) | [slot] |
Called back by asynchronous copy actions when they have completed.
Definition at line 748 of file actionscheduler.cpp.
| QString ActionScheduler::debug | ( | ) | [static] |
Definition at line 783 of file actionscheduler.cpp.
| void ActionScheduler::execFilters | ( | Q_UINT32 | serNum | ) |
Definition at line 253 of file actionscheduler.cpp.
| void ActionScheduler::execFilters | ( | KMMsgBase * | msgBase | ) |
Definition at line 248 of file actionscheduler.cpp.
Definition at line 240 of file actionscheduler.cpp.
| void ActionScheduler::execFilters | ( | const QValueList< Q_UINT32 > | serNums | ) |
| void KMail::ActionScheduler::filtered | ( | Q_UINT32 | ) | [signal] |
| 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 829 of file actionscheduler.cpp.
| bool ActionScheduler::isEnabled | ( | ) | [static] |
Definition at line 817 of file actionscheduler.cpp.
| void KMail::ActionScheduler::result | ( | ReturnCode | ) | [signal] |
Emitted when filtering is completed.
| 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 ActionScheduler::setAlwaysMatch | ( | bool | alwaysMatch | ) |
| void ActionScheduler::setAutoDestruct | ( | bool | autoDestruct | ) |
The action scheduler will be deleted after the finish signal is emitted if this property is set to true.
Definition at line 141 of file actionscheduler.cpp.
| void ActionScheduler::setDefaultDestinationFolder | ( | KMFolder * | destFolder | ) |
| 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 182 of file actionscheduler.cpp.
| void ActionScheduler::setSourceFolder | ( | KMFolder * | srcFolder | ) |
Set a folder to monitor for new messages to filter.
Definition at line 156 of file actionscheduler.cpp.
The documentation for this class was generated from the following files:
