WKFrameInfo.h 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. /*
  2. * Copyright (C) 2014-2017 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. * 1. Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * 2. Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. *
  13. * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15. * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17. * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23. * THE POSSIBILITY OF SUCH DAMAGE.
  24. */
  25. #import <WebKit/WKFoundation.h>
  26. #import <Foundation/Foundation.h>
  27. #import <WebKit/WKSecurityOrigin.h>
  28. #import <WebKit/WKWebView.h>
  29. /*! A WKFrameInfo object contains information about a frame on a webpage.
  30. @discussion An instance of this class is a transient, data-only object;
  31. it does not uniquely identify a frame across multiple delegate method
  32. calls.
  33. */
  34. NS_ASSUME_NONNULL_BEGIN
  35. WK_EXTERN API_AVAILABLE(macos(10.10), ios(8.0))
  36. @interface WKFrameInfo : NSObject <NSCopying>
  37. /*! @abstract A Boolean value indicating whether the frame is the main frame
  38. or a subframe.
  39. */
  40. @property (nonatomic, readonly, getter=isMainFrame) BOOL mainFrame;
  41. /*! @abstract The frame's current request.
  42. */
  43. @property (nonatomic, readonly, copy) NSURLRequest *request;
  44. /*! @abstract The frame's current security origin.
  45. */
  46. @property (nonatomic, readonly) WKSecurityOrigin *securityOrigin API_AVAILABLE(macos(10.11), ios(9.0));
  47. /*! @abstract The web view of the webpage that contains this frame.
  48. */
  49. @property (nonatomic, readonly, weak) WKWebView *webView API_AVAILABLE(macos(10.13), ios(11.0));
  50. @end
  51. NS_ASSUME_NONNULL_END