WebPlugInViewFactory Protocol Reference
| Conforms to | |
| Framework | /System/Library/Frameworks/WebKit.framework |
| Availability | Available in OS X v10.3.9 and later. |
| Declared in | WebPluginViewFactory.h |
| Companion guides |
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.
Class Methods
plugInViewWithArguments:
Creates a new plug-in view.
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
- Available in OS X v10.3.9 and later.
Declared In
WebPluginViewFactory.hConstants
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
WebPlugInBaseURLKeyThe base URL of the document containing the plug-in's view. Required key.
Available in OS X v10.3 and later.
Declared in
WebPluginViewFactory.h.WebPlugInAttributesKeyThe
NSDictionaryobject 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 allPARAMelements within anAPPLETelement. 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 typeNSString. Required key.Available in OS X v10.3 and later.
Declared in
WebPluginViewFactory.h.WebPlugInContainerKeyAn object that conforms to the
WebPlugInContainerinformal protocol. This object is used for callbacks from the plug-in to the enclosing application. IfWebPlugInContainerKeyisnil, no callbacks will occur.Available in OS X v10.3 and later.
Declared in
WebPluginViewFactory.h.WebPlugInContainingElementKeyIf 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 OS X v10.3 and later.
Declared in
WebPluginViewFactory.h.WebPlugInShouldLoadMainResourceKeyA Boolean value indicating whether the plug-in should load its own main resource (the
srcURL, in most cases). IfYES, the plug-in should load its own main resource. IfNO, the plug-in uses the data provided by WebKit and thewebPlugInMainResourceDidReceiveData:message is sent to the plug-in when data is received. The default value isNO.Available in OS X v10.6 and later.
Declared in
WebPluginViewFactory.h.
© 2010 Apple Inc. All Rights Reserved. (Last updated: 2010-02-24)