viewer.h

Go to the documentation of this file.

/* -*- mode: C++; c-file-style: "gnu" -*-
  This file is part of KMail, the KDE mail client.
  Copyright (c) 1997 Markus Wuebben <markus.wuebben@kde.org>
  Copyright (C) 2009 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.net
  Copyright (c) 2009 Andras Mantia <andras@kdab.net>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program 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.
*/

#ifndef MESSAGEVIEWER_H
#define MESSAGEVIEWER_H

#include "messageviewer_export.h"

#include <kmime/kmime_message.h>

#include <QWidget>

namespace Akonadi {
class Item;
class ItemFetchJob;
}

class KActionCollection;
class KAction;
class KToggleAction;
class KUrl;

class QAbstractItemModel;
class QCloseEvent;
class QEvent;
class QResizeEvent;

namespace MessageViewer {

class AttachmentStrategy;
class CSSHelper;
class HeaderStrategy;
class HeaderStyle;
class ViewerPrivate;

class AbstractMessageLoadedHandler
{
  public:
    
    virtual ~AbstractMessageLoadedHandler() {}

    virtual void setItem( const Akonadi::Item &item ) = 0;
};

//TODO(Andras) once only those methods are public that really need to be public, probably export the whole class instead of just some methods

class MESSAGEVIEWER_EXPORT Viewer: public QWidget
{
  Q_OBJECT

  Q_DECLARE_PRIVATE( Viewer )

  public:
  explicit Viewer( QWidget *parent, QWidget *mainWindow = 0, KActionCollection *actionCollection = 0,
          Qt::WindowFlags f = 0 );
  virtual ~Viewer();

  KMime::Message::Ptr message() const;

  Akonadi::Item messageItem() const;

  enum ForceDisplayTo {
    Unknown = 0,
    Text = 1,
    Html = 2
  };

  enum AttachmentAction
  {
    Open = 1,
    OpenWith = 2,
    View = 3,
    Save = 4,
    Properties = 5,
    ChiasmusEncrypt = 6,
    Delete = 7,
    Edit = 8,
    Copy = 9,
    ScrollTo = 10
  };

  enum UpdateMode {
    Force = 0,
    Delayed
  };

  enum ResourceOnlineMode {
    AllResources = 0,
    SelectedResource = 1
  };

  void setMessage( KMime::Message::Ptr message, UpdateMode updateMode = Delayed );

  void setMessageItem( const Akonadi::Item& item, UpdateMode updateMode = Delayed );

  QString messagePath() const;

  void setMessagePath( const QString &path );

  void setMessagePart( KMime::Content* aMsgPart );

  void clear( UpdateMode updateMode = Delayed ) { setMessage( KMime::Message::Ptr(), updateMode ); }

  void update( UpdateMode updateMode = Delayed );

  void printMessage( const Akonadi::Item &msg );

  void printPreviewMessage( const Akonadi::Item &message );

  void print();
  void printPreview();

  bool htmlOverride() const;

  void setHtmlOverride( bool override );

  bool htmlLoadExtOverride() const;

  void setHtmlLoadExtOverride( bool override );

  bool htmlMail() const;

  bool htmlLoadExternal() const;

  void setAppName( const QString &appName );

  void displaySplashPage( const QString& info );

  void enableMessageDisplay();

  bool atBottom() const;

  bool isFixedFont() const;
  void setUseFixedFont( bool useFixedFont );

  QWidget* mainWindow();

  void setDecryptMessageOverwrite( bool overwrite = true );

  QWidget* configWidget();

  void deleteMessage();

  const AttachmentStrategy * attachmentStrategy() const;
  void setAttachmentStrategy( const AttachmentStrategy * strategy );

  QString overrideEncoding() const;
  void setOverrideEncoding( const QString &encoding );
  CSSHelper* cssHelper() const;
  void setPrinting(bool enable);

  void selectAll();
  void clearSelection();
  void copySelectionToClipboard();

  void setZoomFactor( qreal zoomFactor );


  void setZoomTextOnly( bool textOnly );
  bool zoomTextOnly() const;

  
  KToggleAction *toggleFixFontAction();

  KToggleAction *toggleMimePartTreeAction();

  KAction *selectAllAction();
  KAction *copyURLAction();
  KAction *copyAction();
  KAction *urlOpenAction();
  KAction *speakTextAction();
  KAction *copyImageLocation();
  KAction *translateAction();
  KAction *viewSourceAction();
  KAction *findInMessageAction();
  KAction *saveAsAction();
  KAction *saveMessageDisplayFormatAction();
  KAction *resetMessageDisplayFormatAction();
  KAction *blockImage();
  KAction *openBlockableItems();
  KAction *expandShortUrlAction();

  HeaderStrategy * headerStrategy() const;

  HeaderStyle * headerStyle() const;

  void setHeaderStyleAndStrategy( HeaderStyle * style,
                                  HeaderStrategy * strategy );
  void writeConfig( bool withSync=true );

  KUrl urlClicked() const;
  KUrl imageUrlClicked() const;

  void readConfig();

  QAbstractItemModel* messageTreeModel() const;

  static Akonadi::ItemFetchJob* createFetchJob( const Akonadi::Item &item );

  void setScrollBarPolicy( Qt::Orientation orientation, Qt::ScrollBarPolicy policy );

  Qt::ScrollBarPolicy scrollBarPolicy( Qt::Orientation orientation ) const;

  void addMessageLoadedHandler( AbstractMessageLoadedHandler *handler );

  void removeMessageLoadedHandler( AbstractMessageLoadedHandler *handler );


  QString selectedText() const;

  void setExternalWindow( bool b );


  void saveMainFrameScreenshotInFile(const QString &filename);
  bool adblockEnabled() const;
  bool isAShortUrl(const KUrl &url) const;


signals:
  void moveMessageToTrash();

  void showStatusBarMessage( const QString &message );

  void replaceMsgByUnencryptedVersion();

  void popupMenu(const Akonadi::Item &msg, const KUrl &url, const KUrl &imageUrl, const QPoint& mousePos);

  void urlClicked( const Akonadi::Item &, const KUrl& );

  void requestConfigSync();

  void showReader( KMime::Content* aMsgPart, bool aHTML, const QString & encoding );

  void showMessage( KMime::Message::Ptr message, const QString& encoding );

  void deleteMessage( const Akonadi::Item & );

  void itemRemoved();

  void makeResourceOnline(MessageViewer::Viewer::ResourceOnlineMode mode);

private:
  void initialize();

public slots:

  void slotScrollUp( int pixels = 10 );
  void slotScrollDown( int pixels = 10 );
  void slotScrollPrior();
  void slotScrollNext();
  void slotJumpDown();
  void slotFind();
  void slotTranslate();
  void slotSaveMessage();
  void slotAttachmentSaveAs();
  void slotAttachmentSaveAll();
  void slotShowMessageSource();
  void slotZoomIn();
  void slotZoomOut();
  void slotZoomReset();
  void slotChangeDisplayMail(Viewer::ForceDisplayTo,bool);
protected:
  virtual void closeEvent(QCloseEvent *);
  virtual void resizeEvent(QResizeEvent *);
  virtual bool event(QEvent *e);

#ifdef KDEPIM_MOBILE_UI
  friend class MessageViewItem;
#endif
  ViewerPrivate* const d_ptr;
};

}

#endif