c76e4656667c77ac900b763cc688a4bb9d51e583
[WebKit-https.git] / Source / WebKit / mac / WebView / WebUIDelegatePrivate.h
1 /*
2  * Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2012 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <WebKitLegacy/WebAllowDenyPolicyListener.h>
30 #import <WebKitLegacy/WebUIDelegate.h>
31
32 #if !defined(ENABLE_DASHBOARD_SUPPORT)
33 #if !TARGET_OS_IPHONE
34 #define ENABLE_DASHBOARD_SUPPORT 1
35 #else
36 #define ENABLE_DASHBOARD_SUPPORT 0
37 #endif
38 #endif
39
40 #if !defined(ENABLE_FULLSCREEN_API)
41 #if !TARGET_OS_IPHONE
42 #define ENABLE_FULLSCREEN_API 1
43 #else
44 #define ENABLE_FULLSCREEN_API 0
45 #endif
46 #endif
47
48 // Mail on Tiger expects the old value for WebMenuItemTagSearchInGoogle
49 #define WebMenuItemTagSearchInGoogle OldWebMenuItemTagSearchWeb
50
51 #define WEBMENUITEMTAG_WEBKIT_3_0_SPI_START 2000
52 enum { 
53     // The next three values were used in WebKit 2.0 for SPI. In WebKit 3.0 these are API, with different values.
54     OldWebMenuItemTagSearchInSpotlight = 1000,
55     OldWebMenuItemTagSearchWeb,
56     OldWebMenuItemTagLookUpInDictionary,
57     // FIXME: These should move to WebUIDelegate.h as part of the WebMenuItemTag enum there, when we're not in API freeze 
58     // Note that these values must be kept aligned with values in WebCore/ContextMenuItem.h
59     WebMenuItemTagOpenLink = WEBMENUITEMTAG_WEBKIT_3_0_SPI_START,
60     WebMenuItemTagIgnoreGrammar,
61     WebMenuItemTagSpellingMenu,
62     WebMenuItemTagShowSpellingPanel,
63     WebMenuItemTagCheckSpelling,
64     WebMenuItemTagCheckSpellingWhileTyping,
65     WebMenuItemTagCheckGrammarWithSpelling,
66     WebMenuItemTagFontMenu,
67     WebMenuItemTagShowFonts,
68     WebMenuItemTagBold,
69     WebMenuItemTagItalic,
70     WebMenuItemTagUnderline,
71     WebMenuItemTagOutline,
72     WebMenuItemTagStyles,
73     WebMenuItemTagShowColors,
74     WebMenuItemTagSpeechMenu,
75     WebMenuItemTagStartSpeaking,
76     WebMenuItemTagStopSpeaking,
77     WebMenuItemTagWritingDirectionMenu,
78     WebMenuItemTagDefaultDirection,
79     WebMenuItemTagLeftToRight,
80     WebMenuItemTagRightToLeft,
81     WebMenuItemPDFSinglePageScrolling,
82     WebMenuItemPDFFacingPagesScrolling,
83     WebMenuItemTagInspectElement,
84     WebMenuItemTagTextDirectionMenu,
85     WebMenuItemTagTextDirectionDefault,
86     WebMenuItemTagTextDirectionLeftToRight,
87     WebMenuItemTagTextDirectionRightToLeft,
88     WebMenuItemTagCorrectSpellingAutomatically,
89     WebMenuItemTagSubstitutionsMenu,
90     WebMenuItemTagShowSubstitutions,
91     WebMenuItemTagSmartCopyPaste,
92     WebMenuItemTagSmartQuotes,
93     WebMenuItemTagSmartDashes,
94     WebMenuItemTagSmartLinks,
95     WebMenuItemTagTextReplacement,
96     WebMenuItemTagTransformationsMenu,
97     WebMenuItemTagMakeUpperCase,
98     WebMenuItemTagMakeLowerCase,
99     WebMenuItemTagCapitalize,
100     WebMenuItemTagChangeBack,
101     WebMenuItemTagOpenMediaInNewWindow,
102     WebMenuItemTagCopyMediaLinkToClipboard,
103     WebMenuItemTagToggleMediaControls,
104     WebMenuItemTagToggleMediaLoop,
105     WebMenuItemTagEnterVideoFullscreen,
106     WebMenuItemTagMediaPlayPause,
107     WebMenuItemTagMediaMute,
108     WebMenuItemTagDictationAlternative,
109     WebMenuItemBaseCustomTag = 5000,
110     WebMenuItemCustomTagNoAction = 5998,
111     WebMenuItemLastCustomTag = 5999,
112     WebMenuItemTagBaseApplication = 10000
113 };
114
115 enum {
116     WebActionMenuItemTagNoAction = 0,
117     WebActionMenuItemTagOpenLinkInDefaultBrowser,
118     WebActionMenuItemTagPreviewLink,
119     WebActionMenuItemTagAddLinkToSafariReadingList,
120     WebActionMenuItemTagCopyText,
121     WebActionMenuItemTagLookupText,
122     WebActionMenuItemTagPaste
123 };
124
125 typedef enum {
126     WebActionMenuNone = 0,
127     WebActionMenuLink,
128     WebActionMenuReadOnlyText,
129     WebActionMenuEditableText
130 } WebActionMenuType;
131
132 // Message Sources.
133 extern NSString *WebConsoleMessageXMLMessageSource;
134 extern NSString *WebConsoleMessageJSMessageSource;
135 extern NSString *WebConsoleMessageNetworkMessageSource;
136 extern NSString *WebConsoleMessageConsoleAPIMessageSource;
137 extern NSString *WebConsoleMessageStorageMessageSource;
138 extern NSString *WebConsoleMessageAppCacheMessageSource;
139 extern NSString *WebConsoleMessageRenderingMessageSource;
140 extern NSString *WebConsoleMessageCSSMessageSource;
141 extern NSString *WebConsoleMessageSecurityMessageSource;
142 extern NSString *WebConsoleMessageOtherMessageSource;
143
144 // Message Levels.
145 extern NSString *WebConsoleMessageDebugMessageLevel;
146 extern NSString *WebConsoleMessageLogMessageLevel;
147 extern NSString *WebConsoleMessageWarningMessageLevel;
148 extern NSString *WebConsoleMessageErrorMessageLevel;
149
150 @class DOMElement;
151 @class DOMNode;
152 @class WebSecurityOrigin;
153
154 #if ENABLE_FULLSCREEN_API
155 @protocol WebKitFullScreenListener<NSObject>
156 - (void)webkitWillEnterFullScreen;
157 - (void)webkitDidEnterFullScreen;
158 - (void)webkitWillExitFullScreen;
159 - (void)webkitDidExitFullScreen;
160 @end
161 #endif
162
163 @interface NSObject (WebUIDelegatePrivate)
164
165 - (void)webView:(WebView *)webView addMessageToConsole:(NSDictionary *)message;
166
167 /*!
168     @method webView:addMessageToConsole:withSource:
169     @param webView The WebView sending the delegate method.
170     @param message A dictionary representation of the console message.
171     @param source Where the message came from. See WebConsoleMessageXMLMessageSource and other source types.
172     @discussion The dictionary contains the following keys:
173
174     <dl>
175         <dt>message</dt>
176         <dd>The message itself.</dd>
177         <dt>lineNumber</dt>
178         <dd>If this came from a file, this is the line number in the file this message originates from.</dd>
179         <dt>sourceURL</dt>
180         <dd>If this came from a file, this is the URL to the file this message originates from.</dd>
181         <dt>MessageSource</dt>
182         <dd>
183             Where the message came from. XML, JavaScript, CSS, etc.
184             See WebConsoleMessageXMLMessageSource and similar constants.
185         </dd>
186         <dt>MessageLevel</dt>
187         <dd>
188             Severity level of the message. Debug, Log, Warning, etc.
189             See WebConsoleMessageDebugMessageLevel and similar constants.
190         </dd>
191     </dl>
192 */
193 - (void)webView:(WebView *)webView addMessageToConsole:(NSDictionary *)message withSource:(NSString *)source;
194
195 - (NSView *)webView:(WebView *)webView plugInViewWithArguments:(NSDictionary *)arguments;
196
197 #if ENABLE_DASHBOARD_SUPPORT
198 // regions is an dictionary whose keys are regions label and values are arrays of WebDashboardRegions.
199 - (void)webView:(WebView *)webView dashboardRegionsChanged:(NSDictionary *)regions;
200 #endif
201
202 #if !TARGET_OS_IPHONE
203 - (void)webView:(WebView *)sender dragImage:(NSImage *)anImage at:(NSPoint)viewLocation offset:(NSSize)initialOffset event:(NSEvent *)event pasteboard:(NSPasteboard *)pboard source:(id)sourceObj slideBack:(BOOL)slideFlag forView:(NSView *)view;
204 #endif
205 - (void)webView:(WebView *)sender didDrawRect:(NSRect)rect;
206 - (void)webView:(WebView *)sender didScrollDocumentInFrameView:(WebFrameView *)frameView;
207 // FIXME: If we ever make this method public, it should include a WebFrame parameter.
208 - (BOOL)webViewShouldInterruptJavaScript:(WebView *)sender;
209 #if !TARGET_OS_IPHONE
210 - (void)webView:(WebView *)sender willPopupMenu:(NSMenu *)menu;
211 - (void)webView:(WebView *)sender contextMenuItemSelected:(NSMenuItem *)item forElement:(NSDictionary *)element;
212 - (void)webView:(WebView *)sender saveFrameView:(WebFrameView *)frameView showingPanel:(BOOL)showingPanel;
213 - (NSArray *)_webView:(WebView *)sender actionMenuItemsForHitTestResult:(NSDictionary *)hitTestResult withType:(WebActionMenuType)type defaultActionMenuItems:(NSArray *)defaultMenuItems;
214 #endif
215 - (BOOL)webView:(WebView *)sender didPressMissingPluginButton:(DOMElement *)element;
216 /*!
217     @method webView:frame:exceededDatabaseQuotaForSecurityOrigin:database:
218     @param sender The WebView sending the delegate method.
219     @param frame The WebFrame whose JavaScript initiated this call.
220     @param origin The security origin that needs a larger quota.
221     @param databaseIdentifier The identifier of the database involved.
222 */
223 - (void)webView:(WebView *)sender frame:(WebFrame *)frame exceededDatabaseQuotaForSecurityOrigin:(WebSecurityOrigin *)origin database:(NSString *)databaseIdentifier;
224
225 /*!
226     @method webView:exceededApplicationCacheOriginQuotaForSecurityOrigin:totalSpaceNeeded:
227     @param sender The WebView sending the delegate method.
228     @param origin The security origin that needs a larger quota.
229     @param totalSpaceNeeded The amount of space needed to store the new manifest and keep all other
230     previously stored caches for this origin.
231     @discussion This method is called when a page attempts to store more in the Application Cache
232     for an origin than was allowed by the quota (or default) set for the origin. This allows the
233     quota to be increased for the security origin.
234 */
235 - (void)webView:(WebView *)sender exceededApplicationCacheOriginQuotaForSecurityOrigin:(WebSecurityOrigin *)origin totalSpaceNeeded:(NSUInteger)totalSpaceNeeded;
236
237 - (WebView *)webView:(WebView *)sender createWebViewWithRequest:(NSURLRequest *)request windowFeatures:(NSDictionary *)features;
238
239 - (BOOL)webView:(WebView *)sender shouldReplaceUploadFile:(NSString *)path usingGeneratedFilename:(NSString **)filename;
240 - (NSString *)webView:(WebView *)sender generateReplacementFile:(NSString *)path;
241
242 /*!
243     @method webView:decidePolicyForGeolocationRequestFromOrigin:frame:listener:
244     @abstract 
245     @param webView The WebView sending the delegate method.
246     @param origin The security origin that would like to use Geolocation.
247     @param frame The WebFrame whose JavaScript initiated this call.
248     @param listener The object to call when the decision is made
249 */
250 - (void)webView:(WebView *)webView decidePolicyForGeolocationRequestFromOrigin:(WebSecurityOrigin *)origin
251                                                                          frame:(WebFrame *)frame
252                                                                       listener:(id<WebAllowDenyPolicyListener>)listener;
253 - (void)webView:(WebView *)webView decidePolicyForNotificationRequestFromOrigin:(WebSecurityOrigin *)origin listener:(id<WebAllowDenyPolicyListener>)listener;
254
255 - (void)webView:(WebView *)webView decidePolicyForUserMediaRequestFromOrigin:(WebSecurityOrigin *)origin listener:(id<WebAllowDenyPolicyListener>)listener;
256
257 - (void)webView:(WebView *)sender elementDidFocusNode:(DOMNode *)node;
258 - (void)webView:(WebView *)sender elementDidBlurNode:(DOMNode *)node;
259
260 /*!
261     @method webView:printFrame:
262     @abstract Informs that a WebFrame needs to be printed
263     @param webView The WebView sending the delegate method
264     @param frameView The WebFrame needing to be printed
265     @discussion This method is called when a script or user requests the page to be printed.
266 */
267 - (void)webView:(WebView *)sender printFrame:(WebFrame *)frame;
268
269 #if ENABLE_FULLSCREEN_API
270 - (BOOL)webView:(WebView *)sender supportsFullScreenForElement:(DOMElement *)element;
271 - (void)webView:(WebView *)sender enterFullScreenForElement:(DOMElement *)element;
272 - (void)webView:(WebView *)sender exitFullScreenForElement:(DOMElement *)element;
273 #endif
274
275 - (void)webView:(WebView *)sender didDrawFrame:(WebFrame *)frame;
276
277 #if TARGET_OS_IPHONE
278 /*!
279  @method webViewSupportedOrientationsUpdated:
280  @param sender The WebView sending the delegate method
281  @abstract Notify the client that the content has updated the orientations it claims to support.
282  */
283 - (void)webViewSupportedOrientationsUpdated:(WebView *)sender;
284
285 - (BOOL)webViewCanCheckGeolocationAuthorizationStatus:(WebView *)sender;
286 #endif
287
288 - (NSData *)webCryptoMasterKeyForWebView:(WebView *)sender;
289
290 @end