IKFilterCustomUIProvider Protocol Reference

Framework
System/Library/Frameworks/Quartz.framework/ImageKit.framework
Availability
Available in OS X v10.5 and later.
Declared in
IKFilterUI.h

Overview

The IKFilterCustomUIProvider protocol is an addition to the CIFilter class that defines a method for providing a view for a filter. This protocol is implemented by any filter that provides its own user interface.

Tasks

Providing a Custom View

Instance Methods

provideViewForUIConfiguration:excludedKeys:

Provides a custom view for a filter. (required)

-(IKFilterUIView*)provideViewForUIConfiguration:(NSDictionary*)inUIConfiguration excludedKeys:(NSArray*)inKeys
Parameters
inUIConfiguration

A dictionary that specifies the size of the controls. Provide the key IKUISizeFlavor and one of the following values: IKUISizeMini, IKUISizeSmall, or IKUISizeRegular. For more information on these constants, see User Interface Options in CIFilter Image Kit Additions.

inKeys

An array of the input keys for which you do not want to provide a user interface. Pass nil if you want all input keys to be represented in the user interface.

Return Value

An IKFilterUIView object or nil if the filter is unable to provide a view. If nil, the Image Kit framework will attempt to provide a user interface.

Discussion

This method overrides the method viewForUIConfiguration:excludedKeys:.

Availability
  • Available in OS X v10.5 and later.
Declared In
IKFilterUI.h