kmail/messagecopyhelper.h

   1 /*
   2     Copyright (c) 2007 Volker Krause <vkrause@kde.org>
   3
   4     This library is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU Library General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or (at your
   7     option) any later version.
   8
   9     This library is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  12     License for more details.
  13
  14     You should have received a copy of the GNU Library General Public License
  15     along with this library; see the file COPYING.LIB.  If not, write to the
  16     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17     02110-1301, USA.
  18 */
  19
  20 #ifndef KMAIL_MESSAGECOPYHELPER_H
  21 #define KMAIL_MESSAGECOPYHELPER_H
  22
  23 #include <QPointer>
  24 #include <QObject>
  25 #include <QList>
  26 #include <QMap>
  27
  28 #include <maillistdrag.h>
  29
  30 class KMCommand;
  31 class KMFolder;
  32 class KMMsgBase;
  33
  34 namespace KMail {
  35
  36 /**
  37   Helper class to copy/move a set of messages defined by their serial
  38   numbers from arbitrary folders into a common destination folder.
  39 */
  40 class MessageCopyHelper : public QObject
  41 {
  42   Q_OBJECT
  43
  44   public:
  45     /**
  46       Creates new MessageCopyHelper object to copy the given messages
  47       to the specified destination folder.
  48       @param msgs List of serial numbers.
  49       @param dest Destination folder.
  50       @param move If set to true, messages will be moved instead of copied
  51       @param parent The parent object.
  52     */
  53     MessageCopyHelper( const QList<quint32> &msgs, KMFolder *dest,
  54                        bool move, QObject *parent = 0 );
  55
  56     /**
  57       Converts a MailList into a serial number list.
  58     */
  59     static QList<quint32> serNumListFromMailList( const KPIM::MailList &list );
  60
  61     /**
  62       Converts a KMMsgsBase* list into a serial number list.
  63     */
  64     static QList<quint32> serNumListFromMsgList( QList<KMMsgBase*> list );
  65
  66     /**
  67       Checks of any of the given messages comes from a read-only source.
  68     */
  69     static bool inReadOnlyFolder( const QList<quint32> &sernums );
  70
  71     /**
  72      * Returns the source folder for the first serial number found
  73      * in the sernums list. This can be used as a quick and dirty "guess"
  74      * in dnd operations for finding if the drag comes from the
  75      * same folder as destination. It will catch 90% of the cases.
  76      * The real drop operation should obviously use a more detailed check.
  77      * This function may return zero if the list is empty or contains
  78      * some kind of garbage.
  79      */
  80     static KMFolder * firstSourceFolder( const QList<quint32> &sernums );
  81
  82   private slots:
  83     void copyCompleted( KMCommand *cmd );
  84
  85   private:
  86     QMap<QPointer<KMFolder>, int> mOpenFolders;
  87 };
  88
  89 }
  90
  91 #endif