#include <searchpattern.h>

Inheritance diagram for MailCommon::SearchRuleString:

Public Member Functions
	SearchRuleString (const QByteArray &field=0, Function function=FuncContains, const QString &contents=QString())

	SearchRuleString (const SearchRuleString &other)

virtual	~SearchRuleString ()

virtual void	addQueryTerms (Nepomuk2::Query::GroupTerm &groupTerm, bool &emptyIsNotAnError) 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=0, 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
void	addAndNegateTerm (const Nepomuk2::Query::Term &term, Nepomuk2::Query::GroupTerm &termGroup) const

bool	isNegated () const

Nepomuk2::Query::ComparisonTerm::Comparator	nepomukComparator () const

QString	quote (const QString &content) const

Detailed Description

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

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>

Definition at line 317 of file searchpattern.h.

Constructor & Destructor Documentation

SearchRuleString::SearchRuleString	(	const QByteArray &	field = `0`,
		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 657 of file searchpattern.cpp.

SearchRuleString::SearchRuleString ( const SearchRuleString & other )

Creates a new string search rule from an other rule.

Definition at line 664 of file searchpattern.cpp.

SearchRuleString::~SearchRuleString ( )

virtual

Destroys the string search rule.

Definition at line 682 of file searchpattern.cpp.

Member Function Documentation

void SearchRuleString::addQueryTerms	(	Nepomuk2::Query::GroupTerm &	groupTerm,
		bool &	emptyIsNotAnError
	)		const

virtual

Adds query terms to the given term group.

Implements MailCommon::SearchRule.

Definition at line 868 of file searchpattern.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 686 of file searchpattern.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 710 of file searchpattern.cpp.

bool SearchRuleString::matchesInternal ( const QString & contents ) const

A helper method for the main matches() method.

Does the actual comparing.

Definition at line 998 of file searchpattern.cpp.

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

Initializes this rule with an other rule.

Definition at line 669 of file searchpattern.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 691 of file searchpattern.cpp.

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

mailcommon

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

mailcommon

kdepim API Reference

Search