ADC Home > Reference Library > Reference > Apple Applications > Final Cut Pro/Final Cut Express > FxPlug Reference

 


FxCustomParameterViewHost

Declared In:

Introduction

Defines the methods a plug-in needs to implement to associate a custom NSView with one of its parameters.

Discussion

An FxPlug that wants to present custom UI for one or more of its parameters must conform to the FxCustomParmeterViewHost protocol. This protocol allows the plug-in to provide a subclass of NSView. It is up to the plug-in to handle NSEvents in its custom view(s). When an event in a custom view necessitates a change to the value of the associated parameter, the plug-in then uses methods in the host API FxCustomParameterActionAPI to tell the host application to change the parameter value.



Methods

-createViewForParm:
Provides an NSView to be associated with the given parameter.

createViewForParm:


Provides an NSView to be associated with the given parameter.

- (NSView *)createViewForParm:(UInt32)parmId;
Parameters
parmId
The ID of the parameter to be associated with the custom UI.
Return Value

An NSView or subclass of NSView.

Discussion

This plug-in method is called by the host application during the parameter-list setup sequence, once for each plug-in parameter that has the kFxParameterFlag_CUSTOM_UI parameter flag set. The view may be created dynamically, or, more commonly, retrieved from a NIB file in the plug-in's resources directory.
NOTE: The object returned by this method should not be autoreleased. It should be allocated by the method, and will be released by the caller. The implementation may look something like this:
if ( parmId == kMyViewParmID ) return [[MyView alloc] init];


Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.
Last Updated: 2008-06-05