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     This informal protocol enables a plug-in to request that its containing application

    33     perform certain operations.

    34 */

    35 

    36 @interface NSObject (WebPlugInContainer)

    37 

    38 /*!

    39     @method webPlugInContainerLoadRequest:inFrame:

    40     @abstract Tell the application to show a URL in a target frame

    41     @param request The request to be loaded.

    42     @param target The target frame. If the frame with the specified target is not

    43     found, a new window is opened and the main frame of the new window is named

    44     with the specified target.  If nil is specified, the frame that contains

    45     the applet is targeted.

    46 */

    47 - (void)webPlugInContainerLoadRequest:(NSURLRequest *)request inFrame:(NSString *)target;

    48 

    49 /*!

    50     @method webPlugInContainerShowStatus:

    51     @abstract Tell the application to show the specified status message.

    52     @param message The string to be shown.

    53 */

    54 - (void)webPlugInContainerShowStatus:(NSString *)message;

    55 

    56 /*!

    57     @method webPlugInContainerSelectionColor

    58     @result Returns the color that should be used for any special drawing when

    59     plug-in is selected.

    60 */

    61 - (NSColor *)webPlugInContainerSelectionColor;

    62 

    63 /*!

    64     @method webFrame

    65     @discussion The webFrame method allows the plug-in to access the WebFrame that

    66     contains the plug-in.  This method will not be implemented by containers that 

    67     are not WebKit based.

    68     @result Return the WebFrame that contains the plug-in.

    69 */

    70 - (WebFrame *)webFrame;

    71 

    72 @end