MessageViewer::Viewer Class

Header: #include <viewer.h>
CMake: find_package(KPim6MessageViewer REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MessageViewer)

Public Functions

Viewer(QWidget *parent, QWidget *widget = nullptr, KActionCollection *actionCollection = nullptr)
void addMessageLoadedHandler(MessageViewer::AbstractMessageLoadedHandler *handler)
void atBottom()
void clear(MimeTreeParser::UpdateMode updateMode = MimeTreeParser::Delayed)
Akonadi::ItemFetchJob *createFetchJob(const Akonadi::Item &item)
void deleteMessage()
MessageViewer::Viewer::DisplayFormatMessage displayFormatMessageOverwrite() const
void displaySplashPage(const QString &templateName, const QVariantHash &data, const QByteArray &domain = QByteArray())
void enableMessageDisplay()
bool htmlLoadExtOverride() const
bool htmlLoadExternal() const
bool htmlMail() const
std::shared_ptr<KMime::Message> message() const
Akonadi::Item messageItem() const
QString messagePath() const
QAbstractItemModel *messageTreeModel() const
void print()
void printMessage(const Akonadi::Item &msg)
void removeMessageLoadedHandler(MessageViewer::AbstractMessageLoadedHandler *handler)
void setDecryptMessageOverwrite(bool overwrite = true)
void setDisplayFormatMessageOverwrite(MessageViewer::Viewer::DisplayFormatMessage format)
void setHtmlLoadExtDefault(bool loadExtDefault)
void setHtmlLoadExtOverride(bool loadExtOverride)
void setMessage(const std::shared_ptr<KMime::Message> &message, MimeTreeParser::UpdateMode updateMode = MimeTreeParser::Delayed)
void setMessageItem(const Akonadi::Item &item, MimeTreeParser::UpdateMode updateMode = MimeTreeParser::Delayed)
void setMessagePart(KMime::Content *aMsgPart)
void setMessagePath(const QString &path)

Public Slots

void slotAttachmentSaveAll()
void slotAttachmentSaveAs()
void slotChangeDisplayMail(MessageViewer::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()

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 std::shared_ptr<KMime::Message> &message, bool replyToAll)
void requestConfigSync()
void sendResponse(MessageViewer::MDNWarningWidget::ResponseType type, KMime::MDN::SendingMode sendingMode)
void showMessage(const std::shared_ptr<KMime::Message> &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)

Reimplemented Protected Functions

virtual void closeEvent(QCloseEvent *) override
virtual bool event(QEvent *e) override

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 Function Documentation

[explicit] Viewer::Viewer(QWidget *parent, QWidget *widget = nullptr, KActionCollection *actionCollection = nullptr)

Create a mail viewer widget parent parent widget widget the application's main widget actionCollection the action collection where the widget's actions will belong to

void Viewer::addMessageLoadedHandler(MessageViewer::AbstractMessageLoadedHandler *handler)

Adds a handler for actions that will be executed when the message has been loaded into the view.

void Viewer::atBottom()

Returns true if the message view is scrolled to the bottom.

void 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. updateMode - update the display immediately or not. See UpdateMode.

[override virtual protected] void Viewer::closeEvent(QCloseEvent *)

Some necessary event handling.

Akonadi::ItemFetchJob *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.

void Viewer::deleteMessage()

Initiates a delete, by sending a signal to delete the message item

[signal] void Viewer::deleteMessage(const Akonadi::Item &)

Note: This signal is overloaded. To connect to this signal:

// Connect using qOverload:
connect(viewer, qOverload(&Viewer::deleteMessage),
        receiver, &ReceiverClass::slot);

// Or using a lambda:
connect(viewer, qOverload(&Viewer::deleteMessage),
        this, [](const Akonadi::Item &) { /* handle deleteMessage */ });
For more examples and approaches, see connecting to overloaded signals.

MessageViewer::Viewer::DisplayFormatMessage Viewer::displayFormatMessageOverwrite() const

Get the html override setting

See also setDisplayFormatMessageOverwrite().

[signal] void Viewer::displayPopupMenu(const Akonadi::Item &msg, const WebEngineViewer::WebHitTestResult &result, const QPoint &mousePos)

void Viewer::displaySplashPage(const QString &templateName, const QVariantHash &data, const QByteArray &domain = QByteArray())

Display a generic HTML splash page instead of a message. templateName - the template to be loaded data - data for the template domain the domain.

void Viewer::enableMessageDisplay()

Enable the displaying of messages again after an splash (or other) page was displayed

[override virtual protected] bool Viewer::event(QEvent *e)

Watch for palette changes

bool Viewer::htmlLoadExtOverride() const

Get the load external references override setting

See also setHtmlLoadExtOverride().

bool Viewer::htmlLoadExternal() const

Is loading ext. references to be supported? Takes into account override

bool Viewer::htmlMail() const

Is html mail to be supported? Takes into account override

[signal] void Viewer::itemRemoved()

[signal] void Viewer::makeResourceOnline(MessageViewer::Viewer::ResourceOnlineMode mode)

std::shared_ptr<KMime::Message> Viewer::message() const

Returns the current message displayed in the viewer.

See also setMessage().

Akonadi::Item Viewer::messageItem() const

Returns the current message item displayed in the viewer.

See also setMessageItem().

QString Viewer::messagePath() const

The path to the message in terms of Akonadi collection hierarchy.

See also setMessagePath().

QAbstractItemModel *Viewer::messageTreeModel() const

A QAIM tree model of the message structure.

[signal] void Viewer::moveMessageToTrash()

[signal] void Viewer::pageIsScrolledToBottom(bool)

[signal] void Viewer::popupMenu(const Akonadi::Item &msg, const QUrl &url, const QUrl &imageUrl, const QPoint &mousePos)

The user presses the right mouse button. 'url' may be 0.

void Viewer::print()

Print the currently displayed message

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

Sets a message as the current one and print it immediately. msg the message to display and print

[signal] void Viewer::printingFinished()

void Viewer::removeMessageLoadedHandler(MessageViewer::AbstractMessageLoadedHandler *handler)

Removes the handler for actions that will be executed when the message has been loaded into the view.

[signal] void Viewer::replyMessageTo(const std::shared_ptr<KMime::Message> &message, bool replyToAll)

[signal] void Viewer::requestConfigSync()

[signal] void Viewer::sendResponse(MessageViewer::MDNWarningWidget::ResponseType type, KMime::MDN::SendingMode sendingMode)

void Viewer::setDecryptMessageOverwrite(bool overwrite = true)

Enforce message decryption.

void Viewer::setDisplayFormatMessageOverwrite(MessageViewer::Viewer::DisplayFormatMessage format)

Override default html mail setting

See also displayFormatMessageOverwrite().

void 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.

void 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 htmlLoadExtOverride() and setHtmlLoadExtDefault.

void Viewer::setMessage(const std::shared_ptr<KMime::Message> &message, MimeTreeParser::UpdateMode updateMode = MimeTreeParser::Delayed)

Set the message that shall be shown. message - the message to be shown. If 0, an empty page is displayed. updateMode - update the display immediately or not. See UpdateMode.

See also message().

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

Set the Akonadi item that will be displayed. item - the Akonadi item to be displayed. If it doesn't hold a mail (std::shared_ptr<KMime::Message> as payload data), an empty page is shown. updateMode - update the display immediately or not. See UpdateMode.

See also messageItem().

void Viewer::setMessagePart(KMime::Content *aMsgPart)

Instead of settings a message to be shown sets a message part to be shown

void Viewer::setMessagePath(const QString &path)

Set the path to the message in terms of Akonadi collection hierarchy.

See also messagePath().

[signal] void Viewer::showMessage(const std::shared_ptr<KMime::Message> &message, const QString &encoding)

[signal] void Viewer::showNextMessage()

[signal] void Viewer::showPreviousMessage()

[signal] void Viewer::showReader(KMime::Content *aMsgPart, bool aHTML, const QString &encoding)

[signal] void Viewer::showStatusBarMessage(const QString &message)

Emitted when a status bar message is shown. Note that the status bar message is also set to KPIM::BroadcastStatus in addition.

[slot] void Viewer::slotAttachmentSaveAll()

[slot] void Viewer::slotAttachmentSaveAs()

[slot] void Viewer::slotChangeDisplayMail(MessageViewer::Viewer::DisplayFormatMessage, bool)

[slot] void Viewer::slotFind()

[slot] void Viewer::slotJumpDown()

[slot] void Viewer::slotSaveMessage()

[slot] void Viewer::slotScrollDown()

[slot] void Viewer::slotScrollNext()

[slot] void Viewer::slotScrollPrior()

[slot] void Viewer::slotScrollUp()

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

[slot] void Viewer::slotShowMessageSource()

[slot] void Viewer::slotZoomIn()

[slot] void Viewer::slotZoomOut()

[slot] void Viewer::slotZoomReset()

[signal] void Viewer::urlClicked(const Akonadi::Item &, const QUrl &)

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.

Note: This signal is overloaded. To connect to this signal:

// Connect using qOverload:
connect(viewer, qOverload(&Viewer::urlClicked),
        receiver, &ReceiverClass::slot);

// Or using a lambda:
connect(viewer, qOverload(&Viewer::urlClicked),
        this, [](const Akonadi::Item &, const QUrl &) { /* handle urlClicked */ });
For more examples and approaches, see connecting to overloaded signals.

[signal] void Viewer::zoomChanged(qreal zoomFactor)