PIExport.h File Reference

This file describes Photoshop's Export plug-in module interface. More...

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

Go to the source code of this file.

Data Structures
struct	ExportRecord
	This structure is passed to the Export plug-in module main() through the pluginParamBlock. More...
Defines
#define	PIExpFlagsProperty   0x65787066 /* 'expf' <Set> Export flags */
	Indicates that the plug-in can see transparency data; key value is 'expf'.
#define	PIExpSupportsTransparency   0
	Flag index for PIExpFlagsProperty; indicates that the plug-in can see transparency data.
Export Module Selectors
#define	exportSelectorAbout   0
	Allows the plug-in to display an about box for the Export Module.
#define	exportSelectorStart   1
	Allows the plug-in to open a dialog box and set up the initial image rectangle to process.
#define	exportSelectorContinue   2
	Allows the plug-in module to process the image data pointed to by data, and then indicate what area of the image it will process next.
#define	exportSelectorFinish   3
	Allows the plug-in module to clean up after an image export.
#define	exportSelectorPrepare   4
	Allows the plug-in module to adjust the Photoshop memory allocation algorithm.
Export Module Error Codes
#define	exportBadParameters   -30200
	Indicates a problem with the export module interface.
#define	exportBadMode   -30201
	Indicates that the export module does not support <mode> images.
Typedefs
typedef struct ExportRecord	ExportRecord
	This structure is passed to the Export plug-in module main() through the pluginParamBlock.
typedef struct ExportRecord *	ExportRecordPtr

---

Detailed Description

This file describes Photoshop's Export plug-in module interface.

Distribution: PUBLIC

---

Define Documentation

#define PIExpFlagsProperty   0x65787066 /* 'expf' <Set> Export flags */

Indicates that the plug-in can see transparency data; key value is 'expf'.

This property key reflects the ExportFlags property in the PiPL resource file. The value of the property has type FlagSet; a variable length bitstring in which the first member is represented by the most significant bit of the first byte, the eighth member is in the least significant bit of the first byte, etc. The length of the set is in the property's length field. Use PIExpSupportsTransparency to set the transparency flag.

Note:

Currenty only the transparency flag is supported.

#define PIExpSupportsTransparency   0

Flag index for PIExpFlagsProperty; indicates that the plug-in can see transparency data.