Mac Developer Library

Developer

WebKit Framework Reference WebPlugInContainer Protocol Reference

Options
Deployment Target:

On This Page
Language:

WebPlugInContainer

WebPlugInContainer is an informal protocol that enables a plug-in to send messages to the application.

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


import WebKit @import WebKit;

Availability


Available in OS X v10.3.9 and later.
  • Loads a URL into a web frame.

    Declaration

    Swift

    func webPlugInContainerLoadRequest(_ request: NSURLRequest!, inFrame target: String!)

    Objective-C

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

    Parameters

    request

    The request that specifies the URL.

    target

    The frame into which the URL is loaded.

    Discussion

    If the frame specified by target is not found, a new window is opened, loaded with the URL request, and given the specified frame name. If target is nil, the frame enclosing the plug-in is loaded with the URL request.

    Import Statement

    import WebKit

    Availability

    Available in OS X v10.3.9 and later.

  • Tells the container to show a status message.

    Declaration

    Swift

    func webPlugInContainerShowStatus(_ message: String!)

    Objective-C

    - (void)webPlugInContainerShowStatus:(NSString *)message

    Parameters

    message

    The status message to be displayed.

    Import Statement

    import WebKit

    Availability

    Available in OS X v10.3.9 and later.

  • Returns the WebFrame that contains the plug-in.

    Declaration

    Swift

    var webFrame: WebFrame! { get }

    Objective-C

    @property(nonatomic, readonly, strong) WebFrame *webFrame

    Return Value

    The WebFrame that contains the plug-in.

    Discussion

    Only implemented by containers that are based on the WebKit’s plug-in architecture.

    Import Statement

    import WebKit

    Availability

    Available in OS X v10.3.9 and later.

  • Returns the plug-in selection color.

    Declaration

    Swift

    var webPlugInContainerSelectionColor: NSColor! { get }

    Objective-C

    @property(nonatomic, readonly, strong) NSColor *webPlugInContainerSelectionColor

    Return Value

    The plug-in selection color.

    Discussion

    The color should be used for any special drawing when the plug-in is selected.

    Import Statement

    import WebKit

    Availability

    Available in OS X v10.3.9 and later.