KMReaderWin Class Reference

#include <kmreaderwin.h>

Inheritance diagram for KMReaderWin:

Public Slots
void	clearCache ()
void	contactStored (const Akonadi::Item &item)
void	slotAddBookmarks ()
void	slotContactEditorError (const QString &error)
void	slotContactHtmlOptions ()
void	slotCopySelectedText ()
void	slotDeleteMessage (const Akonadi::Item &)
void	slotEditContact ()
void	slotFind ()
void	slotMailtoAddAddrBook ()
void	slotMailtoCompose ()
void	slotMailtoForward ()
void	slotMailtoOpenAddrBook ()
void	slotMailtoReply ()
void	slotPrintComposeResult (KJob *job)
void	slotSaveImageOnDisk ()
void	slotShareImage ()
void	slotShowMessage (KMime::Message::Ptr message, const QString &encoding)
void	slotShowReader (KMime::Content *, bool, const QString &)
void	slotUrlClicked (const Akonadi::Item &, const KUrl &)
void	slotUrlSave ()

Signals
void	replaceMsgByUnencryptedVersion ()
void	showStatusBarMessage (const QString &message)

Public Member Functions
	KMReaderWin (QWidget *parent, QWidget *mainWindow, KActionCollection *actionCollection, Qt::WindowFlags f=0)
virtual	~KMReaderWin ()
bool	adblockEnabled () const
KAction *	addAddrBookAction () const
KAction *	addBookmarksAction () const
const MessageViewer::AttachmentStrategy *	attachmentStrategy () const
KAction *	blockImage () const
void	clear (bool force=false)
void	clearContactItem ()
KAction *	copyAction () const
KAction *	copyImageLocation () const
QString	copyText () const
KAction *	copyURLAction () const
MessageViewer::CSSHelper *	cssHelper () const
void	displayAboutPage ()
void	displayBusyPage ()
void	displayOfflinePage ()
void	displayResourceOfflinePage ()
void	displaySplashPage (const QString &info)
KAction *	downloadImageToDiskAction () const
KAction *	editContactAction () const
KAction *	expandShortUrlAction () const
KAction *	findInMessageAction () const
const MessageViewer::HeaderStrategy *	headerStrategy () const
MessageViewer::HeaderStyle *	headerStyle () const
bool	htmlLoadExternal ()
bool	htmlLoadExtOverride () const
bool	htmlMail () const
bool	htmlOverride () const
bool	isAShortUrl (const KUrl &url) const
bool	isFixedFont () const
KAction *	mailToComposeAction () const
KAction *	mailToForwardAction () const
KAction *	mailToReplyAction () const
QWidget *	mainWindow ()
Akonadi::Item	message () const
KAction *	openAddrBookAction () const
KAction *	openBlockableItems () const
QString	overrideEncoding () const
bool	printSelectedText (bool preview)
void	readConfig ()
KAction *	resetMessageDisplayFormatAction () const
KAction *	saveAsAction () const
KAction *	saveMessageDisplayFormatAction () const
KAction *	selectAllAction () const
void	setAttachmentStrategy (const MessageViewer::AttachmentStrategy *strategy)
void	setContactItem (const Akonadi::Item &contact, const KABC::Addressee &address)
void	setDecryptMessageOverwrite (bool overwrite=true)
void	setHeaderStyleAndStrategy (MessageViewer::HeaderStyle *style, MessageViewer::HeaderStrategy *strategy)
void	setHtmlLoadExtOverride (bool override)
void	setHtmlOverride (bool override)
void	setMessage (const Akonadi::Item &item, MessageViewer::Viewer::UpdateMode updateMode=MessageViewer::Viewer::Delayed)
void	setMessage (KMime::Message::Ptr message)
void	setMsgPart (KMime::Content *aMsgPart)
void	setOverrideEncoding (const QString &encoding)
virtual void	setPrinting (bool enable)
void	setUseFixedFont (bool useFixedFont)
KAction *	shareImage () const
KAction *	speakTextAction () const
KToggleAction *	toggleFixFontAction () const
KAction *	toggleMimePartTreeAction () const
KAction *	translateAction () const
void	update (bool force=false)
KAction *	urlOpenAction () const
KAction *	urlSaveAsAction () const
MessageViewer::Viewer *	viewer ()
KMenu *	viewHtmlOption () const
KAction *	viewSourceAction () const

Static Public Member Functions
static QString	newFeaturesMD5 ()

Protected Member Functions
KUrl	imageUrlClicked () const
KUrl	urlClicked () const

Detailed Description

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

Definition at line 50 of file kmreaderwin.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 99 of file kmreaderwin.cpp.

KMReaderWin::~KMReaderWin ( )

virtual

Definition at line 256 of file kmreaderwin.cpp.

Member Function Documentation

bool KMReaderWin::adblockEnabled

(

)

const

Definition at line 863 of file kmreaderwin.cpp.

KAction* KMReaderWin::addAddrBookAction ( ) const

inline

Definition at line 136 of file kmreaderwin.h.

KAction* KMReaderWin::addBookmarksAction ( ) const

inline

Definition at line 144 of file kmreaderwin.h.

const AttachmentStrategy * KMReaderWin::attachmentStrategy

(

)

const

Get/set the message attachment strategy.

Definition at line 572 of file kmreaderwin.cpp.

KAction * KMReaderWin::blockImage

(

)

const

Definition at line 858 of file kmreaderwin.cpp.

void KMReaderWin::clear

(

bool

force = false

)

Clear the reader and discard the current message.

Definition at line 661 of file kmreaderwin.cpp.

void KMReaderWin::clearCache ( )

slot

Force update even if message is the same.

Definition at line 282 of file kmreaderwin.cpp.

void KMReaderWin::clearContactItem

(

)

Definition at line 774 of file kmreaderwin.cpp.

void KMReaderWin::contactStored ( const Akonadi::Item &  item )

slot

Definition at line 842 of file kmreaderwin.cpp.

KAction * KMReaderWin::copyAction

(

)

const

Definition at line 617 of file kmreaderwin.cpp.

KAction * KMReaderWin::copyImageLocation

(

)

const

Definition at line 612 of file kmreaderwin.cpp.

QString KMReaderWin::copyText

(

)

const

Return selected text.

Definition at line 443 of file kmreaderwin.cpp.

KAction * KMReaderWin::copyURLAction

(

)

const

Definition at line 607 of file kmreaderwin.cpp.

CSSHelper * KMReaderWin::cssHelper

(

)

const

Definition at line 559 of file kmreaderwin.cpp.

void KMReaderWin::displayAboutPage

(

)

Display the about page instead of a message.

Definition at line 358 of file kmreaderwin.cpp.

void KMReaderWin::displayBusyPage

(

)

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

Definition at line 330 of file kmreaderwin.cpp.

void KMReaderWin::displayOfflinePage

(

)

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

Definition at line 338 of file kmreaderwin.cpp.

void KMReaderWin::displayResourceOfflinePage

(

)

Definition at line 347 of file kmreaderwin.cpp.

void KMReaderWin::displaySplashPage

(

const QString &

info

)

Display a generic HTML splash page instead of a message.

Definition at line 325 of file kmreaderwin.cpp.

KAction * KMReaderWin::downloadImageToDiskAction

(

)

const

Definition at line 651 of file kmreaderwin.cpp.

KAction* KMReaderWin::editContactAction ( ) const

inline

Definition at line 158 of file kmreaderwin.h.

KAction * KMReaderWin::expandShortUrlAction

(

)

const

Definition at line 885 of file kmreaderwin.cpp.

KAction * KMReaderWin::findInMessageAction

(

)

const

Definition at line 632 of file kmreaderwin.cpp.

const HeaderStrategy * KMReaderWin::headerStrategy

(

)

const

Getthe message header strategy.

Definition at line 597 of file kmreaderwin.cpp.

HeaderStyle * KMReaderWin::headerStyle

(

)

const

Definition at line 602 of file kmreaderwin.cpp.

bool KMReaderWin::htmlLoadExternal

(

)

Is loading ext.

references to be supported? Takes into account override

Definition at line 472 of file kmreaderwin.cpp.

bool KMReaderWin::htmlLoadExtOverride

(

)

const

Override default load external references setting.

Definition at line 564 of file kmreaderwin.cpp.

bool KMReaderWin::htmlMail

(

)

const

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

Definition at line 466 of file kmreaderwin.cpp.

bool KMReaderWin::htmlOverride

(

)

const

Override default html mail setting.

Definition at line 454 of file kmreaderwin.cpp.

KUrl KMReaderWin::imageUrlClicked ( ) const

protected

Definition at line 683 of file kmreaderwin.cpp.

bool KMReaderWin::isAShortUrl

(

const KUrl &

url

)

const

Definition at line 880 of file kmreaderwin.cpp.

bool KMReaderWin::isFixedFont

(

)

const

Definition at line 250 of file kmreaderwin.cpp.

KAction* KMReaderWin::mailToComposeAction ( ) const

inline

Definition at line 133 of file kmreaderwin.h.

KAction* KMReaderWin::mailToForwardAction ( ) const

inline

Definition at line 135 of file kmreaderwin.h.

KAction* KMReaderWin::mailToReplyAction ( ) const

inline

Definition at line 134 of file kmreaderwin.h.

QWidget* KMReaderWin::mainWindow ( )

inline

Definition at line 165 of file kmreaderwin.h.

Akonadi::Item KMReaderWin::message

(

)

const

Definition at line 478 of file kmreaderwin.cpp.

QString KMReaderWin::newFeaturesMD5 ( )

static

Returns the MD5 hash for the list of new features.

Definition at line 313 of file kmreaderwin.cpp.

KAction* KMReaderWin::openAddrBookAction ( ) const

inline

Definition at line 137 of file kmreaderwin.h.

KAction * KMReaderWin::openBlockableItems

(

)

const

Definition at line 868 of file kmreaderwin.cpp.

QString KMReaderWin::overrideEncoding

(

)

const

Get selected override character encoding.

Returns

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

Definition at line 577 of file kmreaderwin.cpp.

bool KMReaderWin::printSelectedText

(

bool

preview

)

Definition at line 726 of file kmreaderwin.cpp.

void KMReaderWin::readConfig

(

void

)

Read settings from app's config file.

Definition at line 262 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.

KAction * KMReaderWin::resetMessageDisplayFormatAction

(

)

const

Definition at line 853 of file kmreaderwin.cpp.

KAction * KMReaderWin::saveAsAction

(

)

const

Definition at line 627 of file kmreaderwin.cpp.

KAction * KMReaderWin::saveMessageDisplayFormatAction

(

)

const

Definition at line 848 of file kmreaderwin.cpp.

KAction * KMReaderWin::selectAllAction

(

)

const

Definition at line 592 of file kmreaderwin.cpp.

void KMReaderWin::setAttachmentStrategy

(

const MessageViewer::AttachmentStrategy *

strategy

)

Definition at line 267 of file kmreaderwin.cpp.

void KMReaderWin::setContactItem	(	const Akonadi::Item &	contact,
		const KABC::Addressee &	address
	)

Definition at line 782 of file kmreaderwin.cpp.

void KMReaderWin::setDecryptMessageOverwrite

(

bool

overwrite = true

)

Enforce message decryption.

Definition at line 568 of file kmreaderwin.cpp.

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

Set the header style and strategy.

We only want them to be set together.

Definition at line 271 of file kmreaderwin.cpp.

void KMReaderWin::setHtmlLoadExtOverride

(

bool

override

)

Definition at line 460 of file kmreaderwin.cpp.

void KMReaderWin::setHtmlOverride

(

bool

override

)

Definition at line 449 of file kmreaderwin.cpp.

void KMReaderWin::setMessage	(	const Akonadi::Item &	item,
		MessageViewer::Viewer::UpdateMode	updateMode = MessageViewer::Viewer::Delayed
	)

void KMReaderWin::setMessage

(

KMime::Message::Ptr

message

)

Definition at line 672 of file kmreaderwin.cpp.

void KMReaderWin::setMsgPart

(

KMime::Content *

aMsgPart

)

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

Definition at line 437 of file kmreaderwin.cpp.

void KMReaderWin::setOverrideEncoding

(

const QString &

encoding

)

Set the override character encoding.

Definition at line 276 of file kmreaderwin.cpp.

void KMReaderWin::setPrinting ( bool  enable )

virtual

Definition at line 641 of file kmreaderwin.cpp.

void KMReaderWin::setUseFixedFont

(

bool

useFixedFont

)

Definition at line 245 of file kmreaderwin.cpp.

KAction* KMReaderWin::shareImage ( ) const

inline

Definition at line 161 of file kmreaderwin.h.

void KMReaderWin::showStatusBarMessage ( const QString &  message )

signal

void KMReaderWin::slotAddBookmarks ( )

slot

Definition at line 523 of file kmreaderwin.cpp.

void KMReaderWin::slotContactEditorError ( const QString &  error )

slot

Definition at line 837 of file kmreaderwin.cpp.

void KMReaderWin::slotContactHtmlOptions ( )

slot

Definition at line 808 of file kmreaderwin.cpp.

void KMReaderWin::slotCopySelectedText ( )

slot

Copy the selected text to the clipboard.

Definition at line 429 of file kmreaderwin.cpp.

void KMReaderWin::slotDeleteMessage ( const Akonadi::Item &  item )

slot

Definition at line 718 of file kmreaderwin.cpp.

void KMReaderWin::slotEditContact ( )

slot

Definition at line 822 of file kmreaderwin.cpp.

void KMReaderWin::slotFind ( )

slot

The user selected "Find" from the menu.

Definition at line 424 of file kmreaderwin.cpp.

void KMReaderWin::slotMailtoAddAddrBook ( )

slot

Definition at line 499 of file kmreaderwin.cpp.

void KMReaderWin::slotMailtoCompose ( )

slot

Definition at line 484 of file kmreaderwin.cpp.

void KMReaderWin::slotMailtoForward ( )

slot

Definition at line 491 of file kmreaderwin.cpp.

void KMReaderWin::slotMailtoOpenAddrBook ( )

slot

Definition at line 511 of file kmreaderwin.cpp.

void KMReaderWin::slotMailtoReply ( )

slot

Operations on mailto: URLs.

Definition at line 552 of file kmreaderwin.cpp.

void KMReaderWin::slotPrintComposeResult ( KJob *  job )

slot

Definition at line 746 of file kmreaderwin.cpp.

void KMReaderWin::slotSaveImageOnDisk ( )

slot

Definition at line 542 of file kmreaderwin.cpp.

void KMReaderWin::slotShareImage ( )

slot

Definition at line 874 of file kmreaderwin.cpp.

void KMReaderWin::slotShowMessage ( KMime::Message::Ptr  message, const QString &  encoding  )

slot

Definition at line 711 of file kmreaderwin.cpp.

void KMReaderWin::slotShowReader ( KMime::Content *  msgPart, bool  htmlMail, const QString &  encoding  )

slot

Definition at line 705 of file kmreaderwin.cpp.

void KMReaderWin::slotUrlClicked ( const Akonadi::Item &  item, const KUrl &  url  )

slot

Definition at line 693 of file kmreaderwin.cpp.

void KMReaderWin::slotUrlSave ( )

slot

Save the page to a file.

Definition at line 533 of file kmreaderwin.cpp.

KAction * KMReaderWin::speakTextAction

(

)

const

Definition at line 646 of file kmreaderwin.cpp.

KToggleAction * KMReaderWin::toggleFixFontAction

(

)

const

Definition at line 582 of file kmreaderwin.cpp.

KAction * KMReaderWin::toggleMimePartTreeAction

(

)

const

Definition at line 587 of file kmreaderwin.cpp.

KAction * KMReaderWin::translateAction

(

)

const

Definition at line 656 of file kmreaderwin.cpp.

void KMReaderWin::update

(

bool

force = false

)

Definition at line 688 of file kmreaderwin.cpp.

KUrl KMReaderWin::urlClicked ( ) const

protected

Definition at line 678 of file kmreaderwin.cpp.

KAction * KMReaderWin::urlOpenAction

(

)

const

Definition at line 637 of file kmreaderwin.cpp.

KAction* KMReaderWin::urlSaveAsAction ( ) const

inline

Definition at line 143 of file kmreaderwin.h.

MessageViewer::Viewer* KMReaderWin::viewer ( )

inline

Definition at line 131 of file kmreaderwin.h.

KMenu* KMReaderWin::viewHtmlOption ( ) const

inline

Definition at line 160 of file kmreaderwin.h.

KAction * KMReaderWin::viewSourceAction

(

)

const

Definition at line 622 of file kmreaderwin.cpp.

---

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

• kmreaderwin.h
• kmreaderwin.cpp