PISelection.h

Go to the documentation of this file.

// ADOBE SYSTEMS INCORPORATED
// 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 __PISelection__
#define __PISelection__

#if PRAGMA_ONCE
#pragma once
#endif

#include "PIActions.h"
#include "PIGeneral.h"
#include "SPBasic.h"

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


/* Operation selectors */

#define selectionSelectorAbout   0

#define selectionSelectorExecute 1

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

/* Error return values. The plug-in module may also return standard Macintosh
   operating system error codes, or report its own errors, in which case it
   can return any positive integer. */



#define selectionBadParameters -30700   
#define selectionBadMode       -30701   
/********************************************************************************/

typedef struct PISelectionParams
    {
    
    /* We start with the fields that are common to pretty much all of the plug-ins. */
    
    int32       serialNumber;       
    TestAbortProc   abortProc;      
    ProgressProc    progressProc;   
    OSType      hostSig;            
    HostProc    hostProc;          
    BufferProcs *bufferProcs;       
    ResourceProcs *resourceProcs;   
    ProcessEventProc processEvent;  
    DisplayPixelsProc displayPixels;
    HandleProcs *handleProcs;       
    ColorServicesProc colorServices; 
    ImageServicesProcs *imageServicesProcs;
    PropertyProcs   *propertyProcs; 
    ChannelPortProcs *channelPortProcs;
    PIDescriptorParameters  *descriptorParameters;  
    Str255                  *errorString;           
    PlugInMonitor   monitor;        
    void        *platformData;      
    char reserved [4];              
    /* We follow this with the fields specific to this type of plug-in. */
    
    ReadImageDocumentDesc *documentInfo;    
    WriteChannelDesc *newSelection;         
    Handle newPath;                         
    /* We can optionally take the mask and use it to build a new layer or floating
    selection filled with the current foreground color. 
     0 = make selection
     1 = make path
     2 = make layer/float */
    
    int32 treatment;           
    int32 supportedTreatments; 
    SPBasicSuite *sSPBasic;     
    void        *plugInRef;     
    /* And, of course, space for future expansion. */
    
    char reservedBlock [248];  
    }
PISelectionParams, *SelectionRecordPtr;

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

#define piSelMakeMask           0    
#define piSelMakeWorkPath       1    
#define piSelMakeLayer          2    
/* @} */

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

#endif // __PISelection_h__