PIProgressSuite.h

Go to the documentation of this file.

// ADOBE SYSTEMS INCORPORATED
// (c) Copyright  1993 - 2005 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE:  Adobe permits you to use, modify, and distribute this 
// file in accordance with the terms of the Adobe license agreement
// accompanying it.  If you have received this file from a source
// other than Adobe, then your use, modification, or distribution
// of it requires the prior written permission of Adobe.
//-------------------------------------------------------------------
#ifndef __PIProgressSuite__
#define __PIProgressSuite__

#if PRAGMA_ONCE
#pragma once
#endif

#include "PIGeneral.h"

#include "ASPreInclude.h"
#include "ASZStringSuite.h"

#ifdef __cplusplus
extern "C" {
#endif

/******************************************************************************/

#define kPSProgressSuite            "Photoshop Progress Suite for Plug-ins"


//-------------------------------------------------------------------------
//  Progress suite typedefs 
//-------------------------------------------------------------------------

typedef SPErr (*Progress_DoProgress) (const ASZString zs, SPErr (*proc) (void *), void *refCon);

typedef SPErr (*Progress_DoForcedProgress) (const ASZString zs, SPErr (*proc) (void *), void *refCon);

typedef SPErr (*Progress_DoTask) (real64 taskLength, SPErr (*proc) (void *), void *refCon);


typedef SPErr (*Progress_DoSegmentTask) (int32 segmentLength,
                                         int32 *done,
                                         int32 total,
                                         SPErr (*proc) (void *),
                                         void *refCon);


typedef void (*Progress_ChangeProgressText) (const ASZString zs);


typedef SPErr (*Progress_DoPreviewTask) (const char *selector,
                                        SPErr (*proc) (void *),
                                        void *refCon);


typedef SPErr (*Progress_DoWatchTask) (SPErr (*proc) (void *), void *refCon);


typedef SPErr (*Progress_DoSuspendedWatchTask) (SPErr (*proc) (void *), void *refCon);

typedef void (*Progress_ContinueWatchCursor) (void);


//-------------------------------------------------------------------------
//  Progress suite version 1
//-------------------------------------------------------------------------

#define kPSProgressSuiteVersion1        1

typedef struct 
{
    Progress_DoProgress                 DoProgress;           
    Progress_DoTask                     DoTask;               
    Progress_DoSegmentTask              DoSegmentTask;        
    Progress_ChangeProgressText         ChangeProgressText;   
    Progress_DoPreviewTask              DoPreviewTask;        
    Progress_DoWatchTask                DoWatchTask;          
    Progress_DoSuspendedWatchTask       DoSuspendedWatchTask; 
    Progress_ContinueWatchCursor        ContinueWatchCursor;  
//  The following are taken from from the parameter block and are defined in PIGeneral.h:
    TestAbortProc                       TestAbort;           
    ProgressProc                        UpdateProgress;      
} PSProgressSuite1;

//-------------------------------------------------------------------------
//  Progress suite version 2
//-------------------------------------------------------------------------

#define kPSProgressSuiteVersion2        2

typedef struct 
{
    Progress_DoProgress                 DoProgress;           
    Progress_DoForcedProgress           DoForcedProgress;     
    Progress_DoTask                     DoTask;               
    Progress_DoSegmentTask              DoSegmentTask;        
    Progress_ChangeProgressText         ChangeProgressText;   
    Progress_DoPreviewTask              DoPreviewTask;        
    Progress_DoWatchTask                DoWatchTask;          
    Progress_DoSuspendedWatchTask       DoSuspendedWatchTask; 
    Progress_ContinueWatchCursor        ContinueWatchCursor;  
//  The following are taken from from the parameter block and are defined in PIGeneral.h:
    TestAbortProc                       TestAbort;           
    ProgressProc                        UpdateProgress;      
} PSProgressSuite2;

/******************************************************************************/

#ifdef __cplusplus
}
#endif


#endif  // PIProgressSuite