Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / kmail

kmail kmsearchpattern.h Go to the documentation of this file. // -*- mode: C++; c-file-style: "gnu" -*- // kmsearchpattern.h // Author: Marc Mutz <Marc@Mutz.com> // This code is under GPL! #ifndef _kmsearchpattern_h_ #define _kmsearchpattern_h_ #include <klocale.h> #include <qptrlist.h> #include <qstring.h> #include <qcstring.h> #include "kmmsgbase.h" // for KMMsgStatus class KMMessage; class KConfig; class DwBoyerMoore; class DwString; // maximum number of filter rules per filter const int FILTER_MAX_RULES=8; class KMSearchRule { public: enum Function { FuncNone = -1, FuncContains=0, FuncContainsNot, FuncEquals, FuncNotEqual, FuncRegExp, FuncNotRegExp, FuncIsGreater, FuncIsLessOrEqual, FuncIsLess, FuncIsGreaterOrEqual, FuncIsInAddressbook, FuncIsNotInAddressbook, FuncIsInCategory, FuncIsNotInCategory, FuncHasAttachment, FuncHasNoAttachment}; KMSearchRule ( const QCString & field=0, Function=FuncContains, const QString &contents=QString::null ); KMSearchRule ( const KMSearchRule &other ); const KMSearchRule & operator=( const KMSearchRule & other ); static KMSearchRule* createInstance( const QCString & field=0, Function function=FuncContains, const QString & contents=QString::null ); static KMSearchRule* createInstance( const QCString & field, const char * function, const QString & contents ); static KMSearchRule * createInstance( const KMSearchRule & other ); static KMSearchRule* createInstanceFromConfig( const KConfig * config, int aIdx ); virtual ~KMSearchRule() {}; 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 { return true; } void writeConfig( KConfig * config, int aIdx ) const; Function function() const { return mFunction; } void setFunction( Function aFunction ) { mFunction = aFunction; } QCString field() const { return mField; } void setField( const QCString & field ) { mField = field; } QString contents() const { return mContents; } void setContents( const QString & aContents ) { mContents = aContents; } const QString asString() const; private: static Function configValueToFunc( const char * str ); static QString functionToString( Function function ); QCString mField; Function mFunction; QString mContents; }; // subclasses representing the different kinds of searches class KMSearchRuleString : public KMSearchRule { public: KMSearchRuleString( const QCString & field=0, Function function=FuncContains, const QString & contents=QString::null ); KMSearchRuleString( const KMSearchRuleString & other ); const KMSearchRuleString & operator=( const KMSearchRuleString & other ); virtual ~KMSearchRuleString(); 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 QString & msgContents ) const; private: const DwBoyerMoore *mBmHeaderField; }; class KMSearchRuleNumerical : public KMSearchRule { public: KMSearchRuleNumerical( const QCString & field=0, Function function=FuncContains, const QString & contents=QString::null ); virtual bool isEmpty() const ; virtual bool matches( const KMMessage * msg ) const; bool matchesInternal( long numericalValue, long numericalMsgContents, const QString & msgContents ) const; }; namespace KMail { // The below are used in several places and here so they are accessible. struct MessageStatus { const char * const text; const char * const icon; }; // If you change the ordering here; also do it in the enum below static const MessageStatus StatusValues[] = { { I18N_NOOP( "Important" ), "kmmsgflag" }, { I18N_NOOP( "New" ), "kmmsgnew" }, { I18N_NOOP( "Unread" ), "kmmsgunseen" }, { I18N_NOOP( "Read" ), "kmmsgread" }, { I18N_NOOP( "Old" ), 0 }, { I18N_NOOP( "Deleted" ), "kmmsgdel" }, { I18N_NOOP( "Replied" ), "kmmsgreplied" }, { I18N_NOOP( "Forwarded" ), "kmmsgforwarded" }, { I18N_NOOP( "Queued" ), "kmmsgqueued" }, { I18N_NOOP( "Sent" ), "kmmsgsent" }, { I18N_NOOP( "Watched" ), "kmmsgwatched" }, { I18N_NOOP( "Ignored" ), "kmmsgignored" }, { I18N_NOOP( "Spam" ), "kmmsgspam" }, { I18N_NOOP( "Ham" ), "kmmsgham" }, { I18N_NOOP( "To Do" ), "kmmsgtodo" }, { I18N_NOOP( "Has Attachment"), "kmmsgattachment" } }; // If you change the ordering here; also do it in the array above enum StatusValueTypes { StatusImportant = 0, StatusNew = 1, StatusUnread = 2, StatusRead = 3, StatusOld = 4, StatusDeleted = 5, StatusReplied = 6, StatusForwarded = 7, StatusQueued = 8, StatusSent = 9, StatusWatched = 10, StatusIgnored = 11, StatusSpam = 12, StatusHam = 13, StatusToDo = 14, StatusHasAttachment = 15 }; static const int StatusValueCount = sizeof( StatusValues ) / sizeof( MessageStatus ); // we want to show all status entries in the quick search bar, but only the // ones up to attachment in the search/filter dialog, because there the // attachment case is handled separately. static const int StatusValueCountWithoutHidden = StatusValueCount - 1; } class KMSearchRuleStatus : public KMSearchRule { public: KMSearchRuleStatus( const QCString & field=0, Function function=FuncContains, const QString & contents=QString::null ); KMSearchRuleStatus( int status, Function function=FuncContains ); virtual bool isEmpty() const ; virtual bool matches( const KMMessage * msg ) const; //Not possible to implement this form for status searching virtual bool matches( const DwString &, KMMessage &, const DwBoyerMoore *, int ) const; static KMMsgStatus statusFromEnglishName(const QString&); private: KMMsgStatus mStatus; }; // ------------------------------------------------------------------------ class KMSearchPattern : public QPtrList<KMSearchRule> { public: enum Operator { OpAnd, OpOr }; KMSearchPattern( const KConfig * config=0 ); ~KMSearchPattern(); bool matches( const KMMessage * msg, bool ignoreBody = false ) const; bool matches( const DwString & str, bool ignoreBody = false ) const; bool matches( Q_UINT32 sernum, bool ignoreBody = false ) const; bool requiresBody() const; void purify(); void readConfig( const KConfig * config ); void writeConfig( KConfig * config ) const; QString name() const { return mName; } void setName( const QString & newName ) { mName = newName ; } KMSearchPattern::Operator op() const { return mOperator; } void setOp( KMSearchPattern::Operator aOp ) { mOperator = aOp; } QString asString() const; const KMSearchPattern & operator=( const KMSearchPattern & aPattern ); private: void importLegacyConfig( const KConfig * config ); void init(); QString mName; Operator mOperator; }; #endif /* _kmsearchpattern_h_ */ kmail Skip menu "kmail" Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Namespace Members Class Members Related Pages API Reference Skip menu "API Reference"   doc kioslaves kmail konsolekalendar kpilot libemailfunctions libkcal Generated for API Reference by doxygen 1.5.9 This website is maintained by Adriaan de Groot and Allen Winter. KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal