kmail

Public Member Functions | List of all members
KMSearchRuleString Class Reference

#include <kmsearchpattern.h>

Inheritance diagram for KMSearchRuleString:
KMSearchRule

Public Member Functions

 KMSearchRuleString (const TQCString &field=0, Function function=FuncContains, const TQString &contents=TQString())
 
 KMSearchRuleString (const KMSearchRuleString &other)
 
const KMSearchRuleString & operator= (const KMSearchRuleString &other)
 
virtual bool isEmpty () const
 
virtual bool requiresBody () const
 
virtual bool matches (const KMMessage *msg) const
 
virtual bool matches (const DwString &str, KMMessage &msg, const DwBoyerMoore *headerField=0, int headerLen=-1) const
 
bool matchesInternal (const TQString &msgContents) const
 
- Public Member Functions inherited from KMSearchRule
 KMSearchRule (const TQCString &field=0, Function=FuncContains, const TQString &contents=TQString())
 
 KMSearchRule (const KMSearchRule &other)
 
const KMSearchRule & operator= (const KMSearchRule &other)
 
virtual bool matches (const KMMessage *msg) const =0
 
virtual bool matches (const DwString &str, KMMessage &msg, const DwBoyerMoore *headerField=0, int headerLen=-1) const
 
virtual bool isEmpty () const =0
 
virtual bool requiresBody () const
 
void writeConfig (TDEConfig *config, int aIdx) const
 
Function function () const
 
void setFunction (Function aFunction)
 
TQCString field () const
 
void setField (const TQCString &field)
 
TQString contents () const
 
void setContents (const TQString &aContents)
 
const TQString asString () const
 

Additional Inherited Members

- Public Types inherited from KMSearchRule
enum  Function {
  FuncNone = -1 , FuncContains =0 , FuncContainsNot , FuncEquals ,
  FuncNotEqual , FuncRegExp , FuncNotRegExp , FuncIsGreater ,
  FuncIsLessOrEqual , FuncIsLess , FuncIsGreaterOrEqual , FuncIsInAddressbook ,
  FuncIsNotInAddressbook , FuncIsInCategory , FuncIsNotInCategory , FuncHasAttachment ,
  FuncHasNoAttachment
}
 
- Static Public Member Functions inherited from KMSearchRule
static KMSearchRule * createInstance (const TQCString &field=0, Function function=FuncContains, const TQString &contents=TQString())
 
static KMSearchRule * createInstance (const TQCString &field, const char *function, const TQString &contents)
 
static KMSearchRule * createInstance (const KMSearchRule &other)
 
static KMSearchRule * createInstanceFromConfig (const TDEConfig *config, int aIdx)
 

Detailed Description

This class represents a search to be performed against a string.

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

This class represents a search pattern rule operating on a string.

Definition at line 158 of file kmsearchpattern.h.

Constructor & Destructor Documentation

◆ KMSearchRuleString() [1/2]

KMSearchRuleString::KMSearchRuleString ( const TQCString &  field = 0,
Function  function = FuncContains,
const TQString &  contents = TQString() 
)

Definition at line 199 of file kmsearchpattern.cpp.

◆ KMSearchRuleString() [2/2]

KMSearchRuleString::KMSearchRuleString ( const KMSearchRuleString &  other)

Definition at line 209 of file kmsearchpattern.cpp.

◆ ~KMSearchRuleString()

KMSearchRuleString::~KMSearchRuleString ( )
virtual

Definition at line 233 of file kmsearchpattern.cpp.

Member Function Documentation

◆ isEmpty()

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

◆ matches() [1/2]

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 DwString.

Returns
TRUE if the rule matched, FALSE otherwise.

Reimplemented from KMSearchRule.

Definition at line 251 of file kmsearchpattern.cpp.

◆ matches() [2/2]

bool KMSearchRuleString::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 325 of file kmsearchpattern.cpp.

◆ matchesInternal()

bool KMSearchRuleString::matchesInternal ( const TQString &  msgContents) const

Helper for the main matches() method.

Does the actual comparing.

Definition at line 411 of file kmsearchpattern.cpp.

◆ operator=()

const KMSearchRuleString & KMSearchRuleString::operator= ( const KMSearchRuleString &  other)

Definition at line 217 of file kmsearchpattern.cpp.

◆ requiresBody()

bool KMSearchRuleString::requiresBody ( ) const
virtual

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

Reimplemented from KMSearchRule.

Definition at line 244 of file kmsearchpattern.cpp.

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