• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

kmail

  • sources
  • kde-4.12
  • kdepim
  • kmail
kmreaderwin.h
Go to the documentation of this file.
1 /* -*- mode: C++; c-file-style: "gnu" -*-
2  This file is part of KMail, the KDE mail client.
3  Copyright (c) 1997 Markus Wuebben <markus.wuebben@kde.org>
4  Copyright (c) 2013 Laurent Montel <montel@kde.org>
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10 
11  This program is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License along
17  with this program; if not, write to the Free Software Foundation, Inc.,
18  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 */
20 
21 #ifndef KMREADERWIN_H
22 #define KMREADERWIN_H
23 
24 #include <QWidget>
25 #include <kurl.h>
26 #include <messageviewer/viewer/viewer.h>
27 #include <messageviewer/interfaces/bodypart.h>
28 #include <Akonadi/Item>
29 #include <KABC/Addressee>
30 class KActionCollection;
31 class KAction;
32 class KToggleAction;
33 class KMenu;
34 namespace MessageViewer {
35  class HeaderStrategy;
36  class HeaderStyle;
37  class Viewer;
38  class CSSHelper;
39  class AttachmentStrategy;
40 }
41 
42 
43 class KJob;
44 
50 class KMReaderWin: public QWidget {
51  Q_OBJECT
52 
53 public:
54  explicit KMReaderWin( QWidget *parent, QWidget *mainWindow,
55  KActionCollection *actionCollection, Qt::WindowFlags f = 0 );
56  virtual ~KMReaderWin();
57 
59  void readConfig();
60 
61  MessageViewer::HeaderStyle * headerStyle() const;
62 
65  void setHeaderStyleAndStrategy( MessageViewer::HeaderStyle * style,
66  MessageViewer::HeaderStrategy * strategy );
68  const MessageViewer::HeaderStrategy * headerStrategy() const;
69 
71  const MessageViewer::AttachmentStrategy * attachmentStrategy() const;
72 
73  void setAttachmentStrategy( const MessageViewer::AttachmentStrategy * strategy );
74 
78  QString overrideEncoding() const;
80  void setOverrideEncoding( const QString & encoding );
81  virtual void setPrinting(bool enable );
82 
83  void setMessage( const Akonadi::Item& item, MessageViewer::Viewer::UpdateMode updateMode = MessageViewer::Viewer::Delayed);
84 
85  void setMessage( KMime::Message::Ptr message );
86 
89  void setMsgPart( KMime::Content* aMsgPart );
90 
92  void clear(bool force = false);
93 
94  void update(bool force = false);
95 
97  QString copyText() const;
98 
100  bool htmlOverride() const;
101  void setHtmlOverride( bool override );
102 
104  bool htmlLoadExtOverride() const;
105  void setHtmlLoadExtOverride( bool override );
106 
108  bool htmlMail() const;
109 
111  bool htmlLoadExternal();
112 
114  static QString newFeaturesMD5();
115 
117  void displaySplashPage( const QString &info );
118 
120  void displayAboutPage();
121 
123  void displayBusyPage();
125  void displayOfflinePage();
126 
127  void displayResourceOfflinePage();
128 
129  bool isFixedFont() const;
130  void setUseFixedFont( bool useFixedFont );
131  MessageViewer::Viewer *viewer() { return mViewer; }
132  KToggleAction *toggleFixFontAction() const;
133  KAction *mailToComposeAction() const { return mMailToComposeAction; }
134  KAction *mailToReplyAction() const { return mMailToReplyAction; }
135  KAction *mailToForwardAction() const { return mMailToForwardAction; }
136  KAction *addAddrBookAction() const { return mAddAddrBookAction; }
137  KAction *openAddrBookAction() const { return mOpenAddrBookAction; }
138  KAction *copyAction() const;
139  KAction *selectAllAction() const;
140  KAction *copyURLAction() const;
141  KAction *copyImageLocation() const;
142  KAction *urlOpenAction() const;
143  KAction *urlSaveAsAction() const { return mUrlSaveAsAction; }
144  KAction *addBookmarksAction() const { return mAddBookmarksAction;}
145  KAction *toggleMimePartTreeAction() const;
146  KAction *speakTextAction() const;
147  KAction* translateAction() const;
148  KAction* downloadImageToDiskAction() const;
149  KAction *viewSourceAction() const;
150  KAction *findInMessageAction() const;
151  KAction *saveAsAction() const;
152  KAction *saveMessageDisplayFormatAction() const;
153  KAction *resetMessageDisplayFormatAction() const;
154  KAction *blockImage() const;
155  KAction *openBlockableItems() const;
156  KAction *expandShortUrlAction() const;
157 
158  KAction *editContactAction() const { return mEditContactAction; }
159 
160  KMenu *viewHtmlOption() const { return mViewHtmlOptions; }
161  KAction *shareImage() const { return mShareImage; }
162 
163  Akonadi::Item message() const;
164 
165  QWidget* mainWindow() { return mMainWindow; }
166 
168  void setDecryptMessageOverwrite( bool overwrite = true );
169 
170  MessageViewer::CSSHelper* cssHelper() const;
171 
172  bool printSelectedText(bool preview);
173 
174  void setContactItem(const Akonadi::Item& contact, const KABC::Addressee &address);
175  void clearContactItem();
176  bool adblockEnabled() const;
177  bool isAShortUrl(const KUrl &url) const;
178 
179 signals:
182  void replaceMsgByUnencryptedVersion();
183 
184  void showStatusBarMessage( const QString &message );
185 
186 public slots:
188  void clearCache();
189 
191  void slotFind();
193  void slotCopySelectedText();
195  void slotMailtoReply();
196  void slotMailtoCompose();
197  void slotMailtoForward();
198  void slotMailtoAddAddrBook();
199  void slotMailtoOpenAddrBook();
201  void slotUrlSave();
202  void slotAddBookmarks();
203  void slotUrlClicked( const Akonadi::Item &, const KUrl& );
204  void slotShowReader( KMime::Content* , bool, const QString& );
205  void slotShowMessage( KMime::Message::Ptr message, const QString& encoding );
206  void slotDeleteMessage( const Akonadi::Item& );
207  void slotSaveImageOnDisk();
208 
209  void slotPrintComposeResult( KJob *job );
210  void slotEditContact();
211  void contactStored( const Akonadi::Item &item );
212  void slotContactEditorError(const QString &error);
213 
214  void slotContactHtmlOptions();
215  void slotShareImage();
216 
217 protected:
218  KUrl urlClicked() const;
219  KUrl imageUrlClicked() const;
220 
221 private:
222  void createActions();
223  void updateHtmlActions();
224 
225 private:
226  KABC::Addressee mSearchedAddress;
227  Akonadi::Item mSearchedContact;
228  QWidget *mMainWindow;
229  KActionCollection *mActionCollection;
230 
231  KAction *mMailToComposeAction;
232  KAction *mMailToReplyAction;
233  KAction *mMailToForwardAction;
234  KAction *mAddAddrBookAction;
235  KAction *mOpenAddrBookAction;
236  KAction *mUrlSaveAsAction;
237  KAction *mAddBookmarksAction;
238  KAction *mImageUrlSaveAsAction;
239  KAction *mEditContactAction;
240  KAction *mViewAsHtml;
241  KAction *mLoadExternalReference;
242  KAction *mShareImage;
243 
244  KMenu *mViewHtmlOptions;
245 
246  MessageViewer::Viewer *mViewer;
247 };
248 
249 
250 #endif
251 
KMReaderWin::htmlOverride
bool htmlOverride() const
Override default html mail setting.
Definition: kmreaderwin.cpp:454
KMReaderWin::headerStrategy
const MessageViewer::HeaderStrategy * headerStrategy() const
Getthe message header strategy.
Definition: kmreaderwin.cpp:597
KMReaderWin::attachmentStrategy
const MessageViewer::AttachmentStrategy * attachmentStrategy() const
Get/set the message attachment strategy.
Definition: kmreaderwin.cpp:572
KMReaderWin::slotPrintComposeResult
void slotPrintComposeResult(KJob *job)
Definition: kmreaderwin.cpp:746
KMReaderWin::slotFind
void slotFind()
The user selected "Find" from the menu.
Definition: kmreaderwin.cpp:424
KMReaderWin::urlOpenAction
KAction * urlOpenAction() const
Definition: kmreaderwin.cpp:637
KMReaderWin
This class implements a "reader window", that is a window used for reading or viewing messages...
Definition: kmreaderwin.h:50
KMReaderWin::blockImage
KAction * blockImage() const
Definition: kmreaderwin.cpp:858
KMReaderWin::copyURLAction
KAction * copyURLAction() const
Definition: kmreaderwin.cpp:607
KMReaderWin::viewer
MessageViewer::Viewer * viewer()
Definition: kmreaderwin.h:131
KMReaderWin::urlClicked
KUrl urlClicked() const
Definition: kmreaderwin.cpp:678
KMReaderWin::slotMailtoCompose
void slotMailtoCompose()
Definition: kmreaderwin.cpp:484
KMReaderWin::slotEditContact
void slotEditContact()
Definition: kmreaderwin.cpp:822
KMReaderWin::slotShareImage
void slotShareImage()
Definition: kmreaderwin.cpp:874
QWidget
KMReaderWin::viewHtmlOption
KMenu * viewHtmlOption() const
Definition: kmreaderwin.h:160
KMReaderWin::slotUrlSave
void slotUrlSave()
Save the page to a file.
Definition: kmreaderwin.cpp:533
KMReaderWin::isAShortUrl
bool isAShortUrl(const KUrl &url) const
Definition: kmreaderwin.cpp:880
KMReaderWin::mailToComposeAction
KAction * mailToComposeAction() const
Definition: kmreaderwin.h:133
KMReaderWin::saveAsAction
KAction * saveAsAction() const
Definition: kmreaderwin.cpp:627
KMReaderWin::contactStored
void contactStored(const Akonadi::Item &item)
Definition: kmreaderwin.cpp:842
KMReaderWin::setHeaderStyleAndStrategy
void setHeaderStyleAndStrategy(MessageViewer::HeaderStyle *style, MessageViewer::HeaderStrategy *strategy)
Set the header style and strategy.
Definition: kmreaderwin.cpp:271
KMReaderWin::~KMReaderWin
virtual ~KMReaderWin()
Definition: kmreaderwin.cpp:256
KMReaderWin::headerStyle
MessageViewer::HeaderStyle * headerStyle() const
Definition: kmreaderwin.cpp:602
KMReaderWin::mailToReplyAction
KAction * mailToReplyAction() const
Definition: kmreaderwin.h:134
KMReaderWin::message
Akonadi::Item message() const
Definition: kmreaderwin.cpp:478
KMReaderWin::displayResourceOfflinePage
void displayResourceOfflinePage()
Definition: kmreaderwin.cpp:347
KMReaderWin::setOverrideEncoding
void setOverrideEncoding(const QString &encoding)
Set the override character encoding.
Definition: kmreaderwin.cpp:276
KMReaderWin::slotMailtoForward
void slotMailtoForward()
Definition: kmreaderwin.cpp:491
KMReaderWin::replaceMsgByUnencryptedVersion
void replaceMsgByUnencryptedVersion()
Emitted after parsing of a message to have it stored in unencrypted state in it's folder...
KMReaderWin::setContactItem
void setContactItem(const Akonadi::Item &contact, const KABC::Addressee &address)
Definition: kmreaderwin.cpp:782
KMReaderWin::setPrinting
virtual void setPrinting(bool enable)
Definition: kmreaderwin.cpp:641
KMReaderWin::cssHelper
MessageViewer::CSSHelper * cssHelper() const
Definition: kmreaderwin.cpp:559
KMReaderWin::expandShortUrlAction
KAction * expandShortUrlAction() const
Definition: kmreaderwin.cpp:885
KMReaderWin::copyImageLocation
KAction * copyImageLocation() const
Definition: kmreaderwin.cpp:612
KMReaderWin::openAddrBookAction
KAction * openAddrBookAction() const
Definition: kmreaderwin.h:137
KMReaderWin::update
void update(bool force=false)
Definition: kmreaderwin.cpp:688
KMReaderWin::setDecryptMessageOverwrite
void setDecryptMessageOverwrite(bool overwrite=true)
Enforce message decryption.
Definition: kmreaderwin.cpp:568
KMReaderWin::slotMailtoAddAddrBook
void slotMailtoAddAddrBook()
Definition: kmreaderwin.cpp:499
KMReaderWin::KMReaderWin
KMReaderWin(QWidget *parent, QWidget *mainWindow, KActionCollection *actionCollection, Qt::WindowFlags f=0)
Definition: kmreaderwin.cpp:99
KMReaderWin::viewSourceAction
KAction * viewSourceAction() const
Definition: kmreaderwin.cpp:622
KMReaderWin::imageUrlClicked
KUrl imageUrlClicked() const
Definition: kmreaderwin.cpp:683
KMReaderWin::setMsgPart
void setMsgPart(KMime::Content *aMsgPart)
Instead of settings a message to be shown sets a message part to be shown.
Definition: kmreaderwin.cpp:437
KMReaderWin::translateAction
KAction * translateAction() const
Definition: kmreaderwin.cpp:656
KMReaderWin::displayBusyPage
void displayBusyPage()
Display the 'please wait' page instead of a message.
Definition: kmreaderwin.cpp:330
KMReaderWin::mainWindow
QWidget * mainWindow()
Definition: kmreaderwin.h:165
KMReaderWin::setAttachmentStrategy
void setAttachmentStrategy(const MessageViewer::AttachmentStrategy *strategy)
Definition: kmreaderwin.cpp:267
KMReaderWin::setHtmlOverride
void setHtmlOverride(bool override)
Definition: kmreaderwin.cpp:449
KMReaderWin::setHtmlLoadExtOverride
void setHtmlLoadExtOverride(bool override)
Definition: kmreaderwin.cpp:460
KMReaderWin::setMessage
void setMessage(const Akonadi::Item &item, MessageViewer::Viewer::UpdateMode updateMode=MessageViewer::Viewer::Delayed)
KMReaderWin::htmlMail
bool htmlMail() const
Is html mail to be supported? Takes into account override.
Definition: kmreaderwin.cpp:466
KMReaderWin::clear
void clear(bool force=false)
Clear the reader and discard the current message.
Definition: kmreaderwin.cpp:661
KMReaderWin::slotSaveImageOnDisk
void slotSaveImageOnDisk()
Definition: kmreaderwin.cpp:542
KMReaderWin::displayOfflinePage
void displayOfflinePage()
Display the 'we are currently in offline mode' page instead of a message.
Definition: kmreaderwin.cpp:338
KMReaderWin::clearContactItem
void clearContactItem()
Definition: kmreaderwin.cpp:774
KMReaderWin::resetMessageDisplayFormatAction
KAction * resetMessageDisplayFormatAction() const
Definition: kmreaderwin.cpp:853
KMReaderWin::downloadImageToDiskAction
KAction * downloadImageToDiskAction() const
Definition: kmreaderwin.cpp:651
KMReaderWin::adblockEnabled
bool adblockEnabled() const
Definition: kmreaderwin.cpp:863
KMReaderWin::shareImage
KAction * shareImage() const
Definition: kmreaderwin.h:161
KMReaderWin::slotDeleteMessage
void slotDeleteMessage(const Akonadi::Item &)
Definition: kmreaderwin.cpp:718
KMReaderWin::urlSaveAsAction
KAction * urlSaveAsAction() const
Definition: kmreaderwin.h:143
KMReaderWin::saveMessageDisplayFormatAction
KAction * saveMessageDisplayFormatAction() const
Definition: kmreaderwin.cpp:848
KMReaderWin::copyAction
KAction * copyAction() const
Definition: kmreaderwin.cpp:617
KMReaderWin::showStatusBarMessage
void showStatusBarMessage(const QString &message)
KMReaderWin::newFeaturesMD5
static QString newFeaturesMD5()
Returns the MD5 hash for the list of new features.
Definition: kmreaderwin.cpp:313
KMReaderWin::slotContactEditorError
void slotContactEditorError(const QString &error)
Definition: kmreaderwin.cpp:837
KMReaderWin::slotContactHtmlOptions
void slotContactHtmlOptions()
Definition: kmreaderwin.cpp:808
KMReaderWin::toggleFixFontAction
KToggleAction * toggleFixFontAction() const
Definition: kmreaderwin.cpp:582
KMReaderWin::addAddrBookAction
KAction * addAddrBookAction() const
Definition: kmreaderwin.h:136
KMReaderWin::editContactAction
KAction * editContactAction() const
Definition: kmreaderwin.h:158
KMReaderWin::slotMailtoOpenAddrBook
void slotMailtoOpenAddrBook()
Definition: kmreaderwin.cpp:511
KMReaderWin::slotMailtoReply
void slotMailtoReply()
Operations on mailto: URLs.
Definition: kmreaderwin.cpp:552
KMReaderWin::isFixedFont
bool isFixedFont() const
Definition: kmreaderwin.cpp:250
KMReaderWin::copyText
QString copyText() const
Return selected text.
Definition: kmreaderwin.cpp:443
KMReaderWin::overrideEncoding
QString overrideEncoding() const
Get selected override character encoding.
Definition: kmreaderwin.cpp:577
KMReaderWin::addBookmarksAction
KAction * addBookmarksAction() const
Definition: kmreaderwin.h:144
KMReaderWin::htmlLoadExtOverride
bool htmlLoadExtOverride() const
Override default load external references setting.
Definition: kmreaderwin.cpp:564
KMReaderWin::openBlockableItems
KAction * openBlockableItems() const
Definition: kmreaderwin.cpp:868
KMReaderWin::findInMessageAction
KAction * findInMessageAction() const
Definition: kmreaderwin.cpp:632
KMReaderWin::htmlLoadExternal
bool htmlLoadExternal()
Is loading ext.
Definition: kmreaderwin.cpp:472
KMReaderWin::toggleMimePartTreeAction
KAction * toggleMimePartTreeAction() const
Definition: kmreaderwin.cpp:587
KMReaderWin::displayAboutPage
void displayAboutPage()
Display the about page instead of a message.
Definition: kmreaderwin.cpp:358
KMReaderWin::printSelectedText
bool printSelectedText(bool preview)
Definition: kmreaderwin.cpp:726
KMReaderWin::mailToForwardAction
KAction * mailToForwardAction() const
Definition: kmreaderwin.h:135
KMReaderWin::slotUrlClicked
void slotUrlClicked(const Akonadi::Item &, const KUrl &)
Definition: kmreaderwin.cpp:693
KMReaderWin::slotAddBookmarks
void slotAddBookmarks()
Definition: kmreaderwin.cpp:523
KMReaderWin::slotShowMessage
void slotShowMessage(KMime::Message::Ptr message, const QString &encoding)
Definition: kmreaderwin.cpp:711
KMReaderWin::setUseFixedFont
void setUseFixedFont(bool useFixedFont)
Definition: kmreaderwin.cpp:245
KMReaderWin::selectAllAction
KAction * selectAllAction() const
Definition: kmreaderwin.cpp:592
KJob
KMReaderWin::slotCopySelectedText
void slotCopySelectedText()
Copy the selected text to the clipboard.
Definition: kmreaderwin.cpp:429
KMReaderWin::slotShowReader
void slotShowReader(KMime::Content *, bool, const QString &)
Definition: kmreaderwin.cpp:705
KMReaderWin::displaySplashPage
void displaySplashPage(const QString &info)
Display a generic HTML splash page instead of a message.
Definition: kmreaderwin.cpp:325
KMReaderWin::clearCache
void clearCache()
Force update even if message is the same.
Definition: kmreaderwin.cpp:282
KMReaderWin::speakTextAction
KAction * speakTextAction() const
Definition: kmreaderwin.cpp:646
KMReaderWin::readConfig
void readConfig()
Read settings from app's config file.
Definition: kmreaderwin.cpp:262
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:58:52 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kmail

Skip menu "kmail"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal