MailCommon::SearchRuleDate Class Reference

#include <searchruledate.h>

Inheritance diagram for MailCommon::SearchRuleDate:

Public Member Functions
	SearchRuleDate (const QByteArray &field=QByteArray(), Function function=FuncContains, const QString &contents=QString())
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 QDate &dateValue, const QDate &msgDate) const
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 25 of file searchruledate.h.

Constructor & Destructor Documentation

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

explicit

Creates new date 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 30 of file searchruledate.cpp.

Member Function Documentation

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

virtual

Adds query terms to the given term group.

Reimplemented from MailCommon::SearchRule.

Definition at line 102 of file searchruledate.cpp.

QString SearchRuleDate::informationAboutNotValidRules ( ) const

virtual

Reimplemented from MailCommon::SearchRule.

Definition at line 38 of file searchruledate.cpp.

bool SearchRuleDate::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 44 of file searchruledate.cpp.

bool SearchRuleDate::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 49 of file searchruledate.cpp.

bool SearchRuleDate::matchesInternal	(	const QDate &	dateValue,
		const QDate &	msgDate
	)		const

A helper method for the main matches() method.

Does the actual comparing.

Definition at line 67 of file searchruledate.cpp.

SearchRule::RequiredPart SearchRuleDate::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 95 of file searchruledate.cpp.

---

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

• searchruledate.h
• searchruledate.cpp