|
Getting Started
SDK API Reference
SDK API Features
Other Documentation
|
|
|
Property Keys Recognized by Property Suite CallbacksProperties are either simple (represented by a 32 bit integer) or complex (represented by a handle).
More...
|
#define | propNumberOfChannels 'nuch' |
| Number of channels in the document; (Simple, read-only).
|
#define | propChannelName 'nmch' |
| Name of the channel; (Complex, read-only).
|
#define | propUnicodeChannelName 'unch' |
| Unicode characters for the name of the channel; (Complex, read-only).
|
#define | propTargetLayerLock 'tllk' |
| Lock bits for the target layer; (Simple, read-only).
|
#define | propImageMode 'mode' |
| Mode of the image, returned using the Image Modes constants; (Simple, read-only).
|
#define | propNumberOfPaths 'nupa' |
| Number of paths in the document; (Simple, read-only).
|
#define | propPathName 'nmpa' |
| Name of the indexed path; (Complex, read-only).
|
#define | propUnicodePathName 'unmp' |
| Unicode name of the indexed path; (Complex, read-only).
|
#define | propPathContents 'path' |
| Contents of the indexed path in the format described in the path resources documentation; (Complex, read-only).
|
#define | propPathContentsAI 'paAI' |
| Contents of the path as Illustrator data; (Complex, read-only).
|
#define | propWorkPathIndex 'wkpa' |
| Index of the work path; (Simple, read-only).
|
#define | propClippingPathIndex 'clpa' |
| Index of the clipping path; (Simple, read-only).
|
#define | propTargetPathIndex 'tgpa' |
| Index of the target path; (Simple, read-only).
|
#define | propCaption 'capt' |
| File caption information in a IPTC-NAA record; (Complex, modifiable).
|
#define | propXMP 'xmpd' |
| File XMP meta information in a IPTC-NAA record; (Complex, modifiable).
|
#define | propBigNudgeH 'bndH' |
| Horizontal component of the nudge distance, represented as a 16.16 value; (Simple, modifiable).
|
#define | propBigNudgeV 'bndV' |
| Vertical component of the nudge distance, represented as a 16.16 value; (Simple, modifiable).
|
#define | propInterpolationMethod 'intp' |
| Current interpolation method; (Simple, read-only).
|
#define | propRulerUnits 'rulr' |
| Current ruler units; (Simple, read-only).
|
#define | propRulerOriginH 'rorH' |
| Horizontal component of the current ruler origin, represented as a 16.16 value; (Simple, modifiable).
|
#define | propRulerOriginV 'rorV' |
| Vertical component of the current ruler origin, represented as a 16.16 value; (Simple, modifiable).
|
#define | propGridMajor 'grmj' |
| Current major grid rules, in inches, unless propRulerUnits is pixels, and then pixels; (Simple, modifiable).
|
#define | propGridMinor 'grmn' |
| The current number of grid subdivisions per major rule; (Simple, modifiable).
|
#define | propSerialString 'sstr' |
| The serial number string shown to the user; (Complex, read-only).
|
#define | propSerialString2 'sstR' |
| The serial number string shown to the user; (Complex, read-only).
|
#define | propHardwareGammaTable 'hgam' |
| Hardware gamma table.
|
#define | propInterfaceColor 'iclr' |
| The interface color scheme; (Complex, read-only).
|
#define | propWatchSuspension 'wtch' |
| The watch suspension level; (Simple, modifiable).
|
#define | propCopyright 'cpyr' |
| Whether the current image is considered under copywrite; (Simple, modifiable).
|
#define | propCopyright2 'cpyR' |
| Whether the current image is considered under copywrite; (Simple, modifiable).
|
#define | propWatermark 'watr' |
| Indicates whether a digital signature or watermark is present; (Simple, modifiable).
|
#define | propURL 'URL ' |
| The URL for the current image; (Complex, modifiable).
|
#define | propTitle 'titl' |
| The title of the current document; (Complex, read-only).
|
#define | propDocumentWidth 'docW' |
| The width of the current document in pixels; (Simple, read-only).
|
#define | propDocumentHeight 'docH' |
| The height of the current document in pixels; (Simple, read-only).
|
#define | propSlices 'slcs' |
| The slices for the document; (Complex, modifiable).
|
#define | propSelectedSliceID 'slid' |
| The currently selected slice ID; (Simple, modifiable).
|
#define | propSelectedSliceIDList 'slis' |
| The currently selected slice ID list; (Complex, modifiable).
|
#define | propSelectedSliceIndex 'slin' |
| The currently selected slice index; (Simple, read-only).
|
#define | propShowSliceNumbers 'slsh' |
| Indicate whether the user has set slice numbers to show; (Simple, read-only).
|
#define | propSliceLineColor 'sllc' |
| The color of the slice lines; (Complex, read-only).
|
#define | propToolTips 'tltp' |
| Tool tip display; (Simple, read-only).
|
#define | propPaintCursorKind 'PCrK' |
| Type of paint cursor being used; (Simple, read-only).
|
#define | propPaintCursorShape 'PCrS' |
| Cursor options being used; (Simple, read-only).
|
#define | propPaintCursorCrosshair 'PCrC' |
| Cursor crosshair visibility; (Simple, read-only).
|
#define | propEXIFData 'EXIF' |
| EXIF camera and device data; (Complex, modifiable).
|
#define | propVersion 'vers' |
| Current version of Photoshop.
|
#define | propPlayInProgress 'plip' |
| Action play information, for actions palette or automation plug in; (Simple, read-only).
|
#define | propUnicodeName 'unnm' |
| Unicode name of the document; (Complex, read-only).
|
#define | propUniStr255Name 'u25n' |
| Unicode name of the document; (Complex, read-only).
|
#define | propUnicodeNameWithoutExtension 'neun' |
| Unicode name of the document without extension; (Complex, read-only).
|
#define | propDontShowAgainCount 'DSAC' |
| Global "Don't show again" counter for dialog boxes; (Simple, read-only).
|
#define | propNumberOfLayers 'nuly' |
| Number of layers in the document; (Simple, read-only).
|
#define | propTargetLayerIndex 'tgly' |
| Index of the target layer; (Simple, read-only).
|
#define | propLayerName 'lynm' |
| Layer name of the layer with a given index; (Complex, read-only).
|
#define | propUnicodeLayerName 'lynu' |
| Layer name as a unicode string of the layer with a given index; (Complex, read-only).
|
#define | propPixelScaleFactor 'pxsf' |
| Pixel aspect ratio for the document; (Simple, read-only).
|
#define | propDoingPlace 'DPlc' |
| Current operation is part of a place command; (Simple, read-only).
|
#define | propRasterizingSmartObject 'RsSO' |
| Current operation is part of rasertizing a smart object; (Simple, read-only).
|
#define | propAppIsModal 'aism' |
| Use this property to tell if Photoshop is in a modal dialog or a modal tool.
|
#define | propPixelLength 'MSpl' |
| measurement scale pixel length (Simple)
|
#define | propLogicalLength 'MSll' |
| measurement scale logical length(Simple)
|
#define | propMUnits 'MSun' |
| measurement scale units in unicode string (Complex)
|
#define | propTileSize 'TSiz' |
#define | propAPEIsInitialized 'mnky' |
#define | propScratchVolumeList 'svls' |
#define | propGPUFlags 'GPUF' |
| GPUFlags (Simple, read-only) bits are 0000,anbp,egc0,00mm a=Advanced mode *could* be selected by the user -- it is allowed n=Normal mode *could* be selected by the user -- it is allowed b=Basic mode *could* be selected by the user -- it is allowed e=GPU is enabled g=use OpenGL for computation c=use OpenCL for computation mm=drawing mode, 0.
|
#define | kGPUFlagsModeMask 0x0003 |
#define | kGPUFlagsModeShift 0 |
#define | kGPUFlagsBasic 0 |
#define | kGPUFlagsNormal 1 |
#define | kGPUFlagsAdvanced 2 |
#define | GPUFlagsGetMode(FLAGS) (((FLAGS) & kGPUFlagsModeMask) >> kGPUFlagsModeShift) |
#define | GPUFlagsSetMode(MODE) (((MODE) << kGPUFlagsModeShift) & kGPUFlagsModeMask) |
#define | kGPUFlagsCLCompute 0x0020 |
#define | kGPUFlagsGLCompute 0x0040 |
#define | kGPUFlagsGPUEnabled 0x0080 |
#define | kGPUFlagsGPUPossible 0x0100 |
#define | kGPUFlagsBasicPossible 0x0200 |
#define | kGPUFlagsNormalPossible 0x0400 |
#define | kGPUFlagsAdvancedPossible 0x0800 |
#define | propVRAM_MB 'VRAM' |
#define | propLayerIsSmart 'liss' |
| Use this property to tell if the current layer is a smart object layer.
|
Detailed Description
Properties are either simple (represented by a 32 bit integer) or complex (represented by a handle).
Some properties can be modified by calling SetPropertyProc, others are read-only, and can only be used with GetPropertyProc.
Define Documentation
#define propNumberOfChannels 'nuch' |
Number of channels in the document; (Simple, read-only).
#define propImageMode 'mode' |
Mode of the image, returned using the Image Modes constants; (Simple, read-only).
#define propRulerOriginH 'rorH' |
Horizontal component of the current ruler origin, represented as a 16.16 value; (Simple, modifiable).
#define propChannelName 'nmch' |
Name of the channel; (Complex, read-only).
The channels are indexed from 0 and consist of the composite channels, the transparency mask, the layer mask, and the alpha channels.
#define propUnicodeChannelName 'unch' |
Unicode characters for the name of the channel; (Complex, read-only).
#define propTargetLayerLock 'tllk' |
#define propNumberOfPaths 'nupa' |
Number of paths in the document; (Simple, read-only).
#define propPathName 'nmpa' |
Name of the indexed path; (Complex, read-only).
The paths are indexed starting with zero. A complex, read-only property.
#define propUnicodePathName 'unmp' |
Unicode name of the indexed path; (Complex, read-only).
#define propPathContents 'path' |
Contents of the indexed path in the format described in the path resources documentation; (Complex, read-only).
The paths are indexed starting with zero. The data is stored in big endian form. Refer to chapter 10 for more information on path data.
#define propPathContentsAI 'paAI' |
Contents of the path as Illustrator data; (Complex, read-only).
The paths are indexed starting with zero.
#define propWorkPathIndex 'wkpa' |
Index of the work path; (Simple, read-only).
The value of the property is -1 if no work path.
#define propClippingPathIndex 'clpa' |
Index of the clipping path; (Simple, read-only).
The value of the property is -1 if no clipping path.
#define propTargetPathIndex 'tgpa' |
Index of the target path; (Simple, read-only).
The value of the property is -1 if no target path.
#define propCaption 'capt' |
File caption information in a IPTC-NAA record; (Complex, modifiable).
For more information, see Photoshop File Formats.pdf.
File XMP meta information in a IPTC-NAA record; (Complex, modifiable).
#define propBigNudgeH 'bndH' |
Horizontal component of the nudge distance, represented as a 16.16 value; (Simple, modifiable).
This is the value used when moving around using the shift key. The default value is ten pixels.
#define propBigNudgeV 'bndV' |
Vertical component of the nudge distance, represented as a 16.16 value; (Simple, modifiable).
This is the value used when moving around using the shift key. The default value is ten pixels.
#define propInterpolationMethod 'intp' |
Current interpolation method; (Simple, read-only).
1=point sample, 2=bilinear, 3=bicubic.
#define propRulerUnits 'rulr' |
Current ruler units; (Simple, read-only).
For values, see RulerUnits.
#define propRulerOriginV 'rorV' |
Vertical component of the current ruler origin, represented as a 16.16 value; (Simple, modifiable).
#define propGridMajor 'grmj' |
Current major grid rules, in inches, unless propRulerUnits is pixels, and then pixels; (Simple, modifiable).
Represented as 16.16 value.
#define propGridMinor 'grmn' |
The current number of grid subdivisions per major rule; (Simple, modifiable).
#define propSerialString 'sstr' |
The serial number string shown to the user; (Complex, read-only).
DEPRECATED - Use propSerialString2 below
#define propSerialString2 'sstR' |
The serial number string shown to the user; (Complex, read-only).
#define propHardwareGammaTable 'hgam' |
Hardware gamma table.
Only valid for Windows; (Complex, read-only).
#define propInterfaceColor 'iclr' |
The interface color scheme; (Complex, read-only).
Allows a plug-in interface to mimic system colors. The handle returned from getPropertyProc can be cast as a PIInterfaceColor structure. - Note:
- Currently, user-selected system colors are supported on Windows; when they are available on MAC OS, they will likely be supported in future versions of Photoshop through this same mechanism.
The color scheme is indexed, see Interface Color Indexes for index values to pass into getPropertyProc . These interface color values map onto Photoshop system colors according to the following diagram:
Constants are remapped to create the system look. Use the indexed color scheme to draw PICTs.
#define propWatchSuspension 'wtch' |
The watch suspension level; (Simple, modifiable).
When non-zero, a plug-in can make callbacks to the host without fear that the watch will start spinning. It is reset to zero at the beginning of each call from the host to the plug-in.
#define propCopyright 'cpyr' |
Whether the current image is considered under copywrite; (Simple, modifiable).
This property key can only be used to set the flag.
#define propCopyright2 'cpyR' |
Whether the current image is considered under copywrite; (Simple, modifiable).
#define propWatermark 'watr' |
Indicates whether a digital signature or watermark is present; (Simple, modifiable).
The (c) copyright symbol will appear if this is set, or if the user has checked the copyrightproperty in the File Info dialog. Do not turn the copyright flag off, ever. Use to indicate if you’ve found your digital signature.
The URL for the current image; (Complex, modifiable).
The title of the current document; (Complex, read-only).
#define propDocumentWidth 'docW' |
The width of the current document in pixels; (Simple, read-only).
#define propDocumentHeight 'docH' |
The height of the current document in pixels; (Simple, read-only).
#define propSlices 'slcs' |
The slices for the document; (Complex, modifiable).
See the Slices resource format documented in Photoshop File Formats.pdf.
#define propSelectedSliceID 'slid' |
The currently selected slice ID; (Simple, modifiable).
#define propSelectedSliceIDList 'slis' |
The currently selected slice ID list; (Complex, modifiable).
#define propSelectedSliceIndex 'slin' |
The currently selected slice index; (Simple, read-only).
#define propShowSliceNumbers 'slsh' |
Indicate whether the user has set slice numbers to show; (Simple, read-only).
#define propSliceLineColor 'sllc' |
The color of the slice lines; (Complex, read-only).
#define propToolTips 'tltp' |
Tool tip display; (Simple, read-only).
The value is 0 if off, 1 if on.
#define propPaintCursorKind 'PCrK' |
Type of paint cursor being used; (Simple, read-only).
1 = standard; 2 = precise; 3 = brush size.
#define propPaintCursorShape 'PCrS' |
Cursor options being used; (Simple, read-only).
1 = normal; 2 = full sized.
#define propPaintCursorCrosshair 'PCrC' |
Cursor crosshair visibility; (Simple, read-only).
0 = not visible; 1 = visible.
#define propEXIFData 'EXIF' |
EXIF camera and device data; (Complex, modifiable).
The EXIF property is controlled by The Japan Electronic Industry Development Association (JEIDA) and Electronic Industries Association of Japan (EIAJ) which merged in November of 2000. The EXIF specification can be downloaded from their web site at the following location: http://it.jeita.or.jp/jhistory/document/standard/exif_eng/jeida49eng.htm
#define propVersion 'vers' |
Current version of Photoshop.
Major.Minor.Fix
#define propPlayInProgress 'plip' |
Action play information, for actions palette or automation plug in; (Simple, read-only).
#define propUnicodeName 'unnm' |
Unicode name of the document; (Complex, read-only).
#define propUniStr255Name 'u25n' |
Unicode name of the document; (Complex, read-only).
#define propUnicodeNameWithoutExtension 'neun' |
Unicode name of the document without extension; (Complex, read-only).
#define propDontShowAgainCount 'DSAC' |
Global "Don't show again" counter for dialog boxes; (Simple, read-only).
The property value is incremented every time these dialogs are reset. Each dialog that supports this feature should maintain its own unsigned32 counter in the preferences file. It should be initialized to zero. Before showing the dialog, the local counter should be compared to the global counter. If equal, don't show the dialog. When the user checks the "Don't show again" check box, the local counter should be set to the master counter.
#define propNumberOfLayers 'nuly' |
Number of layers in the document; (Simple, read-only).
#define propTargetLayerIndex 'tgly' |
Index of the target layer; (Simple, read-only).
#define propLayerName 'lynm' |
Layer name of the layer with a given index; (Complex, read-only).
#define propUnicodeLayerName 'lynu' |
Layer name as a unicode string of the layer with a given index; (Complex, read-only).
#define propPixelScaleFactor 'pxsf' |
Pixel aspect ratio for the document; (Simple, read-only).
#define propDoingPlace 'DPlc' |
Current operation is part of a place command; (Simple, read-only).
Provided for file formats that need to record descriptors differently when placing.
#define propRasterizingSmartObject 'RsSO' |
Current operation is part of rasertizing a smart object; (Simple, read-only).
Provided for file formats that need to read/obey descriptors differently when rasterizing.
#define propAppIsModal 'aism' |
Use this property to tell if Photoshop is in a modal dialog or a modal tool.
(Simple)
#define propPixelLength 'MSpl' |
measurement scale pixel length (Simple)
#define propLogicalLength 'MSll' |
measurement scale logical length(Simple)
#define propMUnits 'MSun' |
measurement scale units in unicode string (Complex)
#define propTileSize 'TSiz' |
#define propAPEIsInitialized 'mnky' |
#define propScratchVolumeList 'svls' |
#define propGPUFlags 'GPUF' |
GPUFlags (Simple, read-only) bits are 0000,anbp,egc0,00mm a=Advanced mode *could* be selected by the user -- it is allowed n=Normal mode *could* be selected by the user -- it is allowed b=Basic mode *could* be selected by the user -- it is allowed e=GPU is enabled g=use OpenGL for computation c=use OpenCL for computation mm=drawing mode, 0.
.2
#define kGPUFlagsModeMask 0x0003 |
#define kGPUFlagsModeShift 0 |
#define kGPUFlagsNormal 1 |
#define kGPUFlagsAdvanced 2 |
#define GPUFlagsGetMode |
( |
FLAGS |
|
) |
(((FLAGS) & kGPUFlagsModeMask) >> kGPUFlagsModeShift) |
#define GPUFlagsSetMode |
( |
MODE |
|
) |
(((MODE) << kGPUFlagsModeShift) & kGPUFlagsModeMask) |
#define kGPUFlagsCLCompute 0x0020 |
#define kGPUFlagsGLCompute 0x0040 |
#define kGPUFlagsGPUEnabled 0x0080 |
#define kGPUFlagsGPUPossible 0x0100 |
#define kGPUFlagsBasicPossible 0x0200 |
#define kGPUFlagsNormalPossible 0x0400 |
#define kGPUFlagsAdvancedPossible 0x0800 |
#define propVRAM_MB 'VRAM' |
#define propLayerIsSmart 'liss' |
Use this property to tell if the current layer is a smart object layer.
(Simple)
|
|