KMSearchRule Class Reference
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. More...
#include <kmsearchpattern.h>
Inherited by KMSearchRuleNumerical, KMSearchRuleStatus, and KMSearchRuleString.
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)
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.
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
|
Member Function Documentation
|
Create a search rule of a certain type by instantiating the appro- priate subclass depending on the
|
|
Initialize the object from a given config file.
The group must be preset.
|
|
Tries to match the rule against the given.
Implemented in KMSearchRuleString, and KMSearchRuleNumerical. |
|
Optimized version tries to match the rule against the given.
Reimplemented in KMSearchRuleString. |
|
Determine whether the rule is worth considering. It isn't if either the field is not set or the contents is empty.
Implemented in KMSearchRuleString, and KMSearchRuleNumerical. |
|
Returns true if the rule depends on a complete message, otherwise returns false.
Reimplemented in KMSearchRuleString. |
|
Save the object into a given config file.
The group must be preset. |
|
Return filter function. This can be any of the operators defined in
|
|
Set filter function.
|
|
Return message header field name (without the trailing ':'). There are also six pseudo-headers:
|
|
Set message header field name (make sure there's no trailing colon ':').
|
|
Return the value. This can be either a substring to search for in or a regexp pattern to match against the header. |
|
Set the value.
|
|
Returns the rule as string. For debugging. |
The documentation for this class was generated from the following files:
- kmsearchpattern.h
- kmsearchpattern.cpp