MessageViewer::Viewer
#include <viewer.h>
Public Types | |
enum | AttachmentAction { Open = 1 , OpenWith , View , Save , Properties , Delete , Copy , ScrollTo , ReplyMessageToAuthor , ReplyMessageToAll } |
enum | DisplayFormatMessage { UseGlobalSetting = 0 , Text = 1 , Html = 2 , Unknown = 3 , ICal = 4 } |
enum | ResourceOnlineMode { AllResources = 0 , SelectedResource = 1 } |
Public Types inherited from QWidget | |
enum | RenderFlag |
Public Types inherited from QPaintDevice | |
enum | PaintDeviceMetric |
Signals | |
void | deleteMessage (const Akonadi::Item &) |
void | displayPopupMenu (const Akonadi::Item &msg, const WebEngineViewer::WebHitTestResult &result, const QPoint &mousePos) |
void | itemRemoved () |
void | makeResourceOnline (MessageViewer::Viewer::ResourceOnlineMode mode) |
void | moveMessageToTrash () |
void | pageIsScrolledToBottom (bool) |
void | popupMenu (const Akonadi::Item &msg, const QUrl &url, const QUrl &imageUrl, const QPoint &mousePos) |
void | printingFinished () |
void | replyMessageTo (const KMime::Message::Ptr &message, bool replyToAll) |
void | requestConfigSync () |
void | sendResponse (MessageViewer::MDNWarningWidget::ResponseType type, KMime::MDN::SendingMode sendingMode) |
void | showMessage (const KMime::Message::Ptr &message, const QString &encoding) |
void | showNextMessage () |
void | showPreviousMessage () |
void | showReader (KMime::Content *aMsgPart, bool aHTML, const QString &encoding) |
void | showStatusBarMessage (const QString &message) |
void | urlClicked (const Akonadi::Item &, const QUrl &) |
void | zoomChanged (qreal zoomFactor) |
Public Slots | |
void | slotAttachmentSaveAll () |
void | slotAttachmentSaveAs () |
void | slotChangeDisplayMail (Viewer::DisplayFormatMessage, bool) |
void | slotFind () |
void | slotJumpDown () |
void | slotSaveMessage () |
void | slotScrollDown () |
void | slotScrollNext () |
void | slotScrollPrior () |
void | slotScrollUp () |
void | slotShowMessageSource () |
void | slotZoomIn () |
void | slotZoomOut () |
void | slotZoomReset () |
Protected Attributes | |
ViewerPrivate *const | d_ptr |
Detailed Description
This is the main widget for the viewer.
See the documentation of ViewerPrivate for implementation details. See Mainpage.dox for an overview of the classes in the messageviewer library.
Member Enumeration Documentation
◆ AttachmentAction
◆ DisplayFormatMessage
◆ ResourceOnlineMode
Constructor & Destructor Documentation
◆ Viewer()
|
explicit |
Create a mail viewer widget.
- Parameters
-
parent parent widget widget the application's main widget actionCollection the action collection where the widget's actions will belong to
Definition at line 63 of file viewer.cpp.
Member Function Documentation
◆ addMessageLoadedHandler()
void MessageViewer::Viewer::addMessageLoadedHandler | ( | AbstractMessageLoadedHandler * | handler | ) |
Adds a handler
for actions that will be executed when the message has been loaded into the view.
Definition at line 547 of file viewer.cpp.
◆ atBottom()
void MessageViewer::Viewer::atBottom | ( | ) |
Returns true if the message view is scrolled to the bottom.
Definition at line 247 of file viewer.cpp.
◆ attachmentStrategy()
const AttachmentStrategy * MessageViewer::Viewer::attachmentStrategy | ( | ) | const |
Definition at line 374 of file viewer.cpp.
◆ changeEvent()
Reimplemented from QWidget.
Definition at line 115 of file viewer.cpp.
◆ clear()
void MessageViewer::Viewer::clear | ( | MimeTreeParser::UpdateMode | updateMode = MimeTreeParser::Delayed | ) |
Convenience method to clear the reader and discard the current message.
Sets the internal message pointer returned by message() to 0.
- Parameters
-
updateMode - update the display immediately or not. See UpdateMode.
Definition at line 512 of file viewer.cpp.
◆ closeEvent()
|
overrideprotectedvirtual |
Some necessary event handling.
Reimplemented from QWidget.
Definition at line 210 of file viewer.cpp.
◆ copyAction()
QAction * MessageViewer::Viewer::copyAction | ( | ) | const |
Definition at line 440 of file viewer.cpp.
◆ copyImageLocation()
QAction * MessageViewer::Viewer::copyImageLocation | ( | ) | const |
Definition at line 452 of file viewer.cpp.
◆ copySelectionToClipboard()
void MessageViewer::Viewer::copySelectionToClipboard | ( | ) |
Definition at line 578 of file viewer.cpp.
◆ copyURLAction()
QAction * MessageViewer::Viewer::copyURLAction | ( | ) | const |
Definition at line 434 of file viewer.cpp.
◆ createFetchJob()
Akonadi::ItemFetchJob * MessageViewer::Viewer::createFetchJob | ( | const Akonadi::Item & | item | ) |
Create an item fetch job that is suitable for using to fetch the message item that will be displayed on this viewer.
It will set the correct fetch scope. You still need to connect to the job's result signal.
Definition at line 534 of file viewer.cpp.
◆ cssHelper()
CSSHelper * MessageViewer::Viewer::cssHelper | ( | ) | const |
Definition at line 398 of file viewer.cpp.
◆ deleteMessage()
void MessageViewer::Viewer::deleteMessage | ( | ) |
Initiates a delete, by sending a signal to delete the message item.
Definition at line 566 of file viewer.cpp.
◆ developmentToolsAction()
QAction * MessageViewer::Viewer::developmentToolsAction | ( | ) | const |
Definition at line 641 of file viewer.cpp.
◆ disableEmoticonAction()
KToggleAction * MessageViewer::Viewer::disableEmoticonAction | ( | ) | const |
Definition at line 647 of file viewer.cpp.
◆ displayFormatMessageOverwrite()
Viewer::DisplayFormatMessage MessageViewer::Viewer::displayFormatMessageOverwrite | ( | ) | const |
Get the html override setting.
Definition at line 277 of file viewer.cpp.
◆ displaySplashPage()
void MessageViewer::Viewer::displaySplashPage | ( | const QString & | templateName, |
const QVariantHash & | data, | ||
const QByteArray & | domain = QByteArray() ) |
Display a generic HTML splash page instead of a message.
- Parameters
-
templateName - the template to be loaded data - data for the template domain the domain.
Definition at line 162 of file viewer.cpp.
◆ dkimViewerMenu()
DKIMViewerMenu * MessageViewer::Viewer::dkimViewerMenu | ( | ) |
Definition at line 671 of file viewer.cpp.
◆ dkimWidgetInfo()
MessageViewer::DKIMWidgetInfo * MessageViewer::Viewer::dkimWidgetInfo | ( | ) |
Definition at line 779 of file viewer.cpp.
◆ enableMessageDisplay()
void MessageViewer::Viewer::enableMessageDisplay | ( | ) |
Enable the displaying of messages again after an splash (or other) page was displayed.
Definition at line 168 of file viewer.cpp.
◆ event()
|
overrideprotectedvirtual |
◆ eventFilter()
Reimplemented from QObject.
Definition at line 100 of file viewer.cpp.
◆ exportToPdf()
Definition at line 785 of file viewer.cpp.
◆ findInMessageAction()
QAction * MessageViewer::Viewer::findInMessageAction | ( | ) | const |
Definition at line 608 of file viewer.cpp.
◆ hasMultiMessages()
void MessageViewer::Viewer::hasMultiMessages | ( | bool | messages | ) |
Definition at line 749 of file viewer.cpp.
◆ headerStylePlugin()
HeaderStylePlugin * MessageViewer::Viewer::headerStylePlugin | ( | ) | const |
Definition at line 665 of file viewer.cpp.
◆ htmlLoadExternal()
bool MessageViewer::Viewer::htmlLoadExternal | ( | ) | const |
Is loading ext.
references to be supported? Takes into account override
Definition at line 313 of file viewer.cpp.
◆ htmlLoadExtOverride()
bool MessageViewer::Viewer::htmlLoadExtOverride | ( | ) | const |
Get the load external references override setting.
Definition at line 301 of file viewer.cpp.
◆ htmlMail()
bool MessageViewer::Viewer::htmlMail | ( | ) | const |
Is html mail to be supported? Takes into account override.
Definition at line 307 of file viewer.cpp.
◆ imageUrlClicked()
QUrl MessageViewer::Viewer::imageUrlClicked | ( | ) | const |
Definition at line 494 of file viewer.cpp.
◆ interceptorUrlActions()
QList< QAction * > MessageViewer::Viewer::interceptorUrlActions | ( | const WebEngineViewer::WebHitTestResult & | result | ) | const |
Definition at line 713 of file viewer.cpp.
◆ isFixedFont()
bool MessageViewer::Viewer::isFixedFont | ( | ) | const |
Definition at line 319 of file viewer.cpp.
◆ itemRemoved
|
signal |
Emitted when the item, previously set with setMessageItem, has been removed.
◆ mainWindow()
QWidget * MessageViewer::Viewer::mainWindow | ( | ) |
Definition at line 331 of file viewer.cpp.
◆ mdnWarningAnimatedHide()
void MessageViewer::Viewer::mdnWarningAnimatedHide | ( | ) |
Definition at line 689 of file viewer.cpp.
◆ message()
KMime::Message::Ptr MessageViewer::Viewer::message | ( | ) | const |
Returns the current message displayed in the viewer.
Definition at line 343 of file viewer.cpp.
◆ messageItem()
Akonadi::Item MessageViewer::Viewer::messageItem | ( | ) | const |
Returns the current message item displayed in the viewer.
Definition at line 349 of file viewer.cpp.
◆ messagePath()
QString MessageViewer::Viewer::messagePath | ( | ) | const |
The path to the message in terms of Akonadi collection hierarchy.
Definition at line 150 of file viewer.cpp.
◆ messageTreeModel()
QAbstractItemModel * MessageViewer::Viewer::messageTreeModel | ( | ) | const |
A QAIM tree model of the message structure.
Definition at line 529 of file viewer.cpp.
◆ mimePartTreeIsEmpty()
bool MessageViewer::Viewer::mimePartTreeIsEmpty | ( | ) | const |
Definition at line 410 of file viewer.cpp.
◆ overrideEncoding()
QString MessageViewer::Viewer::overrideEncoding | ( | ) | const |
Definition at line 386 of file viewer.cpp.
◆ popupMenu
|
signal |
The user presses the right mouse button.
'url' may be 0.
◆ print()
void MessageViewer::Viewer::print | ( | ) |
Print the currently displayed message.
Definition at line 192 of file viewer.cpp.
◆ printingMode()
bool MessageViewer::Viewer::printingMode | ( | ) | const |
Definition at line 470 of file viewer.cpp.
◆ printMessage()
void MessageViewer::Viewer::printMessage | ( | const Akonadi::Item & | msg | ) |
Sets a message as the current one and print it immediately.
- Parameters
-
msg the message to display and print
Definition at line 174 of file viewer.cpp.
◆ printPreview()
void MessageViewer::Viewer::printPreview | ( | ) |
Definition at line 186 of file viewer.cpp.
◆ printPreviewMessage()
void MessageViewer::Viewer::printPreviewMessage | ( | const Akonadi::Item & | message | ) |
Definition at line 180 of file viewer.cpp.
◆ readConfig()
void MessageViewer::Viewer::readConfig | ( | ) |
Definition at line 523 of file viewer.cpp.
◆ remoteContentMenu()
RemoteContentMenu * MessageViewer::Viewer::remoteContentMenu | ( | ) | const |
Definition at line 677 of file viewer.cpp.
◆ removeMessageLoadedHandler()
void MessageViewer::Viewer::removeMessageLoadedHandler | ( | AbstractMessageLoadedHandler * | handler | ) |
Removes the handler
for actions that will be executed when the message has been loaded into the view.
Definition at line 559 of file viewer.cpp.
◆ resetMessageDisplayFormatAction()
QAction * MessageViewer::Viewer::resetMessageDisplayFormatAction | ( | ) | const |
Definition at line 635 of file viewer.cpp.
◆ resizeEvent()
|
overrideprotectedvirtual |
Reimplemented from QWidget.
Definition at line 198 of file viewer.cpp.
◆ runJavaScript()
Definition at line 719 of file viewer.cpp.
◆ saveAsAction()
QAction * MessageViewer::Viewer::saveAsAction | ( | ) | const |
Definition at line 458 of file viewer.cpp.
◆ saveMainFrameScreenshotInFile()
Definition at line 653 of file viewer.cpp.
◆ saveMessageDisplayFormatAction()
QAction * MessageViewer::Viewer::saveMessageDisplayFormatAction | ( | ) | const |
Definition at line 629 of file viewer.cpp.
◆ selectAll()
void MessageViewer::Viewer::selectAll | ( | ) |
Definition at line 572 of file viewer.cpp.
◆ selectAllAction()
QAction * MessageViewer::Viewer::selectAllAction | ( | ) | const |
Definition at line 422 of file viewer.cpp.
◆ selectedText()
QString MessageViewer::Viewer::selectedText | ( | ) | const |
Definition at line 271 of file viewer.cpp.
◆ setAttachmentStrategy()
void MessageViewer::Viewer::setAttachmentStrategy | ( | const AttachmentStrategy * | strategy | ) |
Definition at line 380 of file viewer.cpp.
◆ setDecryptMessageOverwrite()
Enforce message decryption.
Definition at line 337 of file viewer.cpp.
◆ setDisplayFormatMessageOverwrite()
void MessageViewer::Viewer::setDisplayFormatMessageOverwrite | ( | Viewer::DisplayFormatMessage | format | ) |
Override default html mail setting.
Definition at line 283 of file viewer.cpp.
◆ setFolderIdentity()
void MessageViewer::Viewer::setFolderIdentity | ( | uint | folderIdentity | ) |
Definition at line 803 of file viewer.cpp.
◆ setHtmlLoadExtDefault()
void MessageViewer::Viewer::setHtmlLoadExtDefault | ( | bool | loadExtDefault | ) |
Default behavior for loading external references.
Use this for specifying the external reference loading behavior as specified in the user settings.
- See also
- setHtmlLoadExtOverride
Definition at line 289 of file viewer.cpp.
◆ setHtmlLoadExtOverride()
void MessageViewer::Viewer::setHtmlLoadExtOverride | ( | bool | loadExtOverride | ) |
Override default load external references setting.
- Warning
- This must only be called when the user has explicitly been asked to retrieve external references!
- See also
- setHtmlLoadExtDefault
Definition at line 295 of file viewer.cpp.
◆ setIdentityManager()
void MessageViewer::Viewer::setIdentityManager | ( | KIdentityManagementCore::IdentityManager * | ident | ) |
Definition at line 797 of file viewer.cpp.
◆ setMessage()
void MessageViewer::Viewer::setMessage | ( | const KMime::Message::Ptr & | message, |
MimeTreeParser::UpdateMode | updateMode = MimeTreeParser::Delayed ) |
Set the message that shall be shown.
- Parameters
-
message - the message to be shown. If 0, an empty page is displayed. updateMode - update the display immediately or not. See UpdateMode.
Definition at line 124 of file viewer.cpp.
◆ setMessageItem()
void MessageViewer::Viewer::setMessageItem | ( | const Akonadi::Item & | item, |
MimeTreeParser::UpdateMode | updateMode = MimeTreeParser::Delayed ) |
Set the Akonadi item that will be displayed.
- Parameters
-
item - the Akonadi item to be displayed. If it doesn't hold a mail (KMime::Message::Ptr as payload data), an empty page is shown. updateMode - update the display immediately or not. See UpdateMode.
Definition at line 133 of file viewer.cpp.
◆ setMessagePart()
void MessageViewer::Viewer::setMessagePart | ( | KMime::Content * | aMsgPart | ) |
Instead of settings a message to be shown sets a message part to be shown.
Definition at line 506 of file viewer.cpp.
◆ setMessagePath()
Set the path to the message in terms of Akonadi collection hierarchy.
Definition at line 156 of file viewer.cpp.
◆ setOverrideEncoding()
Definition at line 392 of file viewer.cpp.
◆ setPluginName()
Definition at line 695 of file viewer.cpp.
◆ setPrintElementBackground()
void MessageViewer::Viewer::setPrintElementBackground | ( | bool | printElementBackground | ) |
Definition at line 725 of file viewer.cpp.
◆ setPrinting()
void MessageViewer::Viewer::setPrinting | ( | bool | enable | ) |
Definition at line 476 of file viewer.cpp.
◆ setShowEncryptionDetails()
void MessageViewer::Viewer::setShowEncryptionDetails | ( | bool | showDetails | ) |
Definition at line 761 of file viewer.cpp.
◆ setShowSignatureDetails()
void MessageViewer::Viewer::setShowSignatureDetails | ( | bool | showDetails | ) |
Definition at line 737 of file viewer.cpp.
◆ setUseFixedFont()
void MessageViewer::Viewer::setUseFixedFont | ( | bool | useFixedFont | ) |
Definition at line 325 of file viewer.cpp.
◆ setWebViewZoomFactor()
void MessageViewer::Viewer::setWebViewZoomFactor | ( | qreal | factor | ) |
Definition at line 773 of file viewer.cpp.
◆ setZoomFactor()
void MessageViewer::Viewer::setZoomFactor | ( | qreal | zoomFactor | ) |
Definition at line 584 of file viewer.cpp.
◆ shareServiceUrlMenu()
KActionMenu * MessageViewer::Viewer::shareServiceUrlMenu | ( | ) | const |
Definition at line 659 of file viewer.cpp.
◆ shareTextAction()
QAction * MessageViewer::Viewer::shareTextAction | ( | ) | const |
Definition at line 614 of file viewer.cpp.
◆ showDevelopmentTools()
void MessageViewer::Viewer::showDevelopmentTools | ( | ) |
Definition at line 791 of file viewer.cpp.
◆ showEncryptionDetails()
bool MessageViewer::Viewer::showEncryptionDetails | ( | ) | const |
Definition at line 743 of file viewer.cpp.
◆ showMdnInformations()
Definition at line 683 of file viewer.cpp.
◆ showMessage
|
signal |
Emitted when the message should be shown in a separate window.
◆ showOpenAttachmentFolderWidget()
Definition at line 701 of file viewer.cpp.
◆ showReader
|
signal |
Emitted when the content should be shown in a separate window.
◆ showSignatureDetails()
bool MessageViewer::Viewer::showSignatureDetails | ( | ) | const |
Definition at line 731 of file viewer.cpp.
◆ showStatusBarMessage
Emitted when a status bar message is shown.
Note that the status bar message is also set to KPIM::BroadcastStatus in addition.
◆ slotAttachmentSaveAll
|
slot |
Definition at line 223 of file viewer.cpp.
◆ slotAttachmentSaveAs
|
slot |
Definition at line 217 of file viewer.cpp.
◆ slotChangeDisplayMail
|
slot |
Definition at line 620 of file viewer.cpp.
◆ slotFind
|
slot |
Definition at line 368 of file viewer.cpp.
◆ slotJumpDown
|
slot |
Definition at line 253 of file viewer.cpp.
◆ slotSaveMessage
|
slot |
Definition at line 229 of file viewer.cpp.
◆ slotScrollDown
|
slot |
Definition at line 241 of file viewer.cpp.
◆ slotScrollNext
|
slot |
Definition at line 265 of file viewer.cpp.
◆ slotScrollPrior
|
slot |
Definition at line 259 of file viewer.cpp.
◆ slotScrollUp
|
slot |
HTML Widget scrollbar and layout handling.
Scrolling always happens in the direction of the slot that is called. I.e. the methods take the absolute value of
Definition at line 235 of file viewer.cpp.
◆ slotShowMessageSource
|
slot |
Definition at line 517 of file viewer.cpp.
◆ slotZoomIn
|
slot |
Definition at line 596 of file viewer.cpp.
◆ slotZoomOut
|
slot |
Definition at line 602 of file viewer.cpp.
◆ slotZoomReset
|
slot |
Definition at line 590 of file viewer.cpp.
◆ speakTextAction()
QAction * MessageViewer::Viewer::speakTextAction | ( | ) | const |
Definition at line 446 of file viewer.cpp.
◆ toggleFixFontAction()
KToggleAction * MessageViewer::Viewer::toggleFixFontAction | ( | ) | const |
Definition at line 404 of file viewer.cpp.
◆ toggleMimePartTreeAction()
KToggleAction * MessageViewer::Viewer::toggleMimePartTreeAction | ( | ) | const |
Definition at line 416 of file viewer.cpp.
◆ update()
void MessageViewer::Viewer::update | ( | MimeTreeParser::UpdateMode | updateMode = MimeTreeParser::Delayed | ) |
Definition at line 500 of file viewer.cpp.
◆ updateShowMultiMessagesButton()
void MessageViewer::Viewer::updateShowMultiMessagesButton | ( | bool | enablePreviousButton, |
bool | enableNextButton ) |
Definition at line 755 of file viewer.cpp.
◆ urlClicked() [1/2]
QUrl MessageViewer::Viewer::urlClicked | ( | ) | const |
Definition at line 488 of file viewer.cpp.
◆ urlClicked [2/2]
|
signal |
The message viewer handles some types of urls itself, most notably http(s) and ftp(s).
When it can't handle the url it will Q_EMIT this signal.
◆ urlOpenAction()
QAction * MessageViewer::Viewer::urlOpenAction | ( | ) | const |
Definition at line 464 of file viewer.cpp.
◆ viewerPluginActionList()
QList< QAction * > MessageViewer::Viewer::viewerPluginActionList | ( | MessageViewer::ViewerPluginInterface::SpecificFeatureTypes | features | ) |
Definition at line 707 of file viewer.cpp.
◆ viewSourceAction()
QAction * MessageViewer::Viewer::viewSourceAction | ( | ) | const |
Definition at line 428 of file viewer.cpp.
◆ webViewZoomFactor()
qreal MessageViewer::Viewer::webViewZoomFactor | ( | ) | const |
Definition at line 767 of file viewer.cpp.
◆ writeConfig()
Definition at line 482 of file viewer.cpp.
Member Data Documentation
◆ d_ptr
|
protected |
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:12:44 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.