addStringParameter(withName:parameterID:defaultValue:parameterFlags:)
Creates a string parameter and adds it to the plug-in’s parameter list.
Declaration
func addStringParameter(withName name: String, parameterID: UInt32, defaultValue: String, parameterFlags flags: FxParameterFlags) -> BoolParameters
- name:
Name of the parameter in the user interface.
- parameterID:
Unique identifier for a parameter. Used to retrieve, set, or validate the parameter.
- defaultValue:
Initial value for the parameter.
- flags:
Flags that encode various state values for the parameter.
Return Value
Returns YES if the application successfully creates a string parameter; NO otherwise.
See Also
Instance Methods
addAngleSlider(withName:parameterID:defaultDegrees:parameterMinDegrees:parameterMaxDegrees:parameterFlags:)addColorParameter(withName:parameterID:defaultRed:defaultGreen:defaultBlue:defaultAlpha:parameterFlags:)addColorParameter(withName:parameterID:defaultRed:defaultGreen:defaultBlue:parameterFlags:)addCustomParameter(withName:parameterID:defaultValue:parameterFlags:)addFloatSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)addFontMenu(withName:parameterID:fontName:parameterFlags:)addGradient(withName:parameterID:parameterFlags:)addHelpButton(withName:parameterID:selector:parameterFlags:)addHistogram(withName:parameterID:parameterFlags:)addImageReference(withName:parameterID:parameterFlags:)addIntSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)addPathPicker(withName:parameterID:parameterFlags:)addPercentSlider(withName:parameterID:defaultValue:parameterMin:parameterMax:sliderMin:sliderMax:delta:parameterFlags:)addPointParameter(withName:parameterID:defaultX:defaultY:parameterFlags:)addPopupMenu(withName:parameterID:defaultValue:menuEntries:parameterFlags:)