Add afterScreenUpdates to WKSnapshotConfiguration
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKSnapshotConfiguration.h
1 /*
2  * Copyright (C) 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 #if WK_API_ENABLED
29
30 #import <CoreGraphics/CGGeometry.h>
31 #import <Foundation/Foundation.h>
32
33 NS_ASSUME_NONNULL_BEGIN
34
35 WK_CLASS_AVAILABLE(macosx(10.13), ios(11.0))
36 @interface WKSnapshotConfiguration : NSObject <NSCopying>
37
38 /*! @abstract The rect to snapshot in view coordinates.
39  @discussion This rect should be contained within WKWebView's bounds. If the rect is set to the 
40  null rect, the view's bounds will be used. The initial value is the null rect.
41  */
42 @property (nonatomic) CGRect rect;
43
44 /*! @abstract Specify a custom width to control the size of image you get back. The height will be 
45  computed to maintain the aspect ratio established by rect.
46  @discussion snapshotWidth represents the width in points. If the snapshotWidth is nil, rect's
47  width will be used.
48  */
49 @property (nullable, nonatomic, copy) NSNumber *snapshotWidth;
50
51 @property (nonatomic) BOOL afterScreenUpdates WK_API_AVAILABLE(macosx(WK_MAC_TBA), ios(WK_IOS_TBA));
52
53 @end
54
55 NS_ASSUME_NONNULL_END
56
57 #endif