This structure is passed to the plug-in module through the parameter block. More...

#include <PISelection.h>

Data Fields
int32	serialNumber
TestAbortProc	abortProc
	A pointer to the `TestAbortProc` callback.
ProgressProc	progressProc
	A pointer the the `ProgressProc` callback.
OSType	hostSig
	The signature of the host, provided by the host.
HostProc	hostProc
	A pointer to a host-defined callback procedure.
BufferProcs *	bufferProcs
	A pointer to the Buffer suite if it is supported by the host, otherwise NULL.
ResourceProcs *	resourceProcs
	A pointer to the Pseudo-Resource suite if it is supported by the host, otherwise NULL.
ProcessEventProc	processEvent
	A pointer to the `ProcessEventProc` callback if it is supported by the host, otherwise NULL.
DisplayPixelsProc	displayPixels
	A pointer to the `DisplayPixelsProc` callback if it is supported by the host, otherwise NULL.
HandleProcs *	handleProcs
	A pointer to the Handle callback suite if it is supported by the host, otherwise NULL.
ColorServicesProc	colorServices
	A pointer to the ColorServices callback if it is supported by the host, otherwise NULL.
ImageServicesProcs *	imageServicesProcs
	Suite of image processing callbacks.
PropertyProcs *	propertyProcs
	Property callback suite.
ChannelPortProcs *	channelPortProcs
	Suite for passing pixels through channel ports.
PIDescriptorParameters *	descriptorParameters
	Descriptor callback suite.
Str255 *	errorString
	An error reporting string to return to Photoshop.
PlugInMonitor	monitor
	Monitor setup information for the host.
void *	platformData
	A pointer to platform specific data.
char	reserved [4]
	Reserved for future use.
ReadImageDocumentDesc *	documentInfo
	The document for the selection.
WriteChannelDesc *	newSelection
	Output for the new selection, unless newPath is not NULL.
Handle	newPath
	Output for the new path.
int32	treatment
	Treatment for returned pixels or mask.
int32	supportedTreatments
	Mask indicating what treatments the host supports.
SPBasicSuite *	sSPBasic
	PICA basic suite.
void *	plugInRef
	Plug-in reference used by PICA.
char	reservedBlock [248]
	Reserved for future use.

Detailed Description

This structure is passed to the plug-in module through the parameter block.

See Plug-in Entry Point for an explanation of how the host calls a plug-in.

Field Documentation

int32 PISelectionParams::serialNumber

Deprecated:: Formerly the host serial number.

The host now reports zero for the serialNumber. Plug-ins should use the Property Suite Callbacks through the PISelectionParams::propertyProcs field and specify propSerialString2 to get the serial string.

TestAbortProc PISelectionParams::abortProc

A pointer to the TestAbortProc callback.

ProgressProc PISelectionParams::progressProc

A pointer the the ProgressProc callback.

OSType PISelectionParams::hostSig

The signature of the host, provided by the host.

The signature for Photoshop is signature is 8BIM.

HostProc PISelectionParams::hostProc

A pointer to a host-defined callback procedure.

May be NULL.

BufferProcs* PISelectionParams::bufferProcs

A pointer to the Buffer suite if it is supported by the host, otherwise NULL.

See Buffer Suite Callbacks (deprecated Standard Suite).

ResourceProcs* PISelectionParams::resourceProcs

A pointer to the Pseudo-Resource suite if it is supported by the host, otherwise NULL.

See Resource Suite Callbacks.

ProcessEventProc PISelectionParams::processEvent

A pointer to the ProcessEventProc callback if it is supported by the host, otherwise NULL.

DisplayPixelsProc PISelectionParams::displayPixels

A pointer to the DisplayPixelsProc callback if it is supported by the host, otherwise NULL.

HandleProcs* PISelectionParams::handleProcs

A pointer to the Handle callback suite if it is supported by the host, otherwise NULL.

See Handle Suite Callbacks (deprecated Standard Suite).

ColorServicesProc PISelectionParams::colorServices

A pointer to the ColorServices callback if it is supported by the host, otherwise NULL.

ImageServicesProcs* PISelectionParams::imageServicesProcs

Suite of image processing callbacks.

PropertyProcs* PISelectionParams::propertyProcs

Property callback suite.

The plug-in needs to dispose of the handle returned for complex properties. The plug-in also maintains ownership of handles for set properties.

ChannelPortProcs* PISelectionParams::channelPortProcs

Suite for passing pixels through channel ports.

PIDescriptorParameters* PISelectionParams::descriptorParameters

Descriptor callback suite.

Str255* PISelectionParams::errorString

An error reporting string to return to Photoshop.

If the plug-in returns with result=errReportString then this string is displayed as: "Cannot complete operation because " + errorString.

PlugInMonitor PISelectionParams::monitor

Monitor setup information for the host.

void* PISelectionParams::platformData

A pointer to platform specific data.

Not used under Mac OS. See PlatformData in PITypes.h.

char PISelectionParams::reserved[4]

Reserved for future use.

Set to zero.

ReadImageDocumentDesc* PISelectionParams::documentInfo

The document for the selection.

This provides a collection of read channels, each with its own port.

WriteChannelDesc* PISelectionParams::newSelection

Output for the new selection, unless newPath is not NULL.

The host provides the write port in WriteChannelDesc::port

Handle PISelectionParams::newPath

Output for the new path.

The plug-in can return a path instead of a selection. If non-NULL, any data written into the newSelection is ignored and the path described by the handle becomes the work path. The handle is disposed of the host.

int32 PISelectionParams::treatment

Treatment for returned pixels or mask.

We can optionally take the mask and use it to build a new layer or floating selection filled with the current foreground color. See Options for Treatment and supportedTreatment.

int32 PISelectionParams::supportedTreatments

Mask indicating what treatments the host supports.

See Options for Treatment and supportedTreatment.

SPBasicSuite* PISelectionParams::sSPBasic

PICA basic suite.

Provides the mechanism to access all PICA suites.

void* PISelectionParams::plugInRef

Plug-in reference used by PICA.

char PISelectionParams::reservedBlock[248]

Reserved for future use.

Set to zero.

The documentation for this struct was generated from the following file: