Add cheat sheet comment for HashMap/Set iterator/AddResult
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKPreferences.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 <CoreGraphics/CoreGraphics.h>
29 #import <Foundation/Foundation.h>
30
31 /*! A WKPreferences object encapsulates the preference settings for a web
32  view. The preferences object associated with a web view is specified by
33  its web view configuration.
34  */
35 WK_CLASS_AVAILABLE(macos(10.10), ios(8.0))
36 @interface WKPreferences : NSObject <NSSecureCoding>
37
38 /*! @abstract The minimum font size in points.
39  @discussion The default value is 0.
40  */
41 @property (nonatomic) CGFloat minimumFontSize;
42
43 /*! @abstract A Boolean value indicating whether JavaScript is enabled.
44  @discussion The default value is YES.
45  */
46 @property (nonatomic) BOOL javaScriptEnabled;
47
48 /*! @abstract A Boolean value indicating whether JavaScript can open
49  windows without user interaction.
50  @discussion The default value is NO in iOS and YES in OS X.
51  */
52 @property (nonatomic) BOOL javaScriptCanOpenWindowsAutomatically;
53
54 /*! @abstract A Boolean value indicating whether warnings should be
55  shown for suspected fraudulent content such as phishing or malware.
56  @discussion The default value is YES. This feature is currently available
57  in the following region: China.
58  */
59 @property (nonatomic, getter=isFraudulentWebsiteWarningEnabled) BOOL fraudulentWebsiteWarningEnabled WK_API_AVAILABLE(macos(WK_MAC_TBA), ios(WK_IOS_TBA));
60
61 #if !TARGET_OS_IPHONE
62 /*!
63  @property tabFocusesLinks
64  @abstract If tabFocusesLinks is YES, the tab key will focus links and form controls.
65  The Option key temporarily reverses this preference.
66  */
67 @property (nonatomic) BOOL tabFocusesLinks WK_API_AVAILABLE(macos(10.12.3));
68 #endif
69
70 @end
71
72 @interface WKPreferences (WKDeprecated)
73
74 @property (nonatomic) BOOL javaEnabled WK_API_DEPRECATED("Java is no longer supported", macos(10.10, WK_MAC_TBA));
75 @property (nonatomic) BOOL plugInsEnabled WK_API_DEPRECATED("Plug-ins are no longer supported", macos(10.10, WK_MAC_TBA));
76
77 @end