MailCommon::SearchRuleString Class Reference

#include <searchrulestring.h>

Inheritance diagram for MailCommon::SearchRuleString:

Public Member Functions
	SearchRuleString (const QByteArray &field=QByteArray(), Function function=FuncContains, const QString &contents=QString())
	SearchRuleString (const SearchRuleString &other)
virtual	~SearchRuleString ()
virtual void	addQueryTerms (Akonadi::SearchTerm &groupTerm, bool &emptyIsNotAnError) const
virtual QString	informationAboutNotValidRules () const
virtual bool	isEmpty () const
virtual bool	matches (const Akonadi::Item &item) const
bool	matchesInternal (const QString &contents) const
const SearchRuleString &	operator= (const SearchRuleString &other)
virtual RequiredPart	requiredPart () const
Public Member Functions inherited from MailCommon::SearchRule
	SearchRule (const QByteArray &field=QByteArray(), Function function=FuncContains, const QString &contents=QString())
	SearchRule (const SearchRule &other)
virtual	~SearchRule ()
const QString	asString () const
QString	contents () const
QByteArray	field () const
Function	function () const
void	generateSieveScript (QStringList &requires, QString &code)
const SearchRule &	operator= (const SearchRule &other)
QDataStream &	operator>> (QDataStream &) const
void	setContents (const QString &contents)
void	setField (const QByteArray &name)
void	setFunction (Function function)
void	writeConfig (KConfigGroup &group, int index) const

Additional Inherited Members
Public Types inherited from MailCommon::SearchRule
enum	Function {   FuncNone = -1, FuncContains = 0, FuncContainsNot, FuncEquals,   FuncNotEqual, FuncRegExp, FuncNotRegExp, FuncIsGreater,   FuncIsLessOrEqual, FuncIsLess, FuncIsGreaterOrEqual, FuncIsInAddressbook,   FuncIsNotInAddressbook, FuncIsInCategory, FuncIsNotInCategory, FuncHasAttachment,   FuncHasNoAttachment, FuncStartWith, FuncNotStartWith, FuncEndWith,   FuncNotEndWith }
typedef boost::shared_ptr < SearchRule >	Ptr
enum	RequiredPart { Envelope = 0, Header, CompleteMessage }
Static Public Member Functions inherited from MailCommon::SearchRule
static SearchRule::Ptr	createInstance (const QByteArray &field=0, Function function=FuncContains, const QString &contents=QString())
static SearchRule::Ptr	createInstance (const QByteArray &field, const char *function, const QString &contents)
static SearchRule::Ptr	createInstance (const SearchRule &other)
static SearchRule::Ptr	createInstance (QDataStream &stream)
static SearchRule::Ptr	createInstanceFromConfig (const KConfigGroup &group, int index)
Protected Member Functions inherited from MailCommon::SearchRule
Akonadi::SearchTerm::Condition	akonadiComparator () const
bool	isNegated () const
QString	quote (const QString &content) const

Detailed Description

Definition at line 32 of file searchrulestring.h.

Constructor & Destructor Documentation

SearchRuleString::SearchRuleString ( const QByteArray &  field = QByteArray(), Function  function = FuncContains, const QString &  contents = QString()  )

explicit

Creates new new string search rule.

Parameters

field	The field to search in.
function	The function to use for searching.
contents	The contents to search for.

Definition at line 45 of file searchrulestring.cpp.

SearchRuleString::SearchRuleString

(

const SearchRuleString &

other

)

Creates a new string search rule from an other rule.

Definition at line 52 of file searchrulestring.cpp.

SearchRuleString::~SearchRuleString ( )

virtual

Destroys the string search rule.

Definition at line 70 of file searchrulestring.cpp.

Member Function Documentation

void SearchRuleString::addQueryTerms ( Akonadi::SearchTerm &  groupTerm, bool &  emptyIsNotAnError  ) const

virtual

Adds query terms to the given term group.

Reimplemented from MailCommon::SearchRule.

Definition at line 199 of file searchrulestring.cpp.

QString SearchRuleString::informationAboutNotValidRules ( ) const

virtual

Reimplemented from MailCommon::SearchRule.

Definition at line 252 of file searchrulestring.cpp.

bool SearchRuleString::isEmpty ( ) const

virtual

Determines whether the rule is worth considering.

It isn't if either the field is not set or the contents is empty. The calling code should make sure that it's rule list contains only non-empty rules, as matches doesn't check this.

Implements MailCommon::SearchRule.

Definition at line 74 of file searchrulestring.cpp.

bool SearchRuleString::matches ( const Akonadi::Item &  item ) const

virtual

Tries to match the rule against the KMime::Message in the given item.

Returns

true if the rule matched, false otherwise.

Note

Must be implemented by subclasses.

Implements MailCommon::SearchRule.

Definition at line 110 of file searchrulestring.cpp.

bool SearchRuleString::matchesInternal

(

const QString &

contents

)

const

A helper method for the main matches() method.

Does the actual comparing.

Definition at line 259 of file searchrulestring.cpp.

const SearchRuleString & SearchRuleString::operator=

(

const SearchRuleString &

other

)

Initializes this rule with an other rule.

Definition at line 57 of file searchrulestring.cpp.

SearchRule::RequiredPart SearchRuleString::requiredPart ( ) const

virtual

Returns the required part from the item that is needed for the search to operate.

See RequiredPart

Implements MailCommon::SearchRule.

Definition at line 79 of file searchrulestring.cpp.

---

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

• searchrulestring.h
• searchrulestring.cpp