Public Member Functions | List of all members
KMail::URLHandler Class Referenceabstract

#include <urlhandler.h>

Inherited by KMail::URLHandlerManager::BodyPartURLHandlerManager.

Public Member Functions

virtual bool handleClick (const KURL &url, KMReaderWin *w) const =0
 
virtual bool handleShiftClick (const KURL &url, KMReaderWin *window) const
 
virtual bool willHandleDrag (const KURL &url, const TQString &imagePath, KMReaderWin *window) const
 
virtual bool handleDrag (const KURL &url, const TQString &imagePath, KMReaderWin *window) const
 
virtual bool handleContextMenuRequest (const KURL &url, const TQPoint &p, KMReaderWin *w) const =0
 
virtual TQString statusBarMessage (const KURL &url, KMReaderWin *w) const =0
 

Detailed Description

An interface to reader link handlers.

Author
Marc Mutz mutz@.nosp@m.kde..nosp@m.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

◆ handleClick()

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.

◆ handleContextMenuRequest()

virtual bool KMail::URLHandler::handleContextMenuRequest ( const KURL &  url,
const TQPoint &  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.

◆ handleDrag()

virtual bool KMail::URLHandler::handleDrag ( const KURL &  url,
const TQString &  imagePath,
KMReaderWin *  window 
) const
inlinevirtual

Called when starting a drag with the given URL.

If the drag is handled, you should create a drag object.

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

Definition at line 87 of file urlhandler.h.

◆ handleShiftClick()

virtual bool KMail::URLHandler::handleShiftClick ( const KURL &  url,
KMReaderWin *  window 
) const
inlinevirtual

Called when shift-clicking the link in the reader.

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

Definition at line 65 of file urlhandler.h.

◆ statusBarMessage()

virtual TQString 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.

◆ willHandleDrag()

virtual bool KMail::URLHandler::willHandleDrag ( const KURL &  url,
const TQString &  imagePath,
KMReaderWin *  window 
) const
inlinevirtual
Returns
should return true if this URLHandler will handle the drag

Definition at line 74 of file urlhandler.h.

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