WK1: Add initial support for immediate actions
[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     WebActionMenuItemTagTextSuggestions,
124     WebActionMenuItemTagCopyImage,
125     WebActionMenuItemTagAddImageToPhotos,
126     WebActionMenuItemTagSaveImageToDownloads,
127     WebActionMenuItemTagShareImage,
128     WebActionMenuItemTagCopyVideoURL,
129     WebActionMenuItemTagSaveVideoToDownloads,
130     WebActionMenuItemTagShareVideo
131 };
132
133 typedef enum {
134     WebActionMenuNone = 0,
135     WebActionMenuLink,
136     WebActionMenuReadOnlyText,
137     WebActionMenuEditableText,
138     WebActionMenuWhitespaceInEditableArea,
139     WebActionMenuEditableTextWithSuggestions,
140     WebActionMenuImage,
141     WebActionMenuVideo,
142     WebActionMenuDataDetectedItem,
143     WebActionMenuMailtoLink,
144     WebActionMenuTelLink
145 } WebActionMenuType;
146
147 typedef enum {
148     WebImmediateActionNone = 0,
149 } WebImmediateActionType;
150
151 // Message Sources.
152 extern NSString *WebConsoleMessageXMLMessageSource;
153 extern NSString *WebConsoleMessageJSMessageSource;
154 extern NSString *WebConsoleMessageNetworkMessageSource;
155 extern NSString *WebConsoleMessageConsoleAPIMessageSource;
156 extern NSString *WebConsoleMessageStorageMessageSource;
157 extern NSString *WebConsoleMessageAppCacheMessageSource;
158 extern NSString *WebConsoleMessageRenderingMessageSource;
159 extern NSString *WebConsoleMessageCSSMessageSource;
160 extern NSString *WebConsoleMessageSecurityMessageSource;
161 extern NSString *WebConsoleMessageOtherMessageSource;
162
163 // Message Levels.
164 extern NSString *WebConsoleMessageDebugMessageLevel;
165 extern NSString *WebConsoleMessageLogMessageLevel;
166 extern NSString *WebConsoleMessageWarningMessageLevel;
167 extern NSString *WebConsoleMessageErrorMessageLevel;
168
169 @class DDActionContext;
170 @class DOMElement;
171 @class DOMNode;
172 @class DOMRange;
173 @class WebSecurityOrigin;
174
175 #if ENABLE_FULLSCREEN_API
176 @protocol WebKitFullScreenListener<NSObject>
177 - (void)webkitWillEnterFullScreen;
178 - (void)webkitDidEnterFullScreen;
179 - (void)webkitWillExitFullScreen;
180 - (void)webkitDidExitFullScreen;
181 @end
182 #endif
183
184 @interface NSObject (WebUIDelegatePrivate)
185
186 - (void)webView:(WebView *)webView addMessageToConsole:(NSDictionary *)message;
187
188 /*!
189     @method webView:addMessageToConsole:withSource:
190     @param webView The WebView sending the delegate method.
191     @param message A dictionary representation of the console message.
192     @param source Where the message came from. See WebConsoleMessageXMLMessageSource and other source types.
193     @discussion The dictionary contains the following keys:
194
195     <dl>
196         <dt>message</dt>
197         <dd>The message itself.</dd>
198         <dt>lineNumber</dt>
199         <dd>If this came from a file, this is the line number in the file this message originates from.</dd>
200         <dt>sourceURL</dt>
201         <dd>If this came from a file, this is the URL to the file this message originates from.</dd>
202         <dt>MessageSource</dt>
203         <dd>
204             Where the message came from. XML, JavaScript, CSS, etc.
205             See WebConsoleMessageXMLMessageSource and similar constants.
206         </dd>
207         <dt>MessageLevel</dt>
208         <dd>
209             Severity level of the message. Debug, Log, Warning, etc.
210             See WebConsoleMessageDebugMessageLevel and similar constants.
211         </dd>
212     </dl>
213 */
214 - (void)webView:(WebView *)webView addMessageToConsole:(NSDictionary *)message withSource:(NSString *)source;
215
216 - (NSView *)webView:(WebView *)webView plugInViewWithArguments:(NSDictionary *)arguments;
217
218 #if ENABLE_DASHBOARD_SUPPORT
219 // regions is an dictionary whose keys are regions label and values are arrays of WebDashboardRegions.
220 - (void)webView:(WebView *)webView dashboardRegionsChanged:(NSDictionary *)regions;
221 #endif
222
223 #if !TARGET_OS_IPHONE
224 - (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;
225 #endif
226 - (void)webView:(WebView *)sender didDrawRect:(NSRect)rect;
227 - (void)webView:(WebView *)sender didScrollDocumentInFrameView:(WebFrameView *)frameView;
228 // FIXME: If we ever make this method public, it should include a WebFrame parameter.
229 - (BOOL)webViewShouldInterruptJavaScript:(WebView *)sender;
230 #if !TARGET_OS_IPHONE
231 - (void)webView:(WebView *)sender willPopupMenu:(NSMenu *)menu;
232 - (void)webView:(WebView *)sender contextMenuItemSelected:(NSMenuItem *)item forElement:(NSDictionary *)element;
233 - (void)webView:(WebView *)sender saveFrameView:(WebFrameView *)frameView showingPanel:(BOOL)showingPanel;
234 - (NSArray *)_webView:(WebView *)sender actionMenuItemsForHitTestResult:(NSDictionary *)hitTestResult withType:(WebActionMenuType)type defaultActionMenuItems:(NSArray *)defaultMenuItems;
235 - (DDActionContext *)_webView:(WebView *)sender actionContextForHitTestResult:(NSDictionary *)hitTestResult range:(DOMRange **)range;
236 #endif
237 - (BOOL)webView:(WebView *)sender didPressMissingPluginButton:(DOMElement *)element;
238 /*!
239     @method webView:frame:exceededDatabaseQuotaForSecurityOrigin:database:
240     @param sender The WebView sending the delegate method.
241     @param frame The WebFrame whose JavaScript initiated this call.
242     @param origin The security origin that needs a larger quota.
243     @param databaseIdentifier The identifier of the database involved.
244 */
245 - (void)webView:(WebView *)sender frame:(WebFrame *)frame exceededDatabaseQuotaForSecurityOrigin:(WebSecurityOrigin *)origin database:(NSString *)databaseIdentifier;
246
247 /*!
248     @method webView:exceededApplicationCacheOriginQuotaForSecurityOrigin:totalSpaceNeeded:
249     @param sender The WebView sending the delegate method.
250     @param origin The security origin that needs a larger quota.
251     @param totalSpaceNeeded The amount of space needed to store the new manifest and keep all other
252     previously stored caches for this origin.
253     @discussion This method is called when a page attempts to store more in the Application Cache
254     for an origin than was allowed by the quota (or default) set for the origin. This allows the
255     quota to be increased for the security origin.
256 */
257 - (void)webView:(WebView *)sender exceededApplicationCacheOriginQuotaForSecurityOrigin:(WebSecurityOrigin *)origin totalSpaceNeeded:(NSUInteger)totalSpaceNeeded;
258
259 - (WebView *)webView:(WebView *)sender createWebViewWithRequest:(NSURLRequest *)request windowFeatures:(NSDictionary *)features;
260
261 - (BOOL)webView:(WebView *)sender shouldReplaceUploadFile:(NSString *)path usingGeneratedFilename:(NSString **)filename;
262 - (NSString *)webView:(WebView *)sender generateReplacementFile:(NSString *)path;
263
264 /*!
265     @method webView:decidePolicyForGeolocationRequestFromOrigin:frame:listener:
266     @abstract 
267     @param webView The WebView sending the delegate method.
268     @param origin The security origin that would like to use Geolocation.
269     @param frame The WebFrame whose JavaScript initiated this call.
270     @param listener The object to call when the decision is made
271 */
272 - (void)webView:(WebView *)webView decidePolicyForGeolocationRequestFromOrigin:(WebSecurityOrigin *)origin
273                                                                          frame:(WebFrame *)frame
274                                                                       listener:(id<WebAllowDenyPolicyListener>)listener;
275 - (void)webView:(WebView *)webView decidePolicyForNotificationRequestFromOrigin:(WebSecurityOrigin *)origin listener:(id<WebAllowDenyPolicyListener>)listener;
276
277 - (void)webView:(WebView *)webView decidePolicyForUserMediaRequestFromOrigin:(WebSecurityOrigin *)origin listener:(id<WebAllowDenyPolicyListener>)listener;
278
279 - (void)webView:(WebView *)sender elementDidFocusNode:(DOMNode *)node;
280 - (void)webView:(WebView *)sender elementDidBlurNode:(DOMNode *)node;
281
282 /*!
283     @method webView:printFrame:
284     @abstract Informs that a WebFrame needs to be printed
285     @param webView The WebView sending the delegate method
286     @param frameView The WebFrame needing to be printed
287     @discussion This method is called when a script or user requests the page to be printed.
288 */
289 - (void)webView:(WebView *)sender printFrame:(WebFrame *)frame;
290
291 #if ENABLE_FULLSCREEN_API
292 - (BOOL)webView:(WebView *)sender supportsFullScreenForElement:(DOMElement *)element;
293 - (void)webView:(WebView *)sender enterFullScreenForElement:(DOMElement *)element;
294 - (void)webView:(WebView *)sender exitFullScreenForElement:(DOMElement *)element;
295 #endif
296
297 - (void)webView:(WebView *)sender didDrawFrame:(WebFrame *)frame;
298
299 #if TARGET_OS_IPHONE
300 /*!
301  @method webViewSupportedOrientationsUpdated:
302  @param sender The WebView sending the delegate method
303  @abstract Notify the client that the content has updated the orientations it claims to support.
304  */
305 - (void)webViewSupportedOrientationsUpdated:(WebView *)sender;
306
307 - (BOOL)webViewCanCheckGeolocationAuthorizationStatus:(WebView *)sender;
308 #endif
309
310 - (NSData *)webCryptoMasterKeyForWebView:(WebView *)sender;
311
312 @end