PIProperties.h File Reference

This file contains the public definitions and structures for the properties callback suite. More...

Go to the source code of this file.

#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.

Defines

#define propTargetLayerLockNone   0x0
 No layer lock bit.
#define propTargetLayerLockTransparency   0x1 << 0
 Transparency layer lock bit.
#define propTargetLayerLockComposite   0x1 << 1
 Composite layer lock bit.
#define propTargetLayerLockPosition   0x1 << 2
 Position layer lock bit.

Enumerations

enum  RulerUnits {
  kRulerPixels,
  kRulerInches,
  kRulerCm,
  kRulerMillimeters,
  kRulerPoints,
  kRulerPicas,
  kRulerPercent
}
 Types of ruler units. More...

Detailed Description

This file contains the public definitions and structures for the properties callback suite.

If you are working with any properties via the properties or action get mechanisms, this documents what is available and its basic format.

Distribution: PUBLIC


Enumeration Type Documentation

enum RulerUnits

Types of ruler units.

Enumerator:
kRulerPixels  Ruler units in pixels.
kRulerInches  Ruler units in inches.
kRulerCm  Ruler units in centimeters.
kRulerMillimeters  Rule units in millimeters.

Type units in Japan (Q/Ha saved for 7)

kRulerPoints  Ruler units in points.
kRulerPicas  Ruler units in picas.
kRulerPercent  Ruler units in percent.