Move more WKPreferences to WKWebViewConfiguration
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / Cocoa / WKPreferences.h
1 /*
2  * Copyright (C) 2014 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/CoreGraphics.h>
31 #import <Foundation/Foundation.h>
32
33 /*! A WKPreferences object encapsulates the preference settings for a web
34  view. The preferences object associated with a web view is specified by
35  its web view configuration.
36  */
37 WK_CLASS_AVAILABLE(10_10, 8_0)
38 @interface WKPreferences : NSObject
39
40 /*! @abstract Returns an initialized preferences object.
41  @param userDefaultsKeyPrefix The user defaults key prefix.
42  @result An initialized preferences object.
43  @discussion If the userDefaultsKeyPrefix parameter is not nil, it is
44  prepended to the keys used to store preferences in the user defaults
45  database. If the parameter is nil, the preferences object will not save
46  anything to the user defaults database.
47  */
48 - (instancetype)initWithUserDefaultsKeyPrefix:(NSString *)userDefaultsKeyPrefix WK_DESIGNATED_INITIALIZER;
49
50 /*! @abstract The user defaults key prefix.
51  */
52 @property (nonatomic, readonly) NSString *userDefaultsKeyPrefix;
53
54 /*! @abstract The minimum font size in points.
55  @discussion The default value is 0.
56  */
57 @property (nonatomic) CGFloat minimumFontSize;
58
59 /*! @abstract A Boolean value indicating whether JavaScript is enabled.
60  @discussion The default value is YES.
61  */
62 @property (nonatomic, getter=isJavaScriptEnabled) BOOL javaScriptEnabled;
63
64 /*! @abstract A Boolean value indicating whether JavaScript can open
65  windows without user interaction.
66  @discussion The default value is NO in iOS and YES in OS X.
67  */
68 @property (nonatomic) BOOL javaScriptCanOpenWindowsAutomatically;
69
70 #if !TARGET_OS_IPHONE
71 /*! @abstract A Boolean value indicating whether Java is enabled.
72  @discussion The default value is YES.
73  */
74 @property (nonatomic, getter=isJavaEnabled) BOOL javaEnabled;
75
76 /*! @abstract A Boolean value indicating whether plug-ins are enabled.
77  @discussion The default value is YES.
78  */
79 @property (nonatomic, getter=arePlugInsEnabled) BOOL plugInsEnabled;
80 #endif
81
82 @end
83
84 #endif