kmail Library API Documentation

KMail::URLHandler Class Reference

An interface to reader link handlers. More...

#include <urlhandler.h>

List of all members.

Public Methods

virtual ~URLHandler ()
virtual bool handleClick (const KURL &url, KMReaderWin *w) const=0
virtual bool handleContextMenuRequest (const KURL &url, const QPoint &p, KMReaderWin *w) const=0
virtual QString statusBarMessage (const KURL &url, KMReaderWin *w) const=0


Detailed Description

An interface to reader link handlers.

Author:
Marc Mutz <mutz@kde.org>
The KMReaderWin parameters are temporary until such time as the Memento-store is in place.

Definition at line 49 of file urlhandler.h.


Member Function Documentation

virtual bool KMail::URLHandler::handleClick const KURL &    url,
KMReaderWin *    w
const [pure virtual]
 

Called when LMB-clicking on a link in the reader.

Should start processing equivalent to "opening" the link.

Returns:
true if the click was handled by this URLHandler, false otherwise.

virtual bool KMail::URLHandler::handleContextMenuRequest const KURL &    url,
const QPoint   p,
KMReaderWin *    w
const [pure virtual]
 

Called when RMB-clicking on a link in the reader.

Should show a context menu at the specified point with the specified widget as parent.

Returns:
true if the right-click was handled by this URLHandler, false otherwise.

virtual QString KMail::URLHandler::statusBarMessage const KURL &    url,
KMReaderWin *    w
const [pure virtual]
 

Called when hovering over a link.

Returns:
a string to be shown in the status bar while hovering over this link.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for kmail Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:37:37 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003