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

#include <bodyparturlhandler.h>

Public Member Functions

virtual bool handleClick (BodyPart *part, const TQString &path, Callback &c) const =0
 
virtual bool handleContextMenuRequest (BodyPart *part, const TQString &path, const TQPoint &p) const =0
 
virtual TQString statusBarMessage (BodyPart *part, const TQString &path) const =0
 

Detailed Description

An interface to body part reader link handlers.

Author
Marc Mutz mutz@.nosp@m.kde..nosp@m.org

This interface is a condensed of variant of the more general

See also
URLHandler interface, designed to make bodypart-dependent link operations possible without exposing KMail-internal classes.

Implementation-wise, these handlers are called as a nested Chain Of Responsibilty by an internal implementation of URLHandler.

You can create a link whose handling is passed to this handler by using BodyPart::makeLink( const TQString & path ). path is what * is passed back to the methods of this interface.

Note that the BodyPart interface does not provide a means of learning the content type of the body part passed. This is intentional. It is expected that either separate BodyPartURLHandlers are created for these purposes or else the information encoded into the path parameter by the BodyPartFormatter.

Definition at line 70 of file bodyparturlhandler.h.

Member Function Documentation

◆ handleClick()

virtual bool KMail::Interface::BodyPartURLHandler::handleClick ( BodyPart *  part,
const TQString &  path,
Callback &  c 
) 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 handler, false otherwise.

◆ handleContextMenuRequest()

virtual bool KMail::Interface::BodyPartURLHandler::handleContextMenuRequest ( BodyPart *  part,
const TQString &  path,
const TQPoint &  p 
) 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 handler, false otherwise.

◆ statusBarMessage()

virtual TQString KMail::Interface::BodyPartURLHandler::statusBarMessage ( BodyPart *  part,
const TQString &  path 
) const
pure virtual

Called when hovering over a link.

Returns
a string to be shown in the status bar while hovering over this link or TQString() if the link was not handled by this handler.
The documentation for this class was generated from the following file: