kmail
KMSearchPattern Class Reference
This class is an abstraction of a search over messages. More...
#include <kmsearchpattern.h>
Public Types | |
| enum | Operator { OpAnd, OpOr } |
Public Member Functions | |
| QString | asString () const |
| KMSearchPattern (const KConfig *config=0) | |
| bool | matches (Q_UINT32 sernum, bool ignoreBody=false) const |
| bool | matches (const DwString &str, bool ignoreBody=false) const |
| bool | matches (const KMMessage *msg, bool ignoreBody=false) const |
| QString | name () const |
| KMSearchPattern::Operator | op () const |
| const KMSearchPattern & | operator= (const KMSearchPattern &aPattern) |
| void | purify () |
| void | readConfig (const KConfig *config) |
| bool | requiresBody () const |
| void | setName (const QString &newName) |
| void | setOp (KMSearchPattern::Operator aOp) |
| void | writeConfig (KConfig *config) const |
| ~KMSearchPattern () | |
Detailed Description
This class is an abstraction of a search over messages.It is intended to be used inside a KFilter (which adds KFilterAction's), as well as in KMSearch. It can read and write itself into a KConfig group and there is a constructor, mainly used by KMFilter to initialize from a preset KConfig-Group.
From a class hierarchy point of view, it is a QPtrList of KMSearchRule's that adds the boolean operators (see Operator) 'and' and 'or' that connect the rules logically, and has a name under which it could be stored in the config file.
As a QPtrList with autoDelete enabled, it assumes that it is the central repository for the rules it contains. So if you want to reuse a rule in another pattern, make a deep copy of that rule.
An abstraction of a search over messages.
Definition at line 306 of file kmsearchpattern.h.
Member Enumeration Documentation
Boolean operators that connect the return values of the individual rules.
A pattern with OpAnd will match iff all it's rules match, whereas a pattern with OpOr will match iff any of it's rules matches.
Definition at line 315 of file kmsearchpattern.h.
Constructor & Destructor Documentation
| KMSearchPattern::KMSearchPattern | ( | const KConfig * | config = 0 |
) |
Constructor that initializes from a given KConfig group, if given.
This feature is mainly (solely?) used in KMFilter, as we don't allow to store search patterns in the config (yet). If config is 0, provides a pattern with minimal, but sufficient initialization. Unmodified, such a pattern will fail to match any KMMessage. You can query for such an empty rule by using isEmpty, which is inherited from QPtrList.
Definition at line 700 of file kmsearchpattern.cpp.
| KMSearchPattern::~KMSearchPattern | ( | ) |
Member Function Documentation
| QString KMSearchPattern::asString | ( | ) | const |
| bool KMSearchPattern::matches | ( | Q_UINT32 | sernum, | |
| bool | ignoreBody = false | |||
| ) | const |
Definition at line 763 of file kmsearchpattern.cpp.
| bool KMSearchPattern::matches | ( | const DwString & | str, | |
| bool | ignoreBody = false | |||
| ) | const |
Definition at line 738 of file kmsearchpattern.cpp.
| bool KMSearchPattern::matches | ( | const KMMessage * | msg, | |
| bool | ignoreBody = false | |||
| ) | const |
The central function of this class.
Tries to match the set of rules against a KMMessage. It's virtual to allow derived classes with added rules to reimplement it, yet reimplemented methods should and (&&) the result of this function with their own result or else most functionality is lacking, or has to be reimplemented, since the rules are private to this class.
- Returns:
- TRUE if the match was successful, FALSE otherwise.
Definition at line 714 of file kmsearchpattern.cpp.
| QString KMSearchPattern::name | ( | ) | const [inline] |
| KMSearchPattern::Operator KMSearchPattern::op | ( | ) | const [inline] |
| const KMSearchPattern & KMSearchPattern::operator= | ( | const KMSearchPattern & | aPattern | ) |
Overloaded assignment operator.
Makes a deep copy.
Definition at line 914 of file kmsearchpattern.cpp.
| void KMSearchPattern::purify | ( | ) |
Removes all empty rules from the list.
You should call this method whenever the user had had control of the rules outside of this class. (e.g. after editing it with KMSearchPatternEdit).
Definition at line 801 of file kmsearchpattern.cpp.
| void KMSearchPattern::readConfig | ( | const KConfig * | config | ) |
Reads a search pattern from a KConfig.
The group has to be preset. If it does not find a valid saerch pattern in the preset group, initializes the pattern as if it were constructed using the default constructor.
For backwards compatibility with previous versions of KMail, it checks for old-style filter rules (e.g. using OpIgnore) in config und converts them to the new format on writeConfig.
Derived classes reimplementing readConfig() should also call this method, or else the rules will not be loaded.
Definition at line 815 of file kmsearchpattern.cpp.
| bool KMSearchPattern::requiresBody | ( | ) | const |
Returns true if the pattern only depends the DwString that backs a message.
Definition at line 793 of file kmsearchpattern.cpp.
| void KMSearchPattern::setName | ( | const QString & | newName | ) | [inline] |
Set the name of the search pattern.
KMFilter uses this to store it's own name, too.
Definition at line 377 of file kmsearchpattern.h.
| void KMSearchPattern::setOp | ( | KMSearchPattern::Operator | aOp | ) | [inline] |
| void KMSearchPattern::writeConfig | ( | KConfig * | config | ) | const |
Writes itself into config.
The group has to be preset. Tries to delete old-style keys by overwriting them with QString::null.
Derived classes reimplementing writeConfig() should also call this method, or else the rules will not be stored.
Definition at line 881 of file kmsearchpattern.cpp.
The documentation for this class was generated from the following files:
