← Back to branch summary

~ubuntu-branches/ubuntu/maverick/webkit/maverick

« back to all changes in this revision

Viewing changes to WebKit/Plugins/WebPluginViewFactory.h

  • Committer: Bazaar Package Importer
  • Author(s): Mike Hommey
  • Date: 2007-08-19 15:54:12 UTC
  • Revision ID: james.westby@ubuntu.com-20070819155412-uxxg1h9plpghmtbi
Tags: upstream-0~svn25144
Import upstream version 0~svn25144

Show diffs side-by-side

added added

removed removed

Lines of Context:
WebKit/Plugins/WebPluginViewFactory.h
 
1
/*
 
2
 * Copyright (C) 2004 Apple Computer, Inc.  All rights reserved.
 
3
 *
 
4
 * Redistribution and use in source and binary forms, with or without
 
5
 * modification, are permitted provided that the following conditions
 
6
 * are met:
 
7
 *
 
8
 * 1.  Redistributions of source code must retain the above copyright
 
9
 *     notice, this list of conditions and the following disclaimer. 
 
10
 * 2.  Redistributions in binary form must reproduce the above copyright
 
11
 *     notice, this list of conditions and the following disclaimer in the
 
12
 *     documentation and/or other materials provided with the distribution. 
 
13
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 
14
 *     its contributors may be used to endorse or promote products derived
 
15
 *     from this software without specific prior written permission. 
 
16
 *
 
17
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 
18
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 
19
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 
20
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 
21
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 
22
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 
23
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 
24
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
27
 */
 
28
 
 
29
#import <Cocoa/Cocoa.h>
 
30
 
 
31
/*!
 
32
    @constant WebPlugInBaseURLKey REQUIRED. The base URL of the document containing
 
33
    the plug-in's view.
 
34
*/
 
35
extern NSString *WebPlugInBaseURLKey;
 
36
 
 
37
/*!
 
38
    @constant WebPlugInAttributesKey REQUIRED. The dictionary containing the names
 
39
    and values of all attributes of the HTML element associated with the plug-in AND
 
40
    the names and values of all parameters to be passed to the plug-in (e.g. PARAM
 
41
    elements within an APPLET element). In the case of a conflict between names,
 
42
    the attributes of an element take precedence over any PARAMs.  All of the keys
 
43
    and values in this NSDictionary must be NSStrings.
 
44
*/
 
45
extern NSString *WebPlugInAttributesKey;
 
46
 
 
47
/*!
 
48
    @constant WebPlugInContainer OPTIONAL. An object that conforms to the
 
49
    WebPlugInContainer informal protocol. This object is used for
 
50
    callbacks from the plug-in to the app. if this argument is nil, no callbacks will
 
51
    occur.
 
52
*/
 
53
extern NSString *WebPlugInContainerKey;
 
54
 
 
55
/*!
 
56
    @constant WebPlugInContainingElementKey The DOMElement that was used to specify
 
57
    the plug-in.  May be nil.
 
58
*/
 
59
extern NSString *WebPlugInContainingElementKey;
 
60
 
 
61
/*!
 
62
    @protocol WebPlugInViewFactory
 
63
    @discussion WebPlugInViewFactory are used to create the NSView for a plug-in.
 
64
    The principal class of the plug-in bundle must implement this protocol.
 
65
*/
 
66
 
 
67
@protocol WebPlugInViewFactory <NSObject>
 
68
 
 
69
/*!
 
70
    @method plugInViewWithArguments: 
 
71
    @param arguments The arguments dictionary with the mentioned keys and objects. This method is required to implement.
 
72
    @result Returns an NSView object that conforms to the WebPlugIn informal protocol.
 
73
*/
 
74
+ (NSView *)plugInViewWithArguments:(NSDictionary *)arguments;
 
75
 
 
76
@end