MessageViewer::Viewer

MessageViewer
Viewer

#include <viewer.h>

Inheritance diagram for MessageViewer::Viewer:

[legend]

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	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 ()

Public Member Functions
	Viewer (QWidget parent, QWidget widget=nullptr, KActionCollection *actionCollection=nullptr)

void	addMessageLoadedHandler (AbstractMessageLoadedHandler *handler)

void	atBottom ()

const AttachmentStrategy *	attachmentStrategy () const

void	clear (MimeTreeParser::UpdateMode updateMode=MimeTreeParser::Delayed)

QAction *	copyAction () const

QAction *	copyImageLocation () const

void	copySelectionToClipboard ()

QAction *	copyURLAction () const

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

CSSHelper *	cssHelper () const

void	deleteMessage ()

QAction *	developmentToolsAction () const

KToggleAction *	disableEmoticonAction () const

Viewer::DisplayFormatMessage	displayFormatMessageOverwrite () const

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

MessageViewer::DKIMViewerMenu *	dkimViewerMenu ()

MessageViewer::DKIMWidgetInfo *	dkimWidgetInfo ()

void	enableMessageDisplay ()

void	exportToPdf (const QString &fileName)

QAction *	findInMessageAction () const

void	hasMultiMessages (bool messages)

HeaderStylePlugin *	headerStylePlugin () const

bool	htmlLoadExternal () const

bool	htmlLoadExtOverride () const

bool	htmlMail () const

QUrl	imageUrlClicked () const

QList< QAction * >	interceptorUrlActions (const WebEngineViewer::WebHitTestResult &result) const

bool	isFixedFont () const

QWidget *	mainWindow ()

MessageViewer::MDNWarningWidget *	mdnWarning () const

KMime::Message::Ptr	message () const

Akonadi::Item	messageItem () const

QString	messagePath () const

QAbstractItemModel *	messageTreeModel () const

bool	mimePartTreeIsEmpty () const

QString	overrideEncoding () const

void	print ()

bool	printingMode () const

void	printMessage (const Akonadi::Item &msg)

void	printPreview ()

void	printPreviewMessage (const Akonadi::Item &message)

void	readConfig ()

MessageViewer::RemoteContentMenu *	remoteContentMenu () const

void	removeMessageLoadedHandler (AbstractMessageLoadedHandler *handler)

QAction *	resetMessageDisplayFormatAction () const

void	runJavaScript (const QString &code)

QAction *	saveAsAction () const

void	saveMainFrameScreenshotInFile (const QString &filename)

QAction *	saveMessageDisplayFormatAction () const

void	selectAll ()

QAction *	selectAllAction () const

QString	selectedText () const

void	setAttachmentStrategy (const AttachmentStrategy *strategy)

void	setDecryptMessageOverwrite (bool overwrite=true)

void	setDisplayFormatMessageOverwrite (Viewer::DisplayFormatMessage format)

void	setFolderIdentity (uint folderIdentity)

void	setHtmlLoadExtDefault (bool loadExtDefault)

void	setHtmlLoadExtOverride (bool loadExtOverride)

void	setIdentityManager (KIdentityManagement::IdentityManager *ident)

void	setMessage (const KMime::Message::Ptr &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)

void	setOverrideEncoding (const QString &encoding)

void	setPluginName (const QString &pluginName)

void	setPrintElementBackground (bool printElementBackground)

void	setPrinting (bool enable)

void	setShowEncryptionDetails (bool showDetails)

void	setShowSignatureDetails (bool showDetails)

void	setUseFixedFont (bool useFixedFont)

void	setWebViewZoomFactor (qreal factor)

void	setZoomFactor (qreal zoomFactor)

KActionMenu *	shareServiceUrlMenu () const

QAction *	shareTextAction () const

void	showDevelopmentTools ()

bool	showEncryptionDetails () const

void	showOpenAttachmentFolderWidget (const QList< QUrl > &urls)

bool	showSignatureDetails () const

QAction *	speakTextAction () const

KToggleAction *	toggleFixFontAction () const

KToggleAction *	toggleMimePartTreeAction () const

void	update (MimeTreeParser::UpdateMode updateMode=MimeTreeParser::Delayed)

void	updateShowMultiMessagesButton (bool enablePreviousButton, bool enableNextButton)

QUrl	urlClicked () const

QAction *	urlOpenAction () const

QList< QAction * >	viewerPluginActionList (MessageViewer::ViewerPluginInterface::SpecificFeatureTypes features)

QAction *	viewSourceAction () const

qreal	webViewZoomFactor () const

void	writeConfig (bool withSync=true)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, Qt::WindowFlags f)

bool	acceptDrops () const const

QString	accessibleDescription () const const

QString	accessibleName () const const

QList< QAction * >	actions () const const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const const

QPalette::ColorRole	backgroundRole () const const

QBackingStore *	backingStore () const const

QSize	baseSize () const const

QWidget *	childAt (const QPoint &p) const const

QWidget *	childAt (int x, int y) const const

QRect	childrenRect () const const

QRegion	childrenRegion () const const

void	clearFocus ()

void	clearMask ()

bool	close ()

QMargins	contentsMargins () const const

QRect	contentsRect () const const

Qt::ContextMenuPolicy	contextMenuPolicy () const const

QCursor	cursor () const const

void	customContextMenuRequested (const QPoint &pos)

WId	effectiveWinId () const const

void	ensurePolished () const const

Qt::FocusPolicy	focusPolicy () const const

QWidget *	focusProxy () const const

QWidget *	focusWidget () const const

const QFont &	font () const const

QFontInfo	fontInfo () const const

QFontMetrics	fontMetrics () const const

QPalette::ColorRole	foregroundRole () const const

QRect	frameGeometry () const const

QSize	frameSize () const const

const QRect &	geometry () const const

void	getContentsMargins (int left, int top, int right, int bottom) const const

QPixmap	grab (const QRect &rectangle)

void	grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const const

QGraphicsProxyWidget *	graphicsProxyWidget () const const

bool	hasEditFocus () const const

bool	hasFocus () const const

virtual bool	hasHeightForWidth () const const

bool	hasMouseTracking () const const

bool	hasTabletTracking () const const

int	height () const const

virtual int	heightForWidth (int w) const const

void	hide ()

Qt::InputMethodHints	inputMethodHints () const const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const const

bool	isAncestorOf (const QWidget *child) const const

bool	isEnabled () const const

bool	isEnabledTo (const QWidget *ancestor) const const

bool	isEnabledToTLW () const const

bool	isFullScreen () const const

bool	isHidden () const const

bool	isMaximized () const const

bool	isMinimized () const const

bool	isModal () const const

bool	isTopLevel () const const

bool	isVisible () const const

bool	isVisibleTo (const QWidget *ancestor) const const

bool	isWindow () const const

bool	isWindowModified () const const

QLayout *	layout () const const

Qt::LayoutDirection	layoutDirection () const const

QLocale	locale () const const

void	lower ()

QPoint	mapFrom (const QWidget *parent, const QPoint &pos) const const

QPoint	mapFromGlobal (const QPoint &pos) const const

QPoint	mapFromParent (const QPoint &pos) const const

QPoint	mapTo (const QWidget *parent, const QPoint &pos) const const

QPoint	mapToGlobal (const QPoint &pos) const const

QPoint	mapToParent (const QPoint &pos) const const

QRegion	mask () const const

int	maximumHeight () const const

QSize	maximumSize () const const

int	maximumWidth () const const

int	minimumHeight () const const

QSize	minimumSize () const const

virtual QSize	minimumSizeHint () const const

int	minimumWidth () const const

void	move (const QPoint &)

void	move (int x, int y)

QWidget *	nativeParentWidget () const const

QWidget *	nextInFocusChain () const const

QRect	normalGeometry () const const

void	overrideWindowFlags (Qt::WindowFlags flags)

virtual QPaintEngine *	paintEngine () const const override

const QPalette &	palette () const const

QWidget *	parentWidget () const const

QPoint	pos () const const

QWidget *	previousInFocusChain () const const

	QWIDGETSIZE_MAX QWIDGETSIZE_MAX

void	raise ()

QRect	rect () const const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)

void	repaint ()

void	repaint (const QRect &rect)

void	repaint (const QRegion &rgn)

void	repaint (int x, int y, int w, int h)

void	resize (const QSize &)

void	resize (int w, int h)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const const

QScreen *	screen () const const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setContentsMargins (const QMargins &margins)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus ()

void	setFocus (Qt::FocusReason reason)

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (const QRect &)

void	setGeometry (int x, int y, int w, int h)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setInputMethodHints (Qt::InputMethodHints hints)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

void	setStyleSheet (const QString &styleSheet)

void	setTabletTracking (bool enable)

void	setToolTip (const QString &)

void	setToolTipDuration (int msec)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlag (Qt::WindowType flag, bool on)

void	setWindowFlags (Qt::WindowFlags type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (Qt::WindowStates windowState)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const const

virtual QSize	sizeHint () const const

QSize	sizeIncrement () const const

QSizePolicy	sizePolicy () const const

void	stackUnder (QWidget *w)

QString	statusTip () const const

QStyle *	style () const const

QString	styleSheet () const const

bool	testAttribute (Qt::WidgetAttribute attribute) const const

QString	toolTip () const const

int	toolTipDuration () const const

QWidget *	topLevelWidget () const const

bool	underMouse () const const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	update ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	updateGeometry ()

bool	updatesEnabled () const const

QRegion	visibleRegion () const const

QString	whatsThis () const const

int	width () const const

QWidget *	window () const const

QString	windowFilePath () const const

Qt::WindowFlags	windowFlags () const const

QWindow *	windowHandle () const const

QIcon	windowIcon () const const

void	windowIconChanged (const QIcon &icon)

QString	windowIconText () const const

void	windowIconTextChanged (const QString &iconText)

Qt::WindowModality	windowModality () const const

qreal	windowOpacity () const const

QString	windowRole () const const

Qt::WindowStates	windowState () const const

QString	windowTitle () const const

void	windowTitleChanged (const QString &title)

Qt::WindowType	windowType () const const

WId	winId () const const

int	x () const const

int	y () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QPaintDevice
int	colorCount () const const

int	depth () const const

int	devicePixelRatio () const const

qreal	devicePixelRatioF () const const

int	height () const const

int	heightMM () const const

int	logicalDpiX () const const

int	logicalDpiY () const const

bool	paintingActive () const const

int	physicalDpiX () const const

int	physicalDpiY () const const

int	width () const const

int	widthMM () const const

Protected Member Functions
void	changeEvent (QEvent *event) override

void	closeEvent (QCloseEvent *) override

bool	event (QEvent *e) override

void	resizeEvent (QResizeEvent *) override

Protected Member Functions inherited from QWidget
virtual void	actionEvent (QActionEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	enterEvent (QEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	initPainter (QPainter *painter) const const override

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual int	metric (QPaintDevice::PaintDeviceMetric m) const const override

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, long result)

virtual void	paintEvent (QPaintEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
ViewerPrivate *const	d_ptr

Additional Inherited Members
Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	tabletTracking

	toolTip

	toolTipDuration

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QWidget
QWidget *	createWindowContainer (QWindow window, QWidget parent, Qt::WindowFlags flags)

QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QWidget
	DrawChildren

	DrawWindowBackground

	IgnoreMask

typedef	RenderFlags

Public Attributes inherited from QObject
typedef	QObjectList

Public Attributes inherited from QPaintDevice
	PdmDepth

	PdmDevicePixelRatio

	PdmDevicePixelRatioScaled

	PdmDpiX

	PdmDpiY

	PdmHeight

	PdmHeightMM

	PdmNumColors

	PdmPhysicalDpiX

	PdmPhysicalDpiY

	PdmWidth

	PdmWidthMM

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.

Definition at line 95 of file viewer.h.

Constructor & Destructor Documentation

◆ Viewer()

MessageViewer::Viewer::Viewer	(	QWidget *	parent,
		QWidget *	widget = `nullptr`,
		KActionCollection *	actionCollection = `nullptr`
	)

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 544 of file viewer.cpp.

◆ atBottom()

void MessageViewer::Viewer::atBottom ( )

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

Definition at line 239 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 509 of file viewer.cpp.

◆ closeEvent()

void MessageViewer::Viewer::closeEvent ( QCloseEvent * e )

overrideprotectedvirtual

Some necessary event handling.

Reimplemented from QWidget.

Definition at line 202 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 531 of file viewer.cpp.

◆ deleteMessage()

void MessageViewer::Viewer::deleteMessage ( )

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

Definition at line 563 of file viewer.cpp.

◆ displayFormatMessageOverwrite()

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

Get the html override setting.

Definition at line 269 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 154 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 160 of file viewer.cpp.

◆ event()

bool MessageViewer::Viewer::event ( QEvent * e )

overrideprotectedvirtual

Watch for palette changes.

Reimplemented from QWidget.

Definition at line 347 of file viewer.cpp.

◆ htmlLoadExternal()

bool MessageViewer::Viewer::htmlLoadExternal ( ) const

Is loading ext.

references to be supported? Takes into account override

Definition at line 305 of file viewer.cpp.

◆ htmlLoadExtOverride()

bool MessageViewer::Viewer::htmlLoadExtOverride ( ) const

Get the load external references override setting.

Definition at line 293 of file viewer.cpp.

◆ htmlMail()

bool MessageViewer::Viewer::htmlMail ( ) const

Is html mail to be supported? Takes into account override.

Definition at line 299 of file viewer.cpp.

◆ itemRemoved

void MessageViewer::Viewer::itemRemoved ( )

signal

Emitted when the item, previously set with setMessageItem, has been removed.

◆ message()

KMime::Message::Ptr MessageViewer::Viewer::message ( ) const

Returns the current message displayed in the viewer.

Definition at line 335 of file viewer.cpp.

◆ messageItem()

Akonadi::Item MessageViewer::Viewer::messageItem ( ) const

Returns the current message item displayed in the viewer.

Definition at line 341 of file viewer.cpp.

◆ messagePath()

QString MessageViewer::Viewer::messagePath ( ) const

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

Definition at line 142 of file viewer.cpp.

◆ messageTreeModel()

QAbstractItemModel * MessageViewer::Viewer::messageTreeModel ( ) const

A QAIM tree model of the message structure.

Definition at line 526 of file viewer.cpp.

◆ popupMenu

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

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 184 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 166 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 556 of file viewer.cpp.

◆ setDecryptMessageOverwrite()

void MessageViewer::Viewer::setDecryptMessageOverwrite ( bool overwrite = true )

Enforce message decryption.

Definition at line 329 of file viewer.cpp.

◆ setDisplayFormatMessageOverwrite()

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

Override default html mail setting.

Definition at line 275 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 281 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 287 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 116 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 125 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 503 of file viewer.cpp.

◆ setMessagePath()

void MessageViewer::Viewer::setMessagePath ( const QString & path )

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

Definition at line 148 of file viewer.cpp.

◆ showMessage

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

signal

Emitted when the message should be shown in a separate window.

◆ showReader

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

signal

Emitted when the content should be shown in a separate window.

◆ showStatusBarMessage

void MessageViewer::Viewer::showStatusBarMessage ( const QString & message )

signal

Emitted when a status bar message is shown.

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

◆ slotScrollUp

void MessageViewer::Viewer::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 227 of file viewer.cpp.

◆ urlClicked

void MessageViewer::Viewer::urlClicked	(	const Akonadi::Item &	,
		const QUrl &
	)

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.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Messagelib

MessageViewer::Viewer

Public Types

Signals

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Viewer()

Member Function Documentation

◆ addMessageLoadedHandler()

◆ atBottom()

◆ clear()

◆ closeEvent()

◆ createFetchJob()

◆ deleteMessage()

◆ displayFormatMessageOverwrite()

◆ displaySplashPage()

◆ enableMessageDisplay()

◆ event()

◆ htmlLoadExternal()

◆ htmlLoadExtOverride()

◆ htmlMail()

◆ itemRemoved

◆ message()

◆ messageItem()

◆ messagePath()

◆ messageTreeModel()

◆ popupMenu

◆ print()

◆ printMessage()

◆ removeMessageLoadedHandler()

◆ setDecryptMessageOverwrite()

◆ setDisplayFormatMessageOverwrite()

◆ setHtmlLoadExtDefault()

◆ setHtmlLoadExtOverride()

◆ setMessage()

◆ setMessageItem()

◆ setMessagePart()

◆ setMessagePath()

◆ showMessage

◆ showReader

◆ showStatusBarMessage

◆ slotScrollUp

◆ urlClicked