Mac OS X Reference Library Apple Developer Connection spyglass button

WebPlugInViewFactory Protocol Reference

Conforms to
Framework
/System/Library/Frameworks/WebKit.framework
Availability
Available in Mac OS X v10.3.9 and later.
Declared in
WebPluginViewFactory.h
Companion guides
Related sample code

Overview

A WebPlugInViewFactory object is used to create an NSView for a plug-in. The principal class in a plug-in bundle must conform to this protocol.

Tasks

Creating the Plug-in View

Class Methods

plugInViewWithArguments:

Creates a new plug-in view. (required)

+ (NSView *)plugInViewWithArguments:(NSDictionary *)arguments

Parameters
arguments

Arguments used in creating the view.

Return Value

The created view.

Discussion

This method returns an NSView object that conforms to the WebPlugIn informal protocol. The arguments dictionary should be specified by the keys and objects described in “Constants.” This method is required.

Availability
Declared In
WebPluginViewFactory.h

Constants

Plug-in View Dictionary Keys

The following constants define the keys used to access the values in the arguments dictionary passed in to the plugInViewWithArguments:method. Note that WebPlugInBaseURLKey and WebPlugInAttributesKey will always correspond to data, the others may be nil.

extern NSString *WebPlugInBaseURLKey;
extern NSString *WebPlugInAttributesKey;
extern NSString *WebPlugInContainerKey;
extern NSString *WebPlugInContainingElementKey;
extern NSString *WebPlugInShouldLoadMainResourceKey;
Constants
WebPlugInBaseURLKey

The base URL of the document containing the plug-in's view. Required key.

Available in Mac OS X v10.3 and later.

Declared in WebPluginViewFactory.h.

WebPlugInAttributesKey

The NSDictionary object containing all names and values of all attributes of the plug-in’s associated HTML element, as well as all names and values of the parameters to be passed to the plug-in. For example, this dictionary will contain all PARAM elements within an APPLET element. If attribute and parameter names conflict, the attributes of an element take precedence over any of its parameters. All keys and values in this dictionary must be of type NSString. Required key.

Available in Mac OS X v10.3 and later.

Declared in WebPluginViewFactory.h.

WebPlugInContainerKey

An object that conforms to the WebPlugInContainer informal protocol. This object is used for callbacks from the plug-in to the enclosing application. If WebPlugInContainerKey is nil, no callbacks will occur.

Available in Mac OS X v10.3 and later.

Declared in WebPluginViewFactory.h.

WebPlugInContainingElementKey

If an element of the page’s Document Object Model was used to specify the plug-in, this will contain that element. Otherwise, it will be nil.

Available in Mac OS X v10.3 and later.

Declared in WebPluginViewFactory.h.

WebPlugInShouldLoadMainResourceKey

A Boolean value indicating whether the plug-in should load its own main resource (the src URL, in most cases). If YES, the plug-in should load its own main resource. If NO, the plug-in uses the data provided by WebKit and the webPlugInMainResourceDidReceiveData: message is sent to the plug-in when data is received. The default value is NO.

Available in Mac OS X v10.6 and later.

Declared in WebPluginViewFactory.h.


Last updated: 2009-03-30

Did this document help you? Yes It's good, but... Not helpful...