KDE PIM / Developers / API Docs / kmail

KMSearchRuleString Class Reference

This class represents a search to be performed against a string. This class represents a search pattern rule operating on a string. More...

#include <kmsearchpattern.h>

Inherits KMSearchRule.

List of all members.

Public Member Functions


Detailed Description

This class represents a search to be performed against a string. This class represents a search pattern rule operating on a string.

The string can be either a message header, or a pseudo header, such as <body>


Member Function Documentation

bool KMSearchRuleString::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.

See also:
KFilter should make sure that it's rule list contains only non-empty rules, as

matches doesn't check this.

Implements KMSearchRule.

bool KMSearchRuleString::requiresBody  )  const [virtual]
 

Returns true if the rule depends on a complete message, otherwise returns false.

Reimplemented from KMSearchRule.

bool KMSearchRuleString::matches const KMMessage *  msg  )  const [virtual]
 

Tries to match the rule against the given.

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

Implements KMSearchRule.

bool KMSearchRuleString::matches const DwString &  str,
KMMessage &  msg,
const DwBoyerMoore *  headerField = 0,
int  headerLen = -1
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.

bool KMSearchRuleString::matchesInternal const QString &  msgContents  )  const
 

Helper for the main matches() method.

Does the actual comparing.


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