Back to Main Site
API Reference
Programming Reference
Programming Guide
Properties on Parameter Descriptors and Instances
Prev
Chapter 16. Properties By Object
Next
Properties on Parameter Descriptors and Instances
Properties Common to All Parameters
The following properties are common to all parameters....
kOfxPropType
, which will always be
kOfxTypeParameter
(read only)
kOfxPropName
read/write in the descriptor, read only on an instance
kOfxPropLabel
read/write in the descriptor and instance
kOfxPropShortLabel
read/write in the descriptor and instance
kOfxPropLongLabel
read/write in the descriptor and instance
kOfxParamPropType
read only in the descriptor and instance, the value is set on construction
kOfxParamPropSecret
read/write in the descriptor and instance
kOfxParamPropHint
read/write in the descriptor and instance
kOfxParamPropScriptName
read/write in the descriptor, read only on an instance
kOfxParamPropParent
read/write in the descriptor, read only on an instance
kOfxParamPropEnabled
read/write in the descriptor and instance
kOfxParamPropDataPtr
read/write in the descriptor and instance
kOfxPropIcon
, read/write on a descriptor, read only on an instance
Properties On Group Parameters
kOfxParamPropGroupOpen
read/write in the descriptor, read only on an instance
Properties Common to All But Group and Page Parameters
kOfxParamPropInteractV1
read/write in the descriptor, read only on an instance
kOfxParamPropInteractSize
read/write in the descriptor, read only on an instance
kOfxParamPropInteractSizeAspect
read/write in the descriptor, read only on an instance
kOfxParamPropInteractMinimumSize
read/write in the descriptor, read only on an instance
kOfxParamPropInteractPreferedSize
read/write in the descriptor, read only on an instance
kOfxParamPropHasHostOverlayHandle
read only in the descriptor and instance
kOfxParamPropUseHostOverlayHandle
read/write in the descriptor and read only in the instance
Properties Common to All Parameters That Hold Values
kOfxParamPropDefault
read/write in the descriptor, read only on an instance
kOfxParamPropAnimates
read/write in the descriptor, read only on an instance
kOfxParamPropIsAnimating
read/write in the descriptor, read only on an instance
kOfxParamPropIsAutoKeying
read/write in the descriptor, read only on an instance
kOfxParamPropPersistant
read/write in the descriptor, read only on an instance
kOfxParamPropEvaluateOnChange
read/write in the descriptor and instance
kOfxParamPropPluginMayWrite
read/write in the descriptor, read only on an instance
kOfxParamPropCacheInvalidation
read/write in the descriptor, read only on an instance
kOfxParamPropCanUndo
read/write in the descriptor, read only on an instance
Properties Common to All Numeric Parameters
kOfxParamPropMin
read/write in the descriptor and instance
kOfxParamPropMax
read/write in the descriptor and instance
kOfxParamPropDisplayMin
read/write in the descriptor and instance
kOfxParamPropDisplayMax
read/write in the descriptor and instance
Properties Common to All Double Parameters
kOfxParamPropIncrement
read/write in the descriptor and instance
kOfxParamPropDigits
read/write in the descriptor and instance
Properties On 1D Double Parameters
kOfxParamPropShowTimeMarker
read/write in the descriptor and instance
kOfxParamPropDoubleType
read/write in the descriptor, read only on an instance
Properties On 2D and 3D Double Parameters
kOfxParamPropDoubleType
read/write in the descriptor, read only on an instance
Properties On Non Normalised Spatial Double Parameters
kOfxParamPropDefaultCoordinateSystem
read/write in the descriptor, read only on an instance
Properties On 2D and 3D Integer Parameters
kOfxParamPropDimensionLabel
read/write in the descriptor, read only on an instance
Properties On String Parameters
kOfxParamPropStringMode
read/write in the descriptor, read only on an instance
kOfxParamPropStringFilePathExists
read/write in the descriptor, read only on an instance
Properties On Choice Parameters
kOfxParamPropChoiceOption
read/write in the descriptor and instance
Properties On Custom Parameters
kOfxParamPropCustomInterpCallbackV1
read/write in the descriptor, read only on an instance
Properties On Page Parameters
kOfxParamPropPageChild
read/write in the descriptor, read only on an instance
On Parametric Parameters
kOfxParamPropAnimates
read/write in the descriptor, read only on an instance
kOfxParamPropIsAnimating
read/write in the descriptor, read only on an instance
kOfxParamPropIsAutoKeying
read/write in the descriptor, read only on an instance
kOfxParamPropPersistant
read/write in the descriptor, read only on an instance
kOfxParamPropEvaluateOnChange
read/write in the descriptor and instance
kOfxParamPropPluginMayWrite
read/write in the descriptor, read only on an instance
kOfxParamPropCacheInvalidation
read/write in the descriptor, read only on an instance
kOfxParamPropCanUndo
read/write in the descriptor, read only on an instance
kOfxParamPropParametricDimension
read/write in the descriptor, read only on an instance
kOfxParamPropParametricUIColour
read/write in the descriptor, read only on an instance
kOfxParamPropParametricInteractBackground
read/write in the descriptor, read only on an instance
kOfxParamPropParametricRange
read/write in the descriptor, read only on an instance