WebPluginContainer.h 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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. #import <Cocoa/Cocoa.h>
  29. /*!
  30. This informal protocol enables a plug-in to request that its containing application
  31. perform certain operations.
  32. */
  33. @interface NSObject (WebPlugInContainer)
  34. /*!
  35. @method webPlugInContainerLoadRequest:inFrame:
  36. @abstract Tell the application to show a URL in a target frame
  37. @param request The request to be loaded.
  38. @param target The target frame. If the frame with the specified target is not
  39. found, a new window is opened and the main frame of the new window is named
  40. with the specified target. If nil is specified, the frame that contains
  41. the applet is targeted.
  42. */
  43. - (void)webPlugInContainerLoadRequest:(NSURLRequest *)request inFrame:(NSString *)target;
  44. /*!
  45. @method webPlugInContainerShowStatus:
  46. @abstract Tell the application to show the specified status message.
  47. @param message The string to be shown.
  48. */
  49. - (void)webPlugInContainerShowStatus:(NSString *)message;
  50. /*!
  51. @method webPlugInContainerSelectionColor
  52. @result Returns the color that should be used for any special drawing when
  53. plug-in is selected.
  54. */
  55. - (NSColor *)webPlugInContainerSelectionColor;
  56. /*!
  57. @method webFrame
  58. @discussion The webFrame method allows the plug-in to access the WebFrame that
  59. contains the plug-in. This method will not be implemented by containers that
  60. are not WebKit based.
  61. @result Return the WebFrame that contains the plug-in.
  62. */
  63. - (WebFrame *)webFrame;
  64. @end