kmail Library API Documentation

KMSearchRuleStatus Class Reference

This class represents a search to be performed against the status of a messsage. This class represents a search pattern rule operating on message status. More...

#include <kmsearchpattern.h>

Inheritance diagram for KMSearchRuleStatus:

KMSearchRule List of all members.

Public Member Functions

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

Detailed Description

This class represents a search to be performed against the status of a messsage. This class represents a search pattern rule operating on message status.

The status is represented by a bitfield.

Definition at line 210 of file kmsearchpattern.h.


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 468 of file kmsearchpattern.cpp.

References KMSearchRule::contents(), and KMSearchRule::field().

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 480 of file kmsearchpattern.cpp.

References KMSearchRule::function(), and matches().

Referenced by matches().

bool KMSearchRuleStatus::matches const DwString &  ,
KMMessage &  ,
const DwBoyerMoore *  ,
int 
const [virtual]
 

Optimized version tries to match the rule against the given DwString.

Returns:
TRUE if the rule matched, FALSE otherwise.

Reimplemented from KMSearchRule.

Definition at line 473 of file kmsearchpattern.cpp.

References matches().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Jul 28 23:58:05 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003