• Skip to content
• Skip to link menu

KDE 4.1 API Reference

• KDE API Reference
• kdepim

• Sitemap
• Contact Us

 

kmail

KMReaderWin Class Reference

#include <kmreaderwin.h>

Inheritance diagram for KMReaderWin:

[legend]

List of all members.

---

Detailed Description

This class implements a "reader window", that is a window used for reading or viewing messages.

Definition at line 83 of file kmreaderwin.h.

Public Slots
void	clearCache ()
KMail::CSSHelper *	cssHelper ()
void	selectAll ()
void	slotAddBookmarks ()
void	slotCopySelectedText ()
void	slotDeleteAttachment (partNode *node)
void	slotDocumentChanged ()
void	slotDocumentDone ()
void	slotEditAttachment (partNode *node)
void	slotFind ()
void	slotJumpDown ()
void	slotLevelQuote (int l)
void	slotMailtoAddAddrBook ()
void	slotMailtoCompose ()
void	slotMailtoForward ()
void	slotMailtoOpenAddrBook ()
void	slotMailtoReply ()
void	slotMessageArrived (KMMessage *msg)
void	slotSaveAttachments ()
void	slotSaveMsg ()
void	slotScrollDown ()
void	slotScrollNext ()
void	slotScrollPrior ()
void	slotScrollUp ()
void	slotTextSelected (bool)
void	slotToggleFixedFont ()
void	slotTouchMessage ()
void	slotUrlClicked ()
void	slotUrlCopy ()
void	slotUrlOn (const QString &url)
void	slotUrlOpen (const KUrl &url=KUrl())
void	slotUrlOpen (const KUrl &url, const KParts::OpenUrlArguments &, const KParts::BrowserArguments &)
void	slotUrlPopup (const QString &, const QPoint &mousePos)
void	slotUrlSave ()
void	updateReaderWin ()
Signals
void	noDrag (void)
void	popupMenu (KMMessage &msg, const KUrl &url, const QPoint &mousePos)
void	replaceMsgByUnencryptedVersion ()
void	urlClicked (const KUrl &url, int button)
Public Member Functions
KAction *	addAddrBookAction ()
KAction *	addBookmarksAction ()
bool	atBottom () const
void	atmViewMsg (KMMessagePart *msgPart)
const KMail::AttachmentStrategy *	attachmentStrategy () const
bool	autoDelete (void) const
void	clear (bool force=false)
KAction *	copyAction ()
QString	copyText ()
KAction *	copyURLAction ()
bool	decryptMessage () const
void	displayAboutPage ()
void	displayBusyPage ()
void	displayOfflinePage ()
void	displaySplashPage (const QString &info)
void	emitPopupMenu (const KUrl &url, const QPoint &p)
void	emitUrlClicked (const KUrl &url, int button)
void	enableMsgDisplay ()
const KMail::HeaderStrategy *	headerStrategy () const
const KMail::HeaderStyle *	headerStyle () const
bool	htmlLoadExternal ()
bool	htmlLoadExtOverride () const
bool	htmlMail ()
bool	htmlOverride () const
KHTMLPart *	htmlPart () const
KMail::HtmlWriter *	htmlWriter ()
bool	isFixedFont ()
	KMReaderWin (QWidget *parent, QWidget *mainWindow, KActionCollection *actionCollection, Qt::WindowFlags f=0)
KAction *	mailToComposeAction ()
KAction *	mailToForwardAction ()
KAction *	mailToReplyAction ()
QWidget *	mainWindow ()
KMMessage *	message (KMFolder **folder=0) const
void	objectTreeToDecryptedMsg (partNode *node, QByteArray &resultingData, KMMessage &theMessage, bool weAreReplacingTheRootNode=false, int recCount=0)
KAction *	openAddrBookAction ()
void	openAttachment (int id, const QString &name)
const QTextCodec *	overrideCodec () const
QString	overrideEncoding () const
partNode *	partNodeForId (int id)
partNode *	partNodeFromUrl (const KUrl &url)
virtual void	printMsg (void)
void	readConfig ()
void	saveRelativePosition ()
KAction *	selectAllAction ()
void	setAttachmentStrategy (const KMail::AttachmentStrategy *strategy)
void	setAutoDelete (bool f)
void	setDecryptMessageOverwrite (bool overwrite=true)
void	setHeaderStyleAndStrategy (const KMail::HeaderStyle *style, const KMail::HeaderStrategy *strategy)
void	setHtmlLoadExtOverride (bool override)
void	setHtmlOverride (bool override)
void	setIdOfLastViewedMessage (const QString &msgId)
virtual void	setMsg (KMMessage *msg, bool force=false)
void	setMsgPart (partNode *node)
void	setMsgPart (KMMessagePart *aMsgPart, bool aHTML, const QString &aFileName, const QString &pname)
void	setOverrideEncoding (const QString &encoding)
void	setPrintFont (const QFont &font)
virtual void	setPrinting (bool enable)
void	setShowSignatureDetails (bool showDetails=true)
void	setUpdateAttachment (bool update=true)
void	setUseFixedFont (bool useFixedFont)
void	setWaitingForSerNum (unsigned long serNum)
void	showAttachmentPopup (int id, const QString &name, const QPoint &p)
void	showHideMimeTree (bool isPlainTextTopLevel)
bool	showSignatureDetails () const
KUrl	tempFileUrlFromPartNode (const partNode *node)
KToggleAction *	toggleFixFontAction ()
void	update (bool force=false)
void	update (KMail::Interface::Observable *)
KAction *	urlOpenAction ()
KAction *	urlSaveAsAction ()
void	writeConfig (bool withSync=true) const
virtual	~KMReaderWin ()
Static Public Member Functions
static int	msgPartFromUrl (const KUrl &url)
static QString	newFeaturesMD5 ()
Protected Slots
void	slotAllHeaders ()
void	slotAtmView (int id, const QString &name)
void	slotBriefHeaders ()
void	slotCycleAttachmentStrategy ()
void	slotCycleHeaderStyles ()
void	slotDelayedResize ()
void	slotFancyHeaders ()
void	slotHandleAttachment (int)
void	slotHideAttachments ()
void	slotIconicAttachments ()
void	slotInlineAttachments ()
void	slotLongHeaders ()
void	slotSmartAttachments ()
void	slotStandardHeaders ()
Protected Member Functions
virtual void	closeEvent (QCloseEvent *)
QString	createTempDir (const QString &param=QString())
void	displayMessage ()
virtual bool	event (QEvent *e)
bool	eventFilter (QObject *obj, QEvent *ev)
virtual void	initHtmlWidget (void)
virtual void	parseMsg (KMMessage *msg)
int	pointsToPixel (int pointSize) const
virtual void	removeTempFiles ()
virtual void	resizeEvent (QResizeEvent *)
void	setStyleDependantFrameWidth ()
void	showVCard (KMMessagePart *msgPart)
void	styleChange (QStyle &oldStyle)
QString	writeMessagePartToTempFile (KMMessagePart *msgPart, int partNumber)
QString	writeMsgHeader (KMMessage *aMsg, bool hasVCard=false)
Friends
void	KMMimePartTree::slotContextMenuRequested (const QPoint &)
void	KMMimePartTree::slotItemClicked (QTreeWidgetItem *)
void	KMMimePartTree::slotSaveAs ()
void	KMMimePartTree::startDrag (Qt::DropActions actions)

---

Constructor & Destructor Documentation

KMReaderWin::KMReaderWin	(	QWidget *	parent,
		QWidget *	mainWindow,
		KActionCollection *	actionCollection,
		Qt::WindowFlags	f = 0
	)

Definition at line 454 of file kmreaderwin.cpp.

KMReaderWin::~KMReaderWin

(

)

[virtual]

Definition at line 824 of file kmreaderwin.cpp.

---

Member Function Documentation

KAction* KMReaderWin::addAddrBookAction

(

)

[inline]

Definition at line 237 of file kmreaderwin.h.

KAction* KMReaderWin::addBookmarksAction

(

)

[inline]

Definition at line 244 of file kmreaderwin.h.

bool KMReaderWin::atBottom

(

)

const

Definition at line 2321 of file kmreaderwin.cpp.

void KMReaderWin::atmViewMsg

(

KMMessagePart *

msgPart

)

View message part of type message/RFC822 in extra viewer window.

Definition at line 2058 of file kmreaderwin.cpp.

const KMail::AttachmentStrategy* KMReaderWin::attachmentStrategy

(

)

const [inline]

Get/set the message attachment strategy.

Definition at line 125 of file kmreaderwin.h.

bool KMReaderWin::autoDelete

(

void

)

const [inline]

Get/set auto-delete msg flag.

Definition at line 186 of file kmreaderwin.h.

void KMReaderWin::clear

(

bool

force = false

)

[inline]

Clear the reader and discard the current message.

Definition at line 170 of file kmreaderwin.h.

void KMReaderWin::clearCache

(

)

[slot]

Force update even if message is the same.

Definition at line 1245 of file kmreaderwin.cpp.

void KMReaderWin::closeEvent

(

QCloseEvent *

e

)

[protected, virtual]

Some necessary event handling.

Reimplemented from QWidget.

Definition at line 1819 of file kmreaderwin.cpp.

KAction* KMReaderWin::copyAction

(

)

[inline]

Definition at line 239 of file kmreaderwin.h.

QString KMReaderWin::copyText

(

)

Return selected text.

Definition at line 2365 of file kmreaderwin.cpp.

KAction* KMReaderWin::copyURLAction

(

)

[inline]

Definition at line 241 of file kmreaderwin.h.

QString KMReaderWin::createTempDir

(

const QString &

param = QString()

)

[protected]

Creates a temporary dir for saving attachments, etc.

Will be automatically deleted when another message is viewed.

Parameters:

param

Optional part of the directory name.

Definition at line 1707 of file kmreaderwin.cpp.

KMail::CSSHelper * KMReaderWin::cssHelper

(

)

[slot]

Definition at line 2621 of file kmreaderwin.cpp.

bool KMReaderWin::decryptMessage

(

)

const

Returns wether the message should be decryted.

Definition at line 2626 of file kmreaderwin.cpp.

void KMReaderWin::displayAboutPage

(

)

Display the about page instead of a message.

Definition at line 1330 of file kmreaderwin.cpp.

void KMReaderWin::displayBusyPage

(

)

Display the 'please wait' page instead of a message.

Definition at line 1311 of file kmreaderwin.cpp.

void KMReaderWin::displayMessage

(

)

[protected]

Feeds the HTML viewer with the contents of the given message.

HTML begin/end parts are written around the message.

Definition at line 1461 of file kmreaderwin.cpp.

void KMReaderWin::displayOfflinePage

(

)

Display the 'we are currently in offline mode' page instead of a message.

Definition at line 1319 of file kmreaderwin.cpp.

void KMReaderWin::displaySplashPage

(

const QString &

info

)

Display a generic HTML splash page instead of a message.

Definition at line 1287 of file kmreaderwin.cpp.

void KMReaderWin::emitPopupMenu	(	const KUrl &	url,
		const QPoint &	p
	)			[inline]

Definition at line 280 of file kmreaderwin.h.

void KMReaderWin::emitUrlClicked	(	const KUrl &	url,
		int	button
	)			[inline]

Definition at line 276 of file kmreaderwin.h.

void KMReaderWin::enableMsgDisplay

(

)

Enable the displaying of messages again after an URL was displayed.

Definition at line 1398 of file kmreaderwin.cpp.

bool KMReaderWin::event

(

QEvent *

e

)

[protected, virtual]

Watch for palette changes.

Reimplemented from QWidget.

Definition at line 908 of file kmreaderwin.cpp.

bool KMReaderWin::eventFilter	(	QObject *	obj,
		QEvent *	ev
	)			[protected]

Event filter.

Definition at line 2578 of file kmreaderwin.cpp.

const KMail::HeaderStrategy* KMReaderWin::headerStrategy

(

)

const [inline]

Getthe message header strategy.

Definition at line 120 of file kmreaderwin.h.

const KMail::HeaderStyle* KMReaderWin::headerStyle

(

)

const [inline]

Definition at line 111 of file kmreaderwin.h.

bool KMReaderWin::htmlLoadExternal

(

)

Is loading ext.

references to be supported? Takes into account override

Definition at line 2398 of file kmreaderwin.cpp.

bool KMReaderWin::htmlLoadExtOverride

(

)

const [inline]

Override default load external references setting.

Definition at line 194 of file kmreaderwin.h.

bool KMReaderWin::htmlMail

(

)

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

Definition at line 2392 of file kmreaderwin.cpp.

bool KMReaderWin::htmlOverride

(

)

const [inline]

Override default html mail setting.

Definition at line 190 of file kmreaderwin.h.

KHTMLPart* KMReaderWin::htmlPart

(

)

const [inline]

Access to the KHTMLPart used for the viewer.

Use with care!

Definition at line 269 of file kmreaderwin.h.

KMail::HtmlWriter* KMReaderWin::htmlWriter

(

)

[inline]

Return the HtmlWriter connected to the KHTMLPart we use.

Definition at line 229 of file kmreaderwin.h.

void KMReaderWin::initHtmlWidget

(

void

)

[protected, virtual]

HTML initialization.

Definition at line 1036 of file kmreaderwin.cpp.

bool KMReaderWin::isFixedFont

(

)

[inline]

Definition at line 225 of file kmreaderwin.h.

KAction* KMReaderWin::mailToComposeAction

(

)

[inline]

Definition at line 234 of file kmreaderwin.h.

KAction* KMReaderWin::mailToForwardAction

(

)

[inline]

Definition at line 236 of file kmreaderwin.h.

KAction* KMReaderWin::mailToReplyAction

(

)

[inline]

Definition at line 235 of file kmreaderwin.h.

QWidget* KMReaderWin::mainWindow

(

)

[inline]

Definition at line 291 of file kmreaderwin.h.

KMMessage * KMReaderWin::message

(

KMFolder **

folder = 0

)

const

Returns the current message or 0 if none.

Definition at line 2423 of file kmreaderwin.cpp.

int KMReaderWin::msgPartFromUrl

(

const KUrl &

url

)

[static]

Returns id of message part from given URL or -1 if invalid.

Definition at line 1747 of file kmreaderwin.cpp.

QString KMReaderWin::newFeaturesMD5

(

)

[static]

Returns the MD5 hash for the list of new features.

Definition at line 1275 of file kmreaderwin.cpp.

void KMReaderWin::noDrag

(

void

)

[signal]

Pgp displays a password dialog.

void KMReaderWin::objectTreeToDecryptedMsg	(	partNode *	node,
		QByteArray &	resultingData,
		KMMessage &	theMessage,
		bool	weAreReplacingTheRootNode = false,
		int	recCount = 0
	)

Definition at line 165 of file kmreaderwin.cpp.

KAction* KMReaderWin::openAddrBookAction

(

)

[inline]

Definition at line 238 of file kmreaderwin.h.

void KMReaderWin::openAttachment	(	int	id,
		const QString &	name
	)

Definition at line 2220 of file kmreaderwin.cpp.

const QTextCodec * KMReaderWin::overrideCodec

(

)

const

Get codec corresponding to the currently selected override character encoding.

Returns:

The override codec or 0 if auto-detection is selected.

Definition at line 1122 of file kmreaderwin.cpp.

QString KMReaderWin::overrideEncoding

(

)

const [inline]

Get selected override character encoding.

Returns:

The encoding selected by the user or an empty string if auto-detection is selected.

Definition at line 133 of file kmreaderwin.h.

void KMReaderWin::parseMsg

(

KMMessage *

msg

)

[protected, virtual]

Parse given message and add it's contents to the reader window.

Definition at line 1495 of file kmreaderwin.cpp.

partNode * KMReaderWin::partNodeForId

(

int

id

)

Definition at line 2535 of file kmreaderwin.cpp.

partNode * KMReaderWin::partNodeFromUrl

(

const KUrl &

url

)

Returns message part from given URL or null if invalid.

Definition at line 2531 of file kmreaderwin.cpp.

int KMReaderWin::pointsToPixel

(

int

pointSize

)

const [protected]

Calculate the pixel size.

Definition at line 1443 of file kmreaderwin.cpp.

void KMReaderWin::popupMenu	(	KMMessage &	msg,
		const KUrl &	url,
		const QPoint &	mousePos
	)			[signal]

The user presses the right mouse button.

'url' may be 0.

void KMReaderWin::printMsg

(

void

)

[virtual]

Print current message.

Definition at line 1739 of file kmreaderwin.cpp.

void KMReaderWin::readConfig

(

void

)

Read settings from app's config file.

Definition at line 924 of file kmreaderwin.cpp.

void KMReaderWin::removeTempFiles

(

)

[protected, virtual]

Cleanup the attachment temp files.

Definition at line 890 of file kmreaderwin.cpp.

void KMReaderWin::replaceMsgByUnencryptedVersion

(

)

[signal]

Emitted after parsing of a message to have it stored in unencrypted state in it's folder.

void KMReaderWin::resizeEvent

(

QResizeEvent *

)

[protected, virtual]

Reimplemented from QWidget.

Definition at line 1764 of file kmreaderwin.cpp.

void KMReaderWin::saveRelativePosition

(

)

Saves the relative position of the scroll view.

Call this before calling update() if you want to preserve the current view.

Definition at line 2405 of file kmreaderwin.cpp.

void KMReaderWin::selectAll

(

)

[slot]

Select message body.

Definition at line 2359 of file kmreaderwin.cpp.

KAction* KMReaderWin::selectAllAction

(

)

[inline]

Definition at line 240 of file kmreaderwin.h.

void KMReaderWin::setAttachmentStrategy

(

const KMail::AttachmentStrategy *

strategy

)

Definition at line 1070 of file kmreaderwin.cpp.

void KMReaderWin::setAutoDelete

(

bool

f

)

[inline]

Definition at line 187 of file kmreaderwin.h.

void KMReaderWin::setDecryptMessageOverwrite

(

bool

overwrite = true

)

[inline]

Enforce message decryption.

Definition at line 297 of file kmreaderwin.h.

void KMReaderWin::setHeaderStyleAndStrategy	(	const KMail::HeaderStyle *	style,
		const KMail::HeaderStrategy *	strategy
	)

Set the header style and strategy.

We only want them to be set together.

Definition at line 1075 of file kmreaderwin.cpp.

void KMReaderWin::setHtmlLoadExtOverride

(

bool

override

)

Definition at line 2386 of file kmreaderwin.cpp.

void KMReaderWin::setHtmlOverride

(

bool

override

)

Definition at line 2377 of file kmreaderwin.cpp.

void KMReaderWin::setIdOfLastViewedMessage

(

const QString &

msgId

)

[inline]

Store message id of last viewed message, normally no need to call this function directly, since correct value is set automatically in parseMsg(KMMessage* aMsg, bool onlyProcessHeaders).

Definition at line 166 of file kmreaderwin.h.

void KMReaderWin::setMsg	(	KMMessage *	msg,
		bool	force = false
	)			[virtual]

Set the message that shall be shown.

If msg is 0, an empty page is displayed.

Definition at line 1153 of file kmreaderwin.cpp.

void KMReaderWin::setMsgPart

(

partNode *

node

)

Definition at line 2075 of file kmreaderwin.cpp.

void KMReaderWin::setMsgPart	(	KMMessagePart *	aMsgPart,
		bool	aHTML,
		const QString &	aFileName,
		const QString &	pname
	)

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

Definition at line 2091 of file kmreaderwin.cpp.

void KMReaderWin::setOverrideEncoding

(

const QString &

encoding

)

Set the override character encoding.

Definition at line 1083 of file kmreaderwin.cpp.

void KMReaderWin::setPrintFont

(

const QFont &

font

)

Definition at line 1115 of file kmreaderwin.cpp.

virtual void KMReaderWin::setPrinting

(

bool

enable

)

[inline, virtual]

Set printing mode.

Definition at line 145 of file kmreaderwin.h.

void KMReaderWin::setShowSignatureDetails

(

bool

showDetails = true

)

[inline]

Show signature details.

Definition at line 303 of file kmreaderwin.h.

void KMReaderWin::setStyleDependantFrameWidth

(

)

[protected]

Set the width of the frame to a reasonable value for the current GUI style.

Definition at line 1977 of file kmreaderwin.cpp.

void KMReaderWin::setUpdateAttachment

(

bool

update = true

)

[inline]

Definition at line 265 of file kmreaderwin.h.

void KMReaderWin::setUseFixedFont

(

bool

useFixedFont

)

[inline]

Definition at line 226 of file kmreaderwin.h.

void KMReaderWin::setWaitingForSerNum

(

unsigned long

serNum

)

[inline]

Set the serial number of the message this reader window is currently waiting for.

Used to discard updates for already deselected messages.

Definition at line 289 of file kmreaderwin.h.

void KMReaderWin::showAttachmentPopup	(	int	id,
		const QString &	name,
		const QPoint &	p
	)

Definition at line 1922 of file kmreaderwin.cpp.

void KMReaderWin::showHideMimeTree

(

bool

isPlainTextTopLevel

)

Show or hide the Mime Tree Viewer if configuration is set to smart mode.

Definition at line 1449 of file kmreaderwin.cpp.

bool KMReaderWin::showSignatureDetails

(

)

const [inline]

Show signature details.

Definition at line 300 of file kmreaderwin.h.

void KMReaderWin::showVCard

(

KMMessagePart *

msgPart

)

[protected]

show window containing infos about a vCard.

Definition at line 1730 of file kmreaderwin.cpp.

void KMReaderWin::slotAddBookmarks

(

)

[slot]

Definition at line 2509 of file kmreaderwin.cpp.

void KMReaderWin::slotAllHeaders

(

)

[protected, slot]

Definition at line 756 of file kmreaderwin.cpp.

void KMReaderWin::slotAtmView	(	int	id,
		const QString &	name
	)			[protected, slot]

Some attachment operations.

Definition at line 2192 of file kmreaderwin.cpp.

void KMReaderWin::slotBriefHeaders

(

)

[protected, slot]

Definition at line 741 of file kmreaderwin.cpp.

void KMReaderWin::slotCopySelectedText

(

)

[slot]

Copy the selected text to the clipboard.

Definition at line 2051 of file kmreaderwin.cpp.