General PiPL Properties

These PiPL properties are common to all types of plug-in modules. More...

Defines

#define PIKindProperty   0x6b696e64L
 Type or kind of plug-in; key value is 'kind'.
#define PIVersionProperty   0x76657273L
 Major and minor version number indicating which revision of the plug-in interface this plug-in was written for; key value is 'vers'.
#define PIPriorityProperty   0x70727479L
 Plug-in load order; key value is 'prty'.
#define PIComponentProperty   0x636d7074L
 Component and Version ids; key value is 'cmpt'.
#define PIImageModesProperty   0x6d6f6465L
 Image modes that the plug-in supports; key value is 'mode'.
#define PIEnableInfoProperty   0x656e626cL
 A string of modula-like expressions that, upon evaluation, must all be true for the plug-in to be enabled in the menu; key value is 'enbl'.
#define PIWantsScrapProperty   0x776E7363L
 The plug-in wants the host to export image scrap; key value is 'wnsc'.
#define PICocoaProperty   0x636F636FL
 The plug-in wants the host to keep it loaded as unloading Cocoa plug-ins could result in objective-c messages going to no where This property key reflects the Cocoa property in the PiPL resource file.
#define PIFileBrowserAwareProperty   0x66626177L
 The plug-in wants in the File Browser menu; key value is 'fbaw'.
#define PINoAboutBoxProperty   0x6E61626FL
 The plug-in does not want an about box menu entry; key value is 'nabo'.
#define PILegacyFilterGalleryMenuItemProperty   0x6C46476DL
 The plug-in is a Filter Gallery plugin and its menu should be hidden by the preference.
#define PIFilterLayerSupport   0x666c6c79L
 Plug-in filter layer properties; key value is 'flly'.
#define PIRequiredHostProperty   0x686f7374L
 Creator code of required host; key value is 'host'.
#define PICategoryProperty   0x63617467L
 In the Filter menu, what sub-menu to list this plug-in; key value is 'catg'.
#define PIZCategoryProperty   0x7A636174L
 In the Filter menu, what sub-menu to list this plug-in; key value is 'zcat'.
#define PINameProperty   0x6e616d65L
 Plug-in menu name for module in PICategoryProperty sub-menu; key value is 'name'.
#define PIZNameProperty   0x7A6E616DL
 Plug-in menu name for module in PICategoryProperty sub-menu; key value is 'znam'.
#define PIProgressTextProperty   0x70726f67
 Plug-in handles all progress bar updates.
#define PIZProgressTextProperty   0x7A70726F
 Plug-in handles all progress bar updates.
#define PILoadUnloadProperty   0x70694c55
 Plug-in supports load/unload selectors; key is 'piLU'.
#define PIPreferencesProperty   0x70695046
 Plug-in supports preferences dialog selectors; key is 'piPF'.

Detailed Description

These PiPL properties are common to all types of plug-in modules.


Define Documentation

#define PIKindProperty   0x6b696e64L

Type or kind of plug-in; key value is 'kind'.

This property key reflects the Kind property in the PiPL resource file. The property data has type PIType, with expected values as follows:

  • 'ARPI'=Adobe Illustrator
  • 'SPEA'=Adobe Suite Pea
  • '8BXM'=Accelerator extension
  • '8BAM'=Import module
  • '8BEM'=Export module
  • '8BFM'=Filter module
  • '8BIF'=Format module
  • '8BSM'=Selection module '- 8BYM'=Parser module

#define PIVersionProperty   0x76657273L

Major and minor version number indicating which revision of the plug-in interface this plug-in was written for; key value is 'vers'.

This property key reflects the Version property in the PiPL resource file. The major version number indicates incompatible changes while the minor version number indicates incremental enhancements.

The data for the property has type int32. The major version number is encoded in the most significant 16 bits of the 32 bit version number, the minor version number is encoded in the least significant 16 bits.

There are separate version numbers for each kind of plug-in. The current version for a given kind of plug-in is defined by a preprocessor macro in the header file defining the interface for that plug-in type.

#define PIPriorityProperty   0x70727479L

Plug-in load order; key value is 'prty'.

This property key reflects the Priority property in the PiPL resource file. The data for the property has type int32. Also used to control the order in which items with the same name show up in menus. Lower numbers (including negative ones) load first. If NULL, the default is zero.

#define PIComponentProperty   0x636d7074L

Component and Version ids; key value is 'cmpt'.

This property key reflects the Component property in the PiPL resource file.

#define PIImageModesProperty   0x6d6f6465L

Image modes that the plug-in supports; key value is 'mode'.

This property key reflects the SupportedModes property in the PiPL resource file. The data for 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.

Adobe Photoshop, has 18 modes, see Image Modes.

This property determines whether your plug-in will be active (black) or inactive (gray) in Photoshop’s menus based on the current document’s image mode.

#define PIEnableInfoProperty   0x656e626cL

A string of modula-like expressions that, upon evaluation, must all be true for the plug-in to be enabled in the menu; key value is 'enbl'.

This property key reflects the EnableInfo property in the PiPL resource file. It is a superset of the SupportedModes PiPL property. (See PIImageModesProperty). One set of modes required in SupportedModes and a different set required in EnableInfo, produces unknown results. EnableInfo and SupportedModes should always match, in regards to mode requests.

See EnableInfo Property Grammar.

#define PIWantsScrapProperty   0x776E7363L

The plug-in wants the host to export image scrap; key value is 'wnsc'.

This property key reflects the WantsScrap property in the PiPL resource file.

#define PICocoaProperty   0x636F636FL

The plug-in wants the host to keep it loaded as unloading Cocoa plug-ins could result in objective-c messages going to no where This property key reflects the Cocoa property in the PiPL resource file.

#define PIFileBrowserAwareProperty   0x66626177L

The plug-in wants in the File Browser menu; key value is 'fbaw'.

This property key reflects the FileBrowserAware property in the PiPL resource file.

#define PINoAboutBoxProperty   0x6E61626FL

The plug-in does not want an about box menu entry; key value is 'nabo'.

This property key reflects the NoAboutBox property in the PiPL resource file.

#define PILegacyFilterGalleryMenuItemProperty   0x6C46476DL

The plug-in is a Filter Gallery plugin and its menu should be hidden by the preference.

key value is 'lFGm'. This property relfects the LegacyFilterGalleryMenuItem property in the PiPL resource file.

#define PIFilterLayerSupport   0x666c6c79L

Plug-in filter layer properties; key value is 'flly'.

This property key reflects the FilterLayerSupport property in the PiPL resource file. ]

#define PIRequiredHostProperty   0x686f7374L

Creator code of required host; key value is 'host'.

This property key reflects the RequiredHost property in the PiPL resource file. The data for the property has type PIType, with a value such as '8BIM' for Adobe Photoshop.

#define PICategoryProperty   0x63617467L

In the Filter menu, what sub-menu to list this plug-in; key value is 'catg'.

This property key reflects the Category property in the PiPL resource file. The data for the property has type PString; a Str255 except that storage may not be present for all 255 characters. The initial length byte is present in the property..

#define PIZCategoryProperty   0x7A636174L

In the Filter menu, what sub-menu to list this plug-in; key value is 'zcat'.

This property key reflects the ZStringCategory property in the PiPL resource file. The data for the property has type ZString; a Str255 except that storage may not be present for all 255 characters. The initial length byte is present in the property..

#define PINameProperty   0x6e616d65L

Plug-in menu name for module in PICategoryProperty sub-menu; key value is 'name'.

This property key reflects the Name property in the PiPL resource file. The data for the property has type PString; a Str255 except that storage may not be present for all 255 characters. The initial length byte is present in the property.

#define PIZNameProperty   0x7A6E616DL

Plug-in menu name for module in PICategoryProperty sub-menu; key value is 'znam'.

This property key reflects the ZStringName property in the PiPL resource file. The data for the property has type PString; a Str255 except that storage may not be present for all 255 characters. The initial length byte is present in the property.

#define PIProgressTextProperty   0x70726f67

Plug-in handles all progress bar updates.

**No-progress** Key value is 'prog'. This property key reflects the ProgressText property in the PiPL resource file. The data for the property has type PString; a Str255 except that storage may not be present for all 255 characters. The initial length byte is present in the property.

#define PIZProgressTextProperty   0x7A70726F

Plug-in handles all progress bar updates.

**No-progress** Key value is 'zpro'. This property key reflects the ZStringProgressText property in the PiPL resource file. The data for the property has type PString; a Str255 except that storage may not be present for all 255 characters. The initial length byte is present in the property.

#define PILoadUnloadProperty   0x70694c55

Plug-in supports load/unload selectors; key is 'piLU'.

This property key reflects the LoadUnload property in the PiPL resource file.

#define PIPreferencesProperty   0x70695046

Plug-in supports preferences dialog selectors; key is 'piPF'.

This property key reflects the Preferences property in the PiPL resource file.