PlugInCallback Class Reference

#include <PlugInCallback.h>

List of all members.

Public Member Functions
virtual void	operator() ()=0
virtual bool	finish ()=0
virtual Progress *	progress () const =0
virtual PlugIn *	getPlugIn () const =0
virtual	~PlugInCallback ()

---

Detailed Description

Definition at line 16 of file PlugInCallback.h.

---

Constructor & Destructor Documentation

virtual PlugInCallback::~PlugInCallback

(

)

[virtual]

This should be implemented in subclasses.

Definition at line 55 of file PlugInCallback.h.

---

Member Function Documentation

virtual void PlugInCallback::operator()

(

)

[pure virtual]

This is called when cleanup has finished in the core.

virtual bool PlugInCallback::finish

(

)

[pure virtual]

This blocks until the plug-in thread has finished.

Usually just a wrapper around BThread::ThreadWait().

Returns:

Returns true if successful, otherwise returns false.

virtual Progress* PlugInCallback::progress

(

)

const [pure virtual]

Returns the Progress object for the plug-in that registered this callback.

Returns:

The Progress object for the registering plug-in.

virtual PlugIn* PlugInCallback::getPlugIn

(

)

const [pure virtual]

Returns a pointer to the plug-in that is registering this callback.

Returns:

A pointer to the plug-in that has registered this callback. NULL may be returned if the plug-in has been registered as a background executing plug-in.

See also:

ViewerShell, DesktopServices::registerCallback()