webpreferences.h revision b76d682e577a78ae238af2584c91351331c8ea61
1// Copyright 2013 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4//
5// A struct for managing webkit's settings.
6//
7// Adding new values to this class probably involves updating
8// WebKit::WebSettings, content/common/view_messages.h, browser/tab_contents/
9// render_view_host_delegate_helper.cc, and browser/profiles/profile.cc.
10
11#ifndef WEBKIT_COMMON_WEBPREFERENCES_H__
12#define WEBKIT_COMMON_WEBPREFERENCES_H__
13
14#include <map>
15#include <string>
16#include <vector>
17
18#include "base/strings/string16.h"
19#include "url/gurl.h"
20#include "webkit/common/webkit_common_export.h"
21
22namespace WebKit {
23class WebView;
24}
25
26struct WebPreferences;
27
28namespace webkit_glue {
29
30// Map of ISO 15924 four-letter script code to font family.  For example,
31// "Arab" to "My Arabic Font".
32typedef std::map<std::string, base::string16> ScriptFontFamilyMap;
33
34typedef std::vector<std::pair<std::string, std::string> >
35    WebInspectorPreferences;
36
37enum EditingBehavior {
38  EDITING_BEHAVIOR_MAC,
39  EDITING_BEHAVIOR_WIN,
40  EDITING_BEHAVIOR_UNIX,
41  EDITING_BEHAVIOR_ANDROID
42};
43
44
45// The ISO 15924 script code for undetermined script aka Common. It's the
46// default used on WebKit's side to get/set a font setting when no script is
47// specified.
48WEBKIT_COMMON_EXPORT extern const char kCommonScript[];
49
50}  // namespace webkit_glue
51
52struct WEBKIT_COMMON_EXPORT WebPreferences {
53  webkit_glue::ScriptFontFamilyMap standard_font_family_map;
54  webkit_glue::ScriptFontFamilyMap fixed_font_family_map;
55  webkit_glue::ScriptFontFamilyMap serif_font_family_map;
56  webkit_glue::ScriptFontFamilyMap sans_serif_font_family_map;
57  webkit_glue::ScriptFontFamilyMap cursive_font_family_map;
58  webkit_glue::ScriptFontFamilyMap fantasy_font_family_map;
59  webkit_glue::ScriptFontFamilyMap pictograph_font_family_map;
60  int default_font_size;
61  int default_fixed_font_size;
62  int minimum_font_size;
63  int minimum_logical_font_size;
64  std::string default_encoding;
65  bool javascript_enabled;
66  bool web_security_enabled;
67  bool javascript_can_open_windows_automatically;
68  bool loads_images_automatically;
69  bool images_enabled;
70  bool plugins_enabled;
71  bool dom_paste_enabled;
72  webkit_glue::WebInspectorPreferences inspector_settings;
73  bool site_specific_quirks_enabled;
74  bool shrinks_standalone_images_to_fit;
75  bool uses_universal_detector;
76  bool text_areas_are_resizable;
77  bool java_enabled;
78  bool allow_scripts_to_close_windows;
79  bool remote_fonts_enabled;
80  bool javascript_can_access_clipboard;
81  bool xss_auditor_enabled;
82  // We don't use dns_prefetching_enabled to disable DNS prefetching.  Instead,
83  // we disable the feature at a lower layer so that we catch non-WebKit uses
84  // of DNS prefetch as well.
85  bool dns_prefetching_enabled;
86  bool local_storage_enabled;
87  bool databases_enabled;
88  bool application_cache_enabled;
89  bool tabs_to_links;
90  bool caret_browsing_enabled;
91  bool hyperlink_auditing_enabled;
92  bool is_online;
93  bool user_style_sheet_enabled;
94  GURL user_style_sheet_location;
95  bool author_and_user_styles_enabled;
96  bool allow_universal_access_from_file_urls;
97  bool allow_file_access_from_file_urls;
98  bool webaudio_enabled;
99  bool experimental_webgl_enabled;
100  bool flash_3d_enabled;
101  bool flash_stage3d_enabled;
102  bool flash_stage3d_baseline_enabled;
103  bool gl_multisampling_enabled;
104  bool privileged_webgl_extensions_enabled;
105  bool webgl_errors_to_console_enabled;
106  bool accelerated_compositing_for_overflow_scroll_enabled;
107  bool accelerated_compositing_for_scrollable_frames_enabled;
108  bool composited_scrolling_for_frames_enabled;
109  bool mock_scrollbars_enabled;
110  bool threaded_html_parser;
111  bool show_paint_rects;
112  bool asynchronous_spell_checking_enabled;
113  bool unified_textchecker_enabled;
114  bool accelerated_compositing_enabled;
115  bool force_compositing_mode;
116  bool accelerated_compositing_for_3d_transforms_enabled;
117  bool accelerated_compositing_for_animation_enabled;
118  bool accelerated_compositing_for_video_enabled;
119  bool accelerated_2d_canvas_enabled;
120  int minimum_accelerated_2d_canvas_size;
121  bool antialiased_2d_canvas_disabled;
122  bool accelerated_filters_enabled;
123  bool gesture_tap_highlight_enabled;
124  bool accelerated_compositing_for_plugins_enabled;
125  bool memory_info_enabled;
126  bool fullscreen_enabled;
127  bool allow_displaying_insecure_content;
128  bool allow_running_insecure_content;
129  bool password_echo_enabled;
130  bool should_print_backgrounds;
131  bool should_clear_document_background;
132  bool enable_scroll_animator;
133  bool visual_word_movement_enabled;
134  bool css_sticky_position_enabled;
135  bool css_shaders_enabled;
136  bool css_variables_enabled;
137  bool lazy_layout_enabled;
138  bool region_based_columns_enabled;
139  bool touch_enabled;
140  bool device_supports_touch;
141  bool device_supports_mouse;
142  bool touch_adjustment_enabled;
143  bool fixed_position_creates_stacking_context;
144  bool sync_xhr_in_documents_enabled;
145  bool deferred_image_decoding_enabled;
146  bool should_respect_image_orientation;
147  int number_of_cpu_cores;
148  webkit_glue::EditingBehavior editing_behavior;
149  bool supports_multiple_windows;
150  bool viewport_enabled;
151  bool initialize_at_minimum_page_scale;
152  bool smart_insert_delete_enabled;
153  bool spatial_navigation_enabled;
154  bool experimental_websocket_enabled;
155  bool pinch_virtual_viewport_enabled;
156  int pinch_overlay_scrollbar_thickness;
157  bool compositor_touch_hit_testing;
158
159  // This flags corresponds to a Page's Settings' setCookieEnabled state. It
160  // only controls whether or not the "document.cookie" field is properly
161  // connected to the backing store, for instance if you wanted to be able to
162  // define custom getters and setters from within a unique security content
163  // without raising a DOM security exception.
164  bool cookie_enabled;
165
166#if defined(OS_ANDROID)
167  bool text_autosizing_enabled;
168  float font_scale_factor;
169  bool force_enable_zoom;
170  bool double_tap_to_zoom_enabled;
171  bool user_gesture_required_for_media_playback;
172  GURL default_video_poster_url;
173  bool support_deprecated_target_density_dpi;
174  bool use_legacy_background_size_shorthand_behavior;
175  bool wide_viewport_quirk;
176  bool use_wide_viewport;
177  bool viewport_meta_layout_size_quirk;
178  bool viewport_meta_zero_values_quirk;
179  bool ignore_main_frame_overflow_hidden_quirk;
180  bool report_screen_size_in_physical_pixels_quirk;
181#endif
182
183  // We try to keep the default values the same as the default values in
184  // chrome, except for the cases where it would require lots of extra work for
185  // the embedder to use the same default value.
186  WebPreferences();
187  ~WebPreferences();
188};
189
190#endif  // WEBKIT_COMMON_WEBPREFERENCES_H__
191