Getting Started

SDK API Reference

SDK API Features

Other Documentation

PITerminology Struct Reference

#include <PIActions.h>

Detailed Description

Maps Photoshop "key" information into human readable text and provides additional type information for values.

This structure is used for two PiPL scripting properties: PIHasTerminologyProperty and PITerminologyProperty.

The "HasTerminology" property indicates whether an 'aete' resource is present and whether your plug-in is scripting-aware for Photoshop and AppleScript. All scripting-aware plug-ins must have an 'aete' dictionary resource. terminologyID should be the resource number for that dictionary. Multiple dictionaries are usually provided when a file contains more than one plug-in.

Scripting-aware Filters, Selection, and Color Picker modules must provide both a classID and an eventID. All other types of plug-ins must provide a classID and pass typeNull="null" for the eventID.

Note:
If a non-filter module does not pass typeNull="null" for eventID, then errors will occur, as the existence of an eventID triggers the host to parse the dictionary as if it was for a Filter, Selection, or Color Picker module.


Data Fields

int32 version
 Version number.
OSType classID
 Object or event class.
OSType eventID
 Event ID, should be typeNull="null" if not an event.
int16 terminologyID
 'aete' resource ID.
char scopeString [1]
 A unique C string that indicates AppleScript is not supported.

Field Documentation

int32 PITerminology::version

Version number.

OSType PITerminology::classID

Object or event class.

OSType PITerminology::eventID

Event ID, should be typeNull="null" if not an event.

int16 PITerminology::terminologyID

'aete' resource ID.

Ignored if the property is PITerminologyProperty

char PITerminology::scopeString[1]

A unique C string that indicates AppleScript is not supported.

This string can be a UUID, or you own trademark or copyright.

Note:
Supplying this string automatically makes the scripting scope for a plug-in apply only to the host. Any external AppleScript or similar calls to the plug-in are ignored. See Ignoring AppleScript for more information.

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