summaryrefslogtreecommitdiffstats
path: root/kmail/messageproperty.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit460c52653ab0dcca6f19a4f492ed2c5e4e963ab0 (patch)
tree67208f7c145782a7e90b123b982ca78d88cc2c87 /kmail/messageproperty.h
downloadtdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.tar.gz
tdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kmail/messageproperty.h')
-rw-r--r--kmail/messageproperty.h112
1 files changed, 112 insertions, 0 deletions
diff --git a/kmail/messageproperty.h b/kmail/messageproperty.h
new file mode 100644
index 000000000..1ffbdcc7b
--- /dev/null
+++ b/kmail/messageproperty.h
@@ -0,0 +1,112 @@
+/* Message Property
+
+ This file is part of KMail, the KDE mail client.
+ Copyright (c) Don Sanders <sanders@kde.org>
+
+ KMail is free software; you can redistribute it and/or modify it
+ under the terms of the GNU General Public License, version 2, as
+ published by the Free Software Foundation.
+
+ KMail is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+ In addition, as a special exception, the copyright holders give
+ permission to link the code of this program with any edition of
+ the Qt library by Trolltech AS, Norway (or with modified versions
+ of Qt that use the same license as Qt), and distribute linked
+ combinations including the two. You must obey the GNU General
+ Public License in all respects for all of the code used other than
+ Qt. If you modify this file, you may extend this exception to
+ your version of the file, but you are not obligated to do so. If
+ you do not wish to do so, delete this exception statement from
+ your version.
+*/
+#ifndef messageproperty_h
+#define messageproperty_h
+
+#include "kmfilteraction.h" // for KMFilterAction::ReturnCode
+#include "kmfolder.h"
+
+#include <qptrlist.h>
+#include <qguardedptr.h>
+#include <qobject.h>
+
+class KMFilter;
+class KMFilterDlg;
+
+namespace KMail {
+
+class ActionScheduler;
+
+/* A place to store properties that some but not necessarily all messages
+ have.
+
+ These properties do not need to be stored persistantly on disk but
+ rather only are required while KMail is running.
+
+ Furthermore some properties, namely complete, transferInProgress, and
+ serialCache should only exist during the lifetime of a particular
+ KMMsgBase based instance.
+ */
+class MessageProperty : public QObject
+{
+ Q_OBJECT
+
+public:
+ /** If the message is being filtered */
+ static bool filtering( Q_UINT32 );
+ static void setFiltering( Q_UINT32, bool filtering );
+ static bool filtering( const KMMsgBase* );
+ static void setFiltering( const KMMsgBase*, bool filtering );
+ /** The folder this message is to be moved into once
+ filtering is finished, or null if the message is not
+ scheduled to be moved */
+ static KMFolder* filterFolder( Q_UINT32 );
+ static void setFilterFolder( Q_UINT32, KMFolder* folder );
+ static KMFolder* filterFolder( const KMMsgBase* );
+ static void setFilterFolder( const KMMsgBase*, KMFolder* folder );
+ /* Set the filterHandler for a message */
+ static ActionScheduler* filterHandler( Q_UINT32 );
+ static void setFilterHandler( Q_UINT32, ActionScheduler* filterHandler );
+ static ActionScheduler* filterHandler( const KMMsgBase* );
+ static void setFilterHandler( const KMMsgBase*, ActionScheduler* filterHandler );
+
+ /* Caches the serial number for a message, or more correctly for a
+ KMMsgBase based instance representing a message.
+ This property becomes invalid when the message is destructed or
+ assigned a new value */
+ static void setSerialCache( const KMMsgBase*, Q_UINT32 );
+ static Q_UINT32 serialCache( const KMMsgBase* );
+
+ /* Set the transferInProgress for a message
+ This property becomes invalid when the message is destructed or
+ assigned a new value */
+ static void setTransferInProgress( const KMMsgBase*, bool, bool = false );
+ static bool transferInProgress( const KMMsgBase* );
+ static void setTransferInProgress( Q_UINT32, bool, bool = false );
+ static bool transferInProgress( Q_UINT32 );
+ /** Some properties, namely complete, transferInProgress, and
+ serialCache must be forgotten when a message class instance is
+ destructed or assigned a new value */
+ static void forget( const KMMsgBase* );
+
+private:
+ // The folder a message is to be moved into once filtering is finished if any
+ static QMap<Q_UINT32, QGuardedPtr<KMFolder> > sFolders;
+ // The action scheduler currently processing a message if any
+ static QMap<Q_UINT32, QGuardedPtr<ActionScheduler> > sHandlers;
+ // The transferInProgres state of a message if any.
+ static QMap<Q_UINT32, int > sTransfers;
+ // The cached serial number of a message if any.
+ static QMap<const KMMsgBase*, long > sSerialCache;
+};
+
+}
+
+#endif /*messageproperty_h*/