messageviewer/util.h

   1 /*******************************************************************************
   2 **
   3 ** Filename   : util
   4 ** Created on : 03 April, 2005
   5 ** Copyright  : (c) 2005 Till Adam
   6 ** Email      : <adam@kde.org>
   7 **
   8 *******************************************************************************/
   9
  10 /*******************************************************************************
  11 **
  12 **   This program is free software; you can redistribute it and/or modify
  13 **   it under the terms of the GNU General Public License as published by
  14 **   the Free Software Foundation; either version 2 of the License, or
  15 **   (at your option) any later version.
  16 **
  17 **   It is distributed in the hope that it will be useful, but
  18 **   WITHOUT ANY WARRANTY; without even the implied warranty of
  19 **   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20 **   General Public License for more details.
  21 **
  22 **   You should have received a copy of the GNU General Public License
  23 **   along with this program; if not, write to the Free Software
  24 **   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  25 **
  26 **   In addition, as a special exception, the copyright holders give
  27 **   permission to link the code of this program with any edition of
  28 **   the Qt library by Trolltech AS, Norway (or with modified versions
  29 **   of Qt that use the same license as Qt), and distribute linked
  30 **   combinations including the two.  You must obey the GNU General
  31 **   Public License in all respects for all of the code used other than
  32 **   Qt.  If you modify this file, you may extend this exception to
  33 **   your version of the file, but you are not obligated to do so.  If
  34 **   you do not wish to do so, delete this exception statement from
  35 **   your version.
  36 **
  37 *******************************************************************************/
  38 #ifndef MAILVIEWERUTIL_H
  39 #define MAILVIEWERUTIL_H
  40
  41 #include "messageviewer_export.h"
  42 #include "kmime/kmime_content.h"
  43 #include <QString>
  44
  45 class KUrl;
  46 class QWidget;
  47 class QStringList;
  48
  49 namespace KMime {
  50   class Content;
  51   class Message;
  52 }
  53
  54 namespace Akonadi {
  55   class Item;
  56 }
  57
  58 namespace MessageViewer {
  59
  60 /**
  61  * The Util namespace contains a collection of helper functions use in
  62  * various places.
  63  */
  64 namespace Util {
  65
  66     /**
  67       * Describes the type of the displayed message. This depends on the MIME structure
  68       * of the mail and on whether HTML mode is enabled (which is decided by htmlMail())
  69       */
  70     enum HtmlMode {
  71       Normal,         ///< A normal plaintext message, non-multipart
  72       Html,           ///< A HTML message, non-multipart
  73       MultipartPlain, ///< A multipart/alternative message, the plain text part is currently displayed
  74       MultipartHtml   ///< A multipart/altervative message, the HTML part is currently displayed
  75     };
  76
  77     // return true if we should proceed, false if we should abort
  78     bool MESSAGEVIEWER_EXPORT checkOverwrite( const KUrl &url, QWidget *w );
  79
  80     /**
  81      * Delegates opening a URL to the QDesktopServices mechanisms for that
  82      * on Windows and MacOSX.
  83      * Returns false if it did nothing (such as on other platforms).
  84      */
  85     bool MESSAGEVIEWER_EXPORT handleUrlWithQDesktopServices( const KUrl& url );
  86
  87     /**
  88      * evaluates GlobalSettings->disregardUmask()
  89      * and returns resulting permissions for storing files
  90      * @return specific file permissions or -1 for default permissions
  91      */
  92     int MESSAGEVIEWER_EXPORT getWritePermissions();
  93
  94     QList<KMime::Content*> MESSAGEVIEWER_EXPORT allContents( const KMime::Content *message );
  95     QList<KMime::Content*> MESSAGEVIEWER_EXPORT extractAttachments( const KMime::Message *message );
  96     bool MESSAGEVIEWER_EXPORT saveContents( QWidget *parent,
  97                                             const QList<KMime::Content*> &contents );
  98     bool MESSAGEVIEWER_EXPORT saveContent( QWidget *parent, KMime::Content* content,
  99                                            const KUrl& url );
 100
 101     /**
 102      * Finds the filename of an icon based on the given mimetype or filenames.
 103      *
 104      * Always use this functions when looking up icon names for mime types, don't use
 105      * KMimeType directly.
 106      *
 107      * Uses the IconNameCache internally to speed things up.
 108      *
 109      * @param mimeType The primary mime type used to find the icon, e.g. "application/zip". Alias
 110      *                 mimetypes are resolved.
 111      * @param size Size of the requested icon, e.g. KIconLoader::Desktop
 112      * @param fallbackFileName(1|2) When the icon is not found by the given mime type, use the file
 113      *                              name extensions of these file names to look the icon up.
 114      *                              Example: "test.zip"
 115      * @return the full file name of the icon file
 116      */
 117     QString MESSAGEVIEWER_EXPORT fileNameForMimetype( const QString &mimeType, int iconSize,
 118                                  const QString &fallbackFileName1 = QString(),
 119                                  const QString &fallbackFileName2 = QString() );
 120     bool MESSAGEVIEWER_EXPORT saveMessageInMbox( const QList<Akonadi::Item>& retrievedMsgs, QWidget*parent);
 121
 122     bool MESSAGEVIEWER_EXPORT saveAttachments( const KMime::Content::List& contents, QWidget *parent );
 123
 124 }
 125
 126 }
 127
 128 #endif