Detailed Description

Description:: This class is available in release 3.0 and later only.

Implemented by the System (for Render Effect plug-ins inside the Effect::Apply() method).

The Check() method of this class may be called to check if the user did something to abort the application of the effect.

#include <sfx.h>

Inheritance diagram for CheckAbortCallback:

Public Types
enum	{ cac_check, cac_progress, cac_setTitle }
Public Member Functions
virtual BOOL	Check ()=0
virtual BOOL	Progress (int done, int total)=0
virtual void	SetTitle (const MCHAR *title)=0
BEGIN_FUNCTION_MAP	FN_0 (cac_check, TYPE_BOOL, Check)
	FN_2 (cac_progress, TYPE_BOOL, Progress, TYPE_INT, TYPE_INT)
	VFN_1 (cac_setTitle, SetTitle, TYPE_STRING)
END_FUNCTION_MAP FPInterfaceDesc *	GetDesc ()

Member Enumeration Documentation

anonymous enum

Enumerator:

{ cac_check, cac_progress, cac_setTitle, };

virtual BOOL Check ( ) [pure virtual]

Remarks:: Returns TRUE if user has done something to cause an abort; otherwise FALSE.

Remarks:: This method is should be called by each Effect plug-in as it proceeds through the image to update the progress bar.

Parameters:: int done

The amount done, i.e. the current state of the image processsing. This is usually the number of scan lines processed so far.

int total

The total number of updates. This is usually the number of pixels in height of the image.

Returns:: Returns TRUE if user has done something to cause an abort; otherwise FALSE.

virtual void SetTitle ( const MCHAR * title ) [pure virtual]

Remarks:: This method is called internally by the calling code -- plug-ins don't need to call this method.

END_FUNCTION_MAP FPInterfaceDesc* GetDesc ( ) [inline, virtual]

Remarks:: Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

{ return (FPInterfaceDesc*)GetCOREInterface(CAC_INTERFACE); }