Unreviewed, fix iOS build with recent SDKs.
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKFrameInfo.h
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
26 #import <WebKit/WKFoundation.h>
27
28 #import <Foundation/Foundation.h>
29 #import <WebKit/WKSecurityOrigin.h>
30 #import <WebKit/WKWebView.h>
31
32 /*! A WKFrameInfo object contains information about a frame on a webpage.
33  @discussion An instance of this class is a transient, data-only object;
34  it does not uniquely identify a frame across multiple delegate method
35  calls.
36  */
37 NS_ASSUME_NONNULL_BEGIN
38
39 WK_CLASS_AVAILABLE(macos(10.10), ios(8.0))
40 @interface WKFrameInfo : NSObject <NSCopying>
41
42 /*! @abstract A Boolean value indicating whether the frame is the main frame
43  or a subframe.
44  */
45 @property (nonatomic, readonly, getter=isMainFrame) BOOL mainFrame;
46
47 /*! @abstract The frame's current request.
48  */
49 @property (nonatomic, readonly, copy) NSURLRequest *request;
50
51 /*! @abstract The frame's current security origin.
52  */
53 @property (nonatomic, readonly) WKSecurityOrigin *securityOrigin WK_API_AVAILABLE(macos(10.11), ios(9.0));
54
55 /*! @abstract The web view of the webpage that contains this frame.
56  */
57 @property (nonatomic, readonly, weak) WKWebView *webView WK_API_AVAILABLE(macos(10.13), ios(11.0));
58
59 @end
60
61 NS_ASSUME_NONNULL_END