kmail
KMFilter Class Reference
List of all members.Detailed Description
Definition at line 40 of file kmfilter.h.
Public Types | |
enum | ReturnCode { NoResult, GoOn, CriticalError } |
enum | AccountType { All, ButImap, Checked } |
Public Member Functions | |
KMFilter (KConfig *aConfig=0, bool popFilter=false) | |
KMFilter (const KMFilter &other) | |
~KMFilter () | |
QString | name () const |
ReturnCode | execActions (KMMessage *msg, bool &stopIt) const |
bool | requiresBody (KMMsgBase *msgBase) |
KMPopFilterAction | action () |
void | setAction (const KMPopFilterAction aAction) |
void | writeConfig (KConfig *config) const |
void | readConfig (KConfig *config) |
void | purify () |
bool | isEmpty () const |
QPtrList< KMFilterAction > * | actions () |
const QPtrList< KMFilterAction > * | actions () const |
KMSearchPattern * | pattern () |
const KMSearchPattern * | pattern () const |
void | setApplyOnOutbound (bool aApply=true) |
bool | applyOnOutbound () const |
void | setApplyOnInbound (bool aApply=true) |
bool | applyOnInbound () const |
void | setApplyOnExplicit (bool aApply=true) |
bool | applyOnExplicit () const |
void | setApplicability (AccountType aApply=All) |
AccountType | applicability () const |
void | setApplyOnAccount (uint id, bool aApply=true) |
bool | applyOnAccount (uint id) const |
void | setStopProcessingHere (bool aStop) |
bool | stopProcessingHere () const |
void | setConfigureShortcut (bool aShort) |
bool | configureShortcut () const |
void | setConfigureToolbar (bool aTool) |
bool | configureToolbar () const |
void | setShortcut (const KShortcut &shortcut) |
const KShortcut & | shortcut () const |
void | setIcon (QString icon) |
QString | icon () const |
bool | folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder) |
const QString | asString () const |
bool | isPopFilter () const |
void | setAutoNaming (bool useAutomaticNames) |
bool | isAutoNaming () const |
Member Enumeration Documentation
|
Account type codes used by setApplicability. They mean:
Definition at line 65 of file kmfilter.h. |
|
Result codes returned by process. They mean:
Definition at line 54 of file kmfilter.h. |
Constructor & Destructor Documentation
|
Constructor that initializes from given config file, if given. Filters are stored one by one in config groups, i.e. one filter, one group. The config group has to be preset if config is not 0. Definition at line 42 of file kmfilter.cpp. |
|
Copy constructor.
Constructs a deep copy of Definition at line 65 of file kmfilter.cpp. |
|
Cleanup.
Definition at line 76 of file kmfilter.h. |
Member Function Documentation
|
No descriptions.
Definition at line 169 of file kmfilter.cpp. |
|
Provides a reference to the internal action list. Const version. Definition at line 130 of file kmfilter.h. |
|
Provides a reference to the internal action list.
If your used the Definition at line 127 of file kmfilter.h. |
|
Definition at line 193 of file kmfilter.h. |
|
Definition at line 196 of file kmfilter.cpp. |
|
Definition at line 176 of file kmfilter.h. |
|
Definition at line 164 of file kmfilter.h. |
|
Definition at line 152 of file kmfilter.h. |
|
Returns the filter in a human-readable form. useful for debugging but not much else. Don't use, as it may well go away in the future... Definition at line 383 of file kmfilter.cpp. |
|
Definition at line 223 of file kmfilter.h. |
|
Definition at line 237 of file kmfilter.h. |
|
Execute the filter action(s) on the given message. Returns:
Definition at line 107 of file kmfilter.cpp. |
|
Called from the filter manager when a folder is moved. Tests if the folder aFolder is used in any action. Changes it to aNewFolder folder in this case.
Definition at line 175 of file kmfilter.cpp. |
|
Definition at line 259 of file kmfilter.h. |
|
Definition at line 292 of file kmfilter.h. |
|
Check for empty pattern and action list.
Definition at line 374 of file kmfilter.cpp. |
|
No descriptions.
Definition at line 278 of file kmfilter.h. |
|
Equivalent to ()->name().
Definition at line 79 of file kmfilter.h. |
|
Provides a reference to the internal pattern.
If you used the Definition at line 140 of file kmfilter.h. |
|
Provides a reference to the internal pattern.
If you used the Definition at line 135 of file kmfilter.h. |
|
Remove empty rules (and actions one day).
Definition at line 350 of file kmfilter.cpp. |
|
Initialize from given config file. The config group (see constructor above) has to be preset. The config object will be deleted by higher levels, so it is not allowed to store a pointer to it anywhere inside this function. Definition at line 213 of file kmfilter.cpp. |
|
Determines if the filter depends on the body of the message.
Definition at line 150 of file kmfilter.cpp. |
|
No descriptions.
Definition at line 163 of file kmfilter.cpp. |
|
Set whether this filter should be applied on inbound messages for all accounts ( Only applicable to filters that are applied on inbound messages.
Definition at line 185 of file kmfilter.h. |
|
Set whether this filter should be applied on inbound messages for the account with id ( Only applicable to filters that are only applied to a specified set of accounts.
Definition at line 187 of file kmfilter.cpp. |
|
Set whether this filter should be applied on explicit (CTRL-J) filtering (
Definition at line 170 of file kmfilter.h. |
|
Set whether this filter should be applied on inbound messages (
Definition at line 158 of file kmfilter.h. |
|
Set whether this filter should be applied on outbound messages ( See applyOnOutbound applyOnInbound setApplyOnInbound Definition at line 146 of file kmfilter.h. |
|
Set the mode for using automatic naming for the filter. If the feature is enabled, the name is derived from the first filter rule. Definition at line 286 of file kmfilter.h. |
|
Set whether this filter should be plugged into the filter menu.
Definition at line 214 of file kmfilter.h. |
|
Set whether this filter should be plugged into the toolbar. This can be done only if a shortcut is defined.
Definition at line 229 of file kmfilter.h. |
|
Set the icon to be used if plugged into the filter menu or toolbar. Default is the gear icon.
Definition at line 254 of file kmfilter.h. |
|
Set the shortcut to be used if plugged into the filter menu or toolbar. Default is no shortcut.
Definition at line 243 of file kmfilter.h. |
|
Definition at line 248 of file kmfilter.h. |
|
Write contents to given config file. The config group (see the constructor above) has to be preset. The config object will be deleted by higher levels, so it is not allowed to store a pointer to it anywhere inside this function. Definition at line 298 of file kmfilter.cpp. |
The documentation for this class was generated from the following files: