PIPickerParams Struct Reference

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

#include <PIPicker.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.
PickParms	pickParms
	Picker parameters used to pass the original color in to the plug-in suite, and the returned color back to the host.
SPBasicSuite *	sSPBasic
	PICA basic suite.
void *	plugInRef
	Plug-in reference used by PICA.
char	reservedBlock [252]
	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 PIPickerParams::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 PIPickerParams::propertyProcs field and specify propSerialString2 to get the serial string.

TestAbortProc PIPickerParams::abortProc

A pointer to the TestAbortProc callback.

ProgressProc PIPickerParams::progressProc

A pointer the the ProgressProc callback.

OSType PIPickerParams::hostSig

The signature of the host, provided by the host.

The signature for Photoshop is signature is 8BIM.

HostProc PIPickerParams::hostProc

A pointer to a host-defined callback procedure.

May be NULL.

BufferProcs* PIPickerParams::bufferProcs

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

See Buffer Suite Callbacks (deprecated Standard Suite).

ResourceProcs* PIPickerParams::resourceProcs

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

See Resource Suite Callbacks.

ProcessEventProc PIPickerParams::processEvent

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

DisplayPixelsProc PIPickerParams::displayPixels

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

HandleProcs* PIPickerParams::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 PIPickerParams::colorServices

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

ImageServicesProcs* PIPickerParams::imageServicesProcs

Suite of image processing callbacks.

PropertyProcs* PIPickerParams::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* PIPickerParams::channelPortProcs

Suite for passing pixels through channel ports.

PIDescriptorParameters* PIPickerParams::descriptorParameters

Descriptor callback suite.

Str255* PIPickerParams::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 PIPickerParams::monitor

Monitor setup information for the host.

void* PIPickerParams::platformData

A pointer to platform specific data.

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

char PIPickerParams::reserved[4]

Reserved for future use.

Set to zero.

PickParms PIPickerParams::pickParms

Picker parameters used to pass the original color in to the plug-in suite, and the returned color back to the host.

SPBasicSuite* PIPickerParams::sSPBasic

PICA basic suite.

Provides the mechanism to access all PICA suites.

void* PIPickerParams::plugInRef

Plug-in reference used by PICA.

char PIPickerParams::reservedBlock[252]

Reserved for future use.

Set to zero.

---

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

• PIPicker.h