1/*
2 * Copyright (C) 2004 Apple 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 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 <Foundation/Foundation.h>
30
31#if !TARGET_OS_IPHONE
32#import <AppKit/AppKit.h>
33#endif
34
35/*!
36    This informal protocol enables a plug-in to request that its containing application
37    perform certain operations.
38*/
39
40@interface NSObject (WebPlugInContainer)
41
42/*!
43    @method webPlugInContainerLoadRequest:inFrame:
44    @abstract Tell the application to show a URL in a target frame
45    @param request The request to be loaded.
46    @param target The target frame. If the frame with the specified target is not
47    found, a new window is opened and the main frame of the new window is named
48    with the specified target.  If nil is specified, the frame that contains
49    the applet is targeted.
50*/
51- (void)webPlugInContainerLoadRequest:(NSURLRequest *)request inFrame:(NSString *)target;
52
53/*!
54    @method webPlugInContainerShowStatus:
55    @abstract Tell the application to show the specified status message.
56    @param message The string to be shown.
57*/
58- (void)webPlugInContainerShowStatus:(NSString *)message;
59
60#if !TARGET_OS_IPHONE
61/*!
62    @property webPlugInContainerSelectionColor
63    @abstract The color that should be used for any special drawing when
64    plug-in is selected.
65*/
66@property (nonatomic, readonly, strong) NSColor *webPlugInContainerSelectionColor;
67#endif
68
69/*!
70    @property webFrame
71    @abstract Allows the plug-in to access the WebFrame that
72    contains the plug-in.  This method will not be implemented by containers that
73    are not WebKit based.
74*/
75@property (nonatomic, readonly, strong) WebFrame *webFrame;
76
77@end
78