kmail

KMSearchRuleStatus Class Reference

This class represents a search to be performed against the status of a messsage. More...

#include <kmsearchpattern.h>

Inheritance diagram for KMSearchRuleStatus:

List of all members.


Public Member Functions

virtual bool isEmpty () const
 KMSearchRuleStatus (int status, Function function=FuncContains)
 KMSearchRuleStatus (const QCString &field=0, Function function=FuncContains, const QString &contents=QString::null)
virtual bool matches (const DwString &, KMMessage &, const DwBoyerMoore *, int) const
virtual bool matches (const KMMessage *msg) const

Static Public Member Functions

static KMMsgStatus statusFromEnglishName (const QString &)

Detailed Description

This class represents a search to be performed against the status of a messsage.

The status is represented by a bitfield. This class represents a search pattern rule operating on message status.

Definition at line 268 of file kmsearchpattern.h.


Constructor & Destructor Documentation

KMSearchRuleStatus::KMSearchRuleStatus ( const QCString field = 0,
Function  function = FuncContains,
const QString contents = QString::null 
)

Definition at line 623 of file kmsearchpattern.cpp.

KMSearchRuleStatus::KMSearchRuleStatus ( int  status,
Function  function = FuncContains 
)

Definition at line 632 of file kmsearchpattern.cpp.


Member Function Documentation

bool KMSearchRuleStatus::isEmpty (  )  const [virtual]

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.

Implements KMSearchRule.

Definition at line 648 of file kmsearchpattern.cpp.

bool KMSearchRuleStatus::matches ( const DwString &  str,
KMMessage msg,
const DwBoyerMoore *  headerField,
int  headerLen 
) const [virtual]

Optimized version tries to match the rule against the given.

See also:
DwString.
Returns:
TRUE if the rule matched, FALSE otherwise.

Reimplemented from KMSearchRule.

Definition at line 653 of file kmsearchpattern.cpp.

bool KMSearchRuleStatus::matches ( const KMMessage msg  )  const [virtual]

Tries to match the rule against the given KMMessage.

Returns:
TRUE if the rule matched, FALSE otherwise. Must be implemented by subclasses.

Implements KMSearchRule.

Definition at line 660 of file kmsearchpattern.cpp.

KMMsgStatus KMSearchRuleStatus::statusFromEnglishName ( const QString aStatusString  )  [static]

Definition at line 638 of file kmsearchpattern.cpp.


The documentation for this class was generated from the following files: