KMSearchPattern Class Reference
This class is an abstraction of a search over messages. An abstraction of a search over messages. More...
#include <kmsearchpattern.h>
Inheritance diagram for KMSearchPattern:

Public Types | |
enum | Operator { OpAnd, OpOr } |
Public Member Functions | |
KMSearchPattern (const KConfig *config=0) | |
~KMSearchPattern () | |
bool | matches (const KMMessage *msg) const |
bool | matches (const DwString &str) const |
bool | matches (Q_UINT32 sernum) const |
bool | requiresBody () const |
void | purify () |
void | readConfig (const KConfig *config) |
void | writeConfig (KConfig *config) const |
QString | name () const |
void | setName (const QString &newName) |
KMSearchPattern::Operator | op () const |
void | setOp (KMSearchPattern::Operator aOp) |
QString | asString () const |
const KMSearchPattern & | operator= (const KMSearchPattern &aPattern) |
Detailed Description
This class is an abstraction of a search over messages. 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.
- Author:
- Marc Mutz <Marc@Mutz.com>
Definition at line 280 of file kmsearchpattern.h.
Member Enumeration Documentation
|
Boolean operators that connect the return values of the individual rules.
A pattern with Referenced by op(). |
Constructor & Destructor Documentation
|
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 674 of file kmsearchpattern.cpp. References readConfig(). |
|
Destructor. Deletes all stored rules! Definition at line 684 of file kmsearchpattern.cpp. |
Member Function Documentation
|
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 pattern only depends the DwString that backs a message. Definition at line 764 of file kmsearchpattern.cpp. |
|
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 772 of file kmsearchpattern.cpp. |
|
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 Derived classes reimplementing readConfig() should also call this method, or else the rules will not be loaded. Definition at line 786 of file kmsearchpattern.cpp. References KMSearchRule::createInstanceFromConfig(), and KMSearchRule::isEmpty(). Referenced by KMSearchPattern(). |
|
Writes itself into 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 852 of file kmsearchpattern.cpp. |
|
Get the name of the search pattern. Definition at line 349 of file kmsearchpattern.h. Referenced by KMail::AntiSpamWizard::accept(), operator=(), and KMFilterListBox::slotUpdateFilterName(). |
|
Set the name of the search pattern. KMFilter uses this to store it's own name, too. Definition at line 352 of file kmsearchpattern.h. Referenced by KMail::AntiSpamWizard::accept(), operator=(), and KMFilterListBox::slotUpdateFilterName(). |
|
Get the filter operator. Definition at line 355 of file kmsearchpattern.h. References Operator. Referenced by operator=(), and KMSearchPatternEdit::setSearchPattern(). |
|
Set the filter operator. Definition at line 357 of file kmsearchpattern.h. Referenced by KMail::AntiSpamWizard::accept(), and operator=(). |
|
Returns the pattern as string. For debugging. Definition at line 872 of file kmsearchpattern.cpp. |
|
Overloaded assignment operator. Makes a deep copy. Definition at line 885 of file kmsearchpattern.cpp. |
The documentation for this class was generated from the following files: