kmail
KMSearchRule Class Reference
#include <kmsearchpattern.h>
Inheritance diagram for KMSearchRule:

Detailed Description
Incoming mail is sent through the list of mail filter rules before it is placed in the associated mail folder (usually "inbox").This class represents one search pattern rule.This class represents one mail filter rule. It is also used to represent a search rule as used by the search dialog and folders.
Definition at line 31 of file kmsearchpattern.h.
Public Types | |
enum | Function { FuncNone = -1, FuncContains = 0, FuncContainsNot, FuncEquals, FuncNotEqual, FuncRegExp, FuncNotRegExp, FuncIsGreater, FuncIsLessOrEqual, FuncIsLess, FuncIsGreaterOrEqual, FuncIsInAddressbook, FuncIsNotInAddressbook, FuncIsInCategory, FuncIsNotInCategory, FuncHasAttachment, FuncHasNoAttachment } |
Public Member Functions | |
KMSearchRule (const QCString &field=0, Function=FuncContains, const QString &contents=QString::null) | |
KMSearchRule (const KMSearchRule &other) | |
const KMSearchRule & | operator= (const KMSearchRule &other) |
virtual bool | matches (const KMMessage *msg) const =0 |
virtual bool | matches (const DwString &str, KMMessage &msg, const DwBoyerMoore *headerField=0, int headerLen=-1) const |
virtual bool | isEmpty () const =0 |
virtual bool | requiresBody () const |
void | writeConfig (KConfig *config, int aIdx) const |
Function | function () const |
void | setFunction (Function aFunction) |
QCString | field () const |
void | setField (const QCString &field) |
QString | contents () const |
void | setContents (const QString &aContents) |
const QString | asString () const |
Static Public Member Functions | |
static KMSearchRule * | createInstance (const QCString &field=0, Function function=FuncContains, const QString &contents=QString::null) |
static KMSearchRule * | createInstance (const QCString &field, const char *function, const QString &contents) |
static KMSearchRule * | createInstance (const KMSearchRule &other) |
static KMSearchRule * | createInstanceFromConfig (const KConfig *config, int aIdx) |
Member Enumeration Documentation
|
Operators for comparison of field and contents. If you change the order or contents of the enum: do not forget to change funcConfigNames[], sFilterFuncList and matches() in KMSearchRule, too. Also, it is assumed that these functions come in pairs of logical opposites (ie. "=" <-> "!=", ">" <-> "<=", etc.). Definition at line 41 of file kmsearchpattern.h. |
Member Function Documentation
|
Returns the rule as string. For debugging. Definition at line 182 of file kmsearchpattern.cpp. |
|
Return the value. This can be either a substring to search for in or a regexp pattern to match against the header. Definition at line 134 of file kmsearchpattern.h. |
|
Create a search rule of a certain type by instantiating the appro- priate subclass depending on the
Definition at line 98 of file kmsearchpattern.cpp. |
|
Initialize the object from a given config file.
The group must be preset. Definition at line 125 of file kmsearchpattern.cpp. |
|
Return message header field name (without the trailing ':'). There are also six pseudo-headers:
Definition at line 126 of file kmsearchpattern.h. |
|
Return filter function. This can be any of the operators defined in Function. Definition at line 111 of file kmsearchpattern.h. |
|
Determine whether the rule is worth considering. It isn't if either the field is not set or the contents is empty. KFilter should make sure that it's rule list contains only non-empty rules, as matches doesn't check this. Implemented in KMSearchRuleString, KMSearchRuleNumerical, and KMSearchRuleStatus. |
|
Optimized version tries to match the rule against the given.
Reimplemented in KMSearchRuleString, and KMSearchRuleStatus. Definition at line 172 of file kmsearchpattern.cpp. |
|
Tries to match the rule against the given KMMessage.
Implemented in KMSearchRuleString, KMSearchRuleNumerical, and KMSearchRuleStatus. |
|
Returns true if the rule depends on a complete message, otherwise returns false.
Reimplemented in KMSearchRuleString. Definition at line 99 of file kmsearchpattern.h. |
|
Set the value.
Definition at line 136 of file kmsearchpattern.h. |
|
Set message header field name (make sure there's no trailing colon ':').
Definition at line 130 of file kmsearchpattern.h. |
|
Set filter function.
Definition at line 114 of file kmsearchpattern.h. |
|
Save the object into a given config file.
The group must be preset. Definition at line 161 of file kmsearchpattern.cpp. |
The documentation for this class was generated from the following files: