messagecore/attachmentcompressjob.h

   1 /*
   2   Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>
   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 MESSAGECORE_ATTACHMENTCOMPRESSJOB_H
  21 #define MESSAGECORE_ATTACHMENTCOMPRESSJOB_H
  22
  23 #include "messagecore_export.h"
  24
  25 #include "attachmentpart.h"
  26
  27 #include <KDE/KJob>
  28
  29 namespace MessageCore {
  30
  31 /**
  32  * @short A job to compress the attachment of an email.
  33  *
  34  * @author Constantin Berzan <exit3219@gmail.com>
  35  */
  36 class MESSAGECORE_EXPORT AttachmentCompressJob : public KJob
  37 {
  38   Q_OBJECT
  39
  40   public:
  41     /**
  42      * Creates a new attachment compress job.
  43      *
  44      * @param part The part of the attachment to compress.
  45      * @param parent The parent object.
  46      */
  47     explicit AttachmentCompressJob( const AttachmentPart::Ptr &part, QObject *parent = 0 );
  48
  49     /**
  50      * Destroys the attachment compress job.
  51      */
  52     virtual ~AttachmentCompressJob();
  53
  54     /**
  55      * Starts the attachment compress job.
  56      */
  57     virtual void start();
  58
  59     /**
  60      * Sets the original @p part of the compressed attachment.
  61      */
  62     void setOriginalPart( const AttachmentPart::Ptr &part );
  63
  64     /**
  65      * Returns the original part of the compressed attachment.
  66      */
  67     const AttachmentPart::Ptr originalPart() const;
  68
  69     /**
  70      * Returns the compressed part of the attachment.
  71      *
  72      * @note does not delete it unless it failed...
  73      */
  74     AttachmentPart::Ptr compressedPart() const;
  75
  76     /**
  77      * Returns whether the compressed part is larger than the original part.
  78      */
  79     bool isCompressedPartLarger() const;
  80
  81   private:
  82     //@cond PRIVATE
  83     class Private;
  84     Private *const d;
  85
  86     Q_PRIVATE_SLOT( d, void doStart() )
  87     //@endcond
  88 };
  89
  90 }
  91
  92 #endif