kmail

KMReaderWin Class Reference

#include <kmreaderwin.h>

Inheritance diagram for KMReaderWin:

KMail::Interface::Observer 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 73 of file kmreaderwin.h.


Public Slots

void selectAll ()
void clearCache ()
void updateReaderWin ()
void slotScrollUp ()
void slotScrollDown ()
void slotScrollPrior ()
void slotScrollNext ()
void slotJumpDown ()
void slotDocumentChanged ()
void slotDocumentDone ()
void slotTextSelected (bool)
void slotUrlOpen (const KURL &url, const KParts::URLArgs &args)
void slotUrlOn (const QString &url)
void slotUrlPopup (const QString &, const QPoint &mousePos)
void slotFind ()
void slotFindNext ()
void slotToggleFixedFont ()
void slotCopySelectedText ()
void slotUrlClicked ()
void slotMailtoReply ()
void slotMailtoCompose ()
void slotMailtoForward ()
void slotMailtoAddAddrBook ()
void slotMailtoOpenAddrBook ()
void slotUrlCopy ()
void slotUrlOpen (const KURL &url=KURL())
void slotUrlSave ()
void slotAddBookmarks ()
void slotSaveMsg ()
void slotSaveAttachments ()
void slotMessageArrived (KMMessage *msg)
void slotIMChat ()
void contactStatusChanged (const QString &uid)
void slotLevelQuote (int l)
void slotTouchMessage ()
void slotDeleteAttachment (partNode *node)
void slotEditAttachment (partNode *node)
KMail::CSSHelper * cssHelper ()

Signals

void replaceMsgByUnencryptedVersion ()
void popupMenu (KMMessage &msg, const KURL &url, const QPoint &mousePos)
void urlClicked (const KURL &url, int button)
void noDrag (void)

Public Member Functions

 KMReaderWin (QWidget *parent, QWidget *mainWindow, KActionCollection *actionCollection, const char *name=0, int f=0)
virtual ~KMReaderWin ()
void update (KMail::Interface::Observable *)
void readConfig ()
void writeConfig (bool withSync=true) const
const KMail::HeaderStyle * headerStyle () const
void setHeaderStyleAndStrategy (const KMail::HeaderStyle *style, const KMail::HeaderStrategy *strategy)
const KMail::HeaderStrategy * headerStrategy () const
const KMail::AttachmentStrategy * attachmentStrategy () const
void setAttachmentStrategy (const KMail::AttachmentStrategy *strategy)
QString overrideEncoding () const
void setOverrideEncoding (const QString &encoding)
void setPrintFont (const QFont &font)
const QTextCodec * overrideCodec () const
virtual void setPrinting (bool enable)
virtual void setMsg (KMMessage *msg, bool force=false)
void setMsgPart (KMMessagePart *aMsgPart, bool aHTML, const QString &aFileName, const QString &pname)
void setMsgPart (partNode *node)
void showHideMimeTree (bool isPlainTextTopLevel)
void setIdOfLastViewedMessage (const QString &msgId)
void clear (bool force=false)
void saveRelativePosition ()
void update (bool force=false)
virtual void printMsg (void)
QString copyText ()
bool autoDelete (void) const
void setAutoDelete (bool f)
bool htmlOverride () const
void setHtmlOverride (bool override)
bool htmlLoadExtOverride () const
void setHtmlLoadExtOverride (bool override)
bool htmlMail ()
bool htmlLoadExternal ()
void displaySplashPage (const QString &info)
void displayAboutPage ()
void displayBusyPage ()
void displayOfflinePage ()
void enableMsgDisplay ()
void atmViewMsg (KMMessagePart *msgPart)
bool atBottom () const
bool isFixedFont ()
void setUseFixedFont (bool useFixedFont)
KMail::HtmlWriter * htmlWriter ()
KToggleAction * toggleFixFontAction ()
KAction * mailToComposeAction ()
KAction * mailToReplyAction ()
KAction * mailToForwardAction ()
KAction * addAddrBookAction ()
KAction * openAddrBookAction ()
KAction * copyAction ()
KAction * selectAllAction ()
KAction * copyURLAction ()
KAction * urlOpenAction ()
KAction * urlSaveAsAction ()
KAction * addBookmarksAction ()
KAction * startImChatAction ()
void objectTreeToDecryptedMsg (partNode *node, NewByteArray &resultingData, KMMessage &theMessage, bool weAreReplacingTheRootNode=false, int recCount=0)
partNode * partNodeFromUrl (const KURL &url)
partNode * partNodeForId (int id)
KURL tempFileUrlFromPartNode (const partNode *node)
void setUpdateAttachment (bool update=true)
KHTMLPart * htmlPart () const
KMMessage * message (KMFolder **folder=0) const
void openAttachment (int id, const QString &name)
void emitUrlClicked (const KURL &url, int button)
void emitPopupMenu (const KURL &url, const QPoint &p)
void showAttachmentPopup (int id, const QString &name, const QPoint &p)
void setWaitingForSerNum (unsigned long serNum)
QWidget * mainWindow ()
bool decryptMessage () const
void setDecryptMessageOverwrite (bool overwrite=true)
bool showSignatureDetails () const
void setShowSignatureDetails (bool showDetails=true)
bool showAttachmentQuicklist () const
void setShowAttachmentQuicklist (bool showAttachmentQuicklist=true)

Static Public Member Functions

static QString newFeaturesMD5 ()
static int msgPartFromUrl (const KURL &url)

Protected Slots

void slotCycleHeaderStyles ()
void slotBriefHeaders ()
void slotFancyHeaders ()
void slotEnterpriseHeaders ()
void slotStandardHeaders ()
void slotLongHeaders ()
void slotAllHeaders ()
void slotCycleAttachmentStrategy ()
void slotIconicAttachments ()
void slotSmartAttachments ()
void slotInlineAttachments ()
void slotHideAttachments ()
void slotAtmView (int id, const QString &name)
void slotDelayedResize ()
void slotHandleAttachment (int)

Protected Member Functions

void styleChange (QStyle &oldStyle)
void setStyleDependantFrameWidth ()
virtual bool event (QEvent *e)
int pointsToPixel (int pointSize) const
void displayMessage ()
virtual void parseMsg (KMMessage *msg)
QString writeMsgHeader (KMMessage *aMsg, bool hasVCard=false, bool topLevel=false)
QString writeMessagePartToTempFile (KMMessagePart *msgPart, int partNumber)
QString createTempDir (const QString &param=QString())
void showVCard (KMMessagePart *msgPart)
virtual void initHtmlWidget (void)
virtual void closeEvent (QCloseEvent *)
virtual void resizeEvent (QResizeEvent *)
virtual void removeTempFiles ()
bool eventFilter (QObject *obj, QEvent *ev)

Friends

class KMail::ObjectTreeParser
class KMail::KHtmlPartHtmlWriter
void KMMimePartTree::itemClicked (QListViewItem *item)
void KMMimePartTree::itemRightClicked (QListViewItem *item, const QPoint &)
void KMMimePartTree::slotSaveAs ()
void KMMimePartTree::startDrag ()

Member Function Documentation

void KMReaderWin::update ( KMail::Interface::Observable *   )  [virtual]

Reimplemented from superclass.

from Interface::Observer Updates the current message

Implements KMail::Interface::Observer.

Definition at line 855 of file kmreaderwin.cpp.

void KMReaderWin::readConfig (  ) 

Read settings from app's config file.

Definition at line 931 of file kmreaderwin.cpp.

void KMReaderWin::writeConfig ( bool  withSync = true  )  const

Write settings to app's config file.

Calls sync() if withSync is TRUE.

Definition at line 1024 of file kmreaderwin.cpp.

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 1104 of file kmreaderwin.cpp.

const KMail::HeaderStrategy* KMReaderWin::headerStrategy (  )  const [inline]

Getthe message header strategy.

Definition at line 113 of file kmreaderwin.h.

const KMail::AttachmentStrategy* KMReaderWin::attachmentStrategy (  )  const [inline]

Get/set the message attachment strategy.

Definition at line 118 of file kmreaderwin.h.

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 126 of file kmreaderwin.h.

void KMReaderWin::setOverrideEncoding ( const QString &  encoding  ) 

Set the override character encoding.

Definition at line 1112 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 1151 of file kmreaderwin.cpp.

virtual void KMReaderWin::setPrinting ( bool  enable  )  [inline, virtual]

Set printing mode.

Definition at line 138 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 1182 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 2100 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 1479 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 159 of file kmreaderwin.h.

void KMReaderWin::clear ( bool  force = false  )  [inline]

Clear the reader and discard the current message.

Definition at line 163 of file kmreaderwin.h.

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 2421 of file kmreaderwin.cpp.

void KMReaderWin::update ( bool  force = false  ) 

Re-parse the current message.

Definition at line 2430 of file kmreaderwin.cpp.

void KMReaderWin::printMsg ( void   )  [virtual]

Print current message.

Definition at line 1774 of file kmreaderwin.cpp.

QString KMReaderWin::copyText (  ) 

Return selected text.

Definition at line 2373 of file kmreaderwin.cpp.

bool KMReaderWin::autoDelete ( void   )  const [inline]

Get/set auto-delete msg flag.

Definition at line 179 of file kmreaderwin.h.

bool KMReaderWin::htmlOverride (  )  const [inline]

Override default html mail setting.

Definition at line 183 of file kmreaderwin.h.

bool KMReaderWin::htmlLoadExtOverride (  )  const [inline]

Override default load external references setting.

Definition at line 187 of file kmreaderwin.h.

bool KMReaderWin::htmlMail (  ) 

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

Definition at line 2406 of file kmreaderwin.cpp.

bool KMReaderWin::htmlLoadExternal (  ) 

Is loading ext.

references to be supported? Takes into account override

Definition at line 2413 of file kmreaderwin.cpp.

QString KMReaderWin::newFeaturesMD5 (  )  [static]

Returns the MD5 hash for the list of new features.

Definition at line 1308 of file kmreaderwin.cpp.

void KMReaderWin::displaySplashPage ( const QString &  info  ) 

Display a generic HTML splash page instead of a message.

Definition at line 1320 of file kmreaderwin.cpp.

void KMReaderWin::displayAboutPage (  ) 

Display the about page instead of a message.

Definition at line 1362 of file kmreaderwin.cpp.

void KMReaderWin::displayBusyPage (  ) 

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

Definition at line 1343 of file kmreaderwin.cpp.

void KMReaderWin::displayOfflinePage (  ) 

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

Definition at line 1351 of file kmreaderwin.cpp.

void KMReaderWin::enableMsgDisplay (  ) 

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

Definition at line 1426 of file kmreaderwin.cpp.

void KMReaderWin::atmViewMsg ( KMMessagePart *  msgPart  ) 

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

Definition at line 2067 of file kmreaderwin.cpp.

KMail::HtmlWriter* KMReaderWin::htmlWriter (  )  [inline]

Return the HtmlWriter connected to the KHTMLPart we use.

Definition at line 222 of file kmreaderwin.h.

partNode * KMReaderWin::partNodeFromUrl ( const KURL &  url  ) 

Returns message part from given URL or null if invalid.

Definition at line 2549 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 1782 of file kmreaderwin.cpp.

KHTMLPart* KMReaderWin::htmlPart (  )  const [inline]

Access to the KHTMLPart used for the viewer.

Use with care!

Definition at line 263 of file kmreaderwin.h.

KMMessage * KMReaderWin::message ( KMFolder **  folder = 0  )  const

Returns the current message or 0 if none.

Definition at line 2439 of file kmreaderwin.cpp.

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 283 of file kmreaderwin.h.

bool KMReaderWin::decryptMessage (  )  const

Returns wether the message should be decryted.

Definition at line 2651 of file kmreaderwin.cpp.

void KMReaderWin::setDecryptMessageOverwrite ( bool  overwrite = true  )  [inline]

Enforce message decryption.

Definition at line 291 of file kmreaderwin.h.

bool KMReaderWin::showSignatureDetails (  )  const [inline]

Show signature details.

Definition at line 294 of file kmreaderwin.h.

void KMReaderWin::setShowSignatureDetails ( bool  showDetails = true  )  [inline]

Show signature details.

Definition at line 297 of file kmreaderwin.h.

void KMReaderWin::replaceMsgByUnencryptedVersion (  )  [signal]

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

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::urlClicked ( const KURL &  url,
int  button 
) [signal]

The user has clicked onto an URL that is no attachment.

void KMReaderWin::noDrag ( void   )  [signal]

Pgp displays a password dialog.

void KMReaderWin::selectAll (  )  [slot]

Select message body.

Definition at line 2367 of file kmreaderwin.cpp.

void KMReaderWin::clearCache (  )  [slot]

Force update even if message is the same.

Definition at line 1272 of file kmreaderwin.cpp.

void KMReaderWin::updateReaderWin (  )  [slot]

Refresh the reader window.

Definition at line 1434 of file kmreaderwin.cpp.

void KMReaderWin::slotScrollUp (  )  [slot]

HTML Widget scrollbar and layout handling.

Definition at line 2313 of file kmreaderwin.cpp.

void KMReaderWin::slotUrlOpen ( const KURL &  url,
const KParts::URLArgs &  args 
) [slot]

An URL has been activate with a click.

Definition at line 1935 of file kmreaderwin.cpp.

void KMReaderWin::slotUrlOn ( const QString &  url  )  [slot]

The mouse has moved on or off an URL.

Definition at line 1910 of file kmreaderwin.cpp.

void KMReaderWin::slotUrlPopup ( const QString &  ,
const QPoint &  mousePos 
) [slot]

The user presses the right mouse button on an URL.

Definition at line 1947 of file kmreaderwin.cpp.

void KMReaderWin::slotFind (  )  [slot]

The user selected "Find" from the menu.

Definition at line 2039 of file kmreaderwin.cpp.

void KMReaderWin::slotFindNext (  )  [slot]

The user selected "Find Next" from the menu.

Definition at line 2045 of file kmreaderwin.cpp.

void KMReaderWin::slotToggleFixedFont (  )  [slot]

The user toggled the "Fixed Font" flag from the view menu.

Definition at line 2051 of file kmreaderwin.cpp.

void KMReaderWin::slotCopySelectedText (  )  [slot]

Copy the selected text to the clipboard.

Definition at line 2060 of file kmreaderwin.cpp.

void KMReaderWin::slotMailtoReply (  )  [slot]

Operations on mailto: URLs.

Definition at line 2541 of file kmreaderwin.cpp.

void KMReaderWin::slotUrlCopy (  )  [slot]

Copy URL in mUrlCurrent to clipboard.

Removes "mailto:" at beginning of URL before copying.

Definition at line 2507 of file kmreaderwin.cpp.

void KMReaderWin::slotUrlSave (  )  [slot]

Save the page to a file.

Definition at line 2534 of file kmreaderwin.cpp.

void KMReaderWin::slotIMChat (  )  [slot]

start IM Chat with addressee

Definition at line 2598 of file kmreaderwin.cpp.

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

Some attachment operations.

Definition at line 2195 of file kmreaderwin.cpp.

void KMReaderWin::styleChange ( QStyle &  oldStyle  )  [protected]

reimplemented in order to update the frame width in case of a changed GUI style

Definition at line 2003 of file kmreaderwin.cpp.

void KMReaderWin::setStyleDependantFrameWidth (  )  [protected]

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

Definition at line 1986 of file kmreaderwin.cpp.

bool KMReaderWin::event ( QEvent *  e  )  [protected, virtual]

Watch for palette changes.

Definition at line 915 of file kmreaderwin.cpp.

int KMReaderWin::pointsToPixel ( int  pointSize  )  const [protected]

Calculate the pixel size.

Definition at line 1471 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 1491 of file kmreaderwin.cpp.

void KMReaderWin::parseMsg ( KMMessage *  msg  )  [protected, virtual]

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

Definition at line 1527 of file kmreaderwin.cpp.

QString KMReaderWin::writeMsgHeader ( KMMessage *  aMsg,
bool  hasVCard = false,
bool  topLevel = false 
) [protected]

Creates a nice mail header depending on the current selected header style.

Definition at line 1693 of file kmreaderwin.cpp.

QString KMReaderWin::writeMessagePartToTempFile ( KMMessagePart *  msgPart,
int  partNumber 
) [protected]

Writes the given message part to a temporary file and returns the name of this file or QString::null if writing failed.

Definition at line 1709 of file kmreaderwin.cpp.

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 1746 of file kmreaderwin.cpp.

void KMReaderWin::showVCard ( KMMessagePart *  msgPart  )  [protected]

show window containing infos about a vCard.

Definition at line 1766 of file kmreaderwin.cpp.

void KMReaderWin::initHtmlWidget ( void   )  [protected, virtual]

HTML initialization.

Definition at line 1042 of file kmreaderwin.cpp.

void KMReaderWin::closeEvent ( QCloseEvent *   )  [protected, virtual]

Some necessary event handling.

Definition at line 1859 of file kmreaderwin.cpp.

void KMReaderWin::removeTempFiles (  )  [protected, virtual]

Cleanup the attachment temp files.

Definition at line 897 of file kmreaderwin.cpp.

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

Event filter.

Definition at line 2605 of file kmreaderwin.cpp.

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

kmail

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys