Remove ColorSpaceDeviceRGB and most users of the obsolete deviceRGB colorspace
[WebKit-https.git] / Source / WebKitLegacy / 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 #if TARGET_OS_IPHONE && __IPHONE_OS_VERSION_MIN_REQUIRED >= 110000
49 @protocol UIDropSession;
50 #endif
51
52 #define WEBMENUITEMTAG_WEBKIT_3_0_SPI_START 2000
53 enum { 
54     // FIXME: These should move to WebUIDelegate.h as part of the WebMenuItemTag enum there, when we're not in API freeze
55     // Note that these values must be kept aligned with values in WebCore/ContextMenuItem.h
56     WebMenuItemTagOpenLink = WEBMENUITEMTAG_WEBKIT_3_0_SPI_START,
57     WebMenuItemTagIgnoreGrammar,
58     WebMenuItemTagSpellingMenu,
59     WebMenuItemTagShowSpellingPanel,
60     WebMenuItemTagCheckSpelling,
61     WebMenuItemTagCheckSpellingWhileTyping,
62     WebMenuItemTagCheckGrammarWithSpelling,
63     WebMenuItemTagFontMenu,
64     WebMenuItemTagShowFonts,
65     WebMenuItemTagBold,
66     WebMenuItemTagItalic,
67     WebMenuItemTagUnderline,
68     WebMenuItemTagOutline,
69     WebMenuItemTagStyles,
70     WebMenuItemTagShowColors,
71     WebMenuItemTagSpeechMenu,
72     WebMenuItemTagStartSpeaking,
73     WebMenuItemTagStopSpeaking,
74     WebMenuItemTagWritingDirectionMenu,
75     WebMenuItemTagDefaultDirection,
76     WebMenuItemTagLeftToRight,
77     WebMenuItemTagRightToLeft,
78     WebMenuItemPDFSinglePageScrolling,
79     WebMenuItemPDFFacingPagesScrolling,
80     WebMenuItemTagInspectElement,
81     WebMenuItemTagTextDirectionMenu,
82     WebMenuItemTagTextDirectionDefault,
83     WebMenuItemTagTextDirectionLeftToRight,
84     WebMenuItemTagTextDirectionRightToLeft,
85     WebMenuItemTagCorrectSpellingAutomatically,
86     WebMenuItemTagSubstitutionsMenu,
87     WebMenuItemTagShowSubstitutions,
88     WebMenuItemTagSmartCopyPaste,
89     WebMenuItemTagSmartQuotes,
90     WebMenuItemTagSmartDashes,
91     WebMenuItemTagSmartLinks,
92     WebMenuItemTagTextReplacement,
93     WebMenuItemTagTransformationsMenu,
94     WebMenuItemTagMakeUpperCase,
95     WebMenuItemTagMakeLowerCase,
96     WebMenuItemTagCapitalize,
97     WebMenuItemTagChangeBack,
98     WebMenuItemTagOpenMediaInNewWindow,
99     WebMenuItemTagDownloadMediaToDisk,
100     WebMenuItemTagCopyMediaLinkToClipboard,
101     WebMenuItemTagToggleMediaControls,
102     WebMenuItemTagToggleMediaLoop,
103     WebMenuItemTagEnterVideoFullscreen,
104     WebMenuItemTagMediaPlayPause,
105     WebMenuItemTagMediaMute,
106     WebMenuItemTagDictationAlternative,
107     WebMenuItemTagToggleVideoFullscreen,
108     WebMenuItemTagShareMenu,
109     WebMenuItemTagToggleVideoEnhancedFullscreen,
110 };
111
112 // Deprecated; remove when there are no more clients.
113 typedef enum {
114     WebActionMenuNone = 0,
115     WebActionMenuLink,
116     WebActionMenuReadOnlyText,
117     WebActionMenuEditableText,
118     WebActionMenuWhitespaceInEditableArea,
119     WebActionMenuEditableTextWithSuggestions,
120     WebActionMenuImage,
121     WebActionMenuVideo,
122     WebActionMenuDataDetectedItem,
123     WebActionMenuMailtoLink,
124     WebActionMenuTelLink
125 } WebActionMenuType;
126
127 typedef enum {
128     WebImmediateActionNone = 0,
129     WebImmediateActionLinkPreview,
130     WebImmediateActionDataDetectedItem,
131     WebImmediateActionText,
132     WebImmediateActionMailtoLink,
133     WebImmediateActionTelLink
134 } WebImmediateActionType;
135
136 // Message Sources.
137 extern NSString *WebConsoleMessageXMLMessageSource;
138 extern NSString *WebConsoleMessageJSMessageSource;
139 extern NSString *WebConsoleMessageNetworkMessageSource;
140 extern NSString *WebConsoleMessageConsoleAPIMessageSource;
141 extern NSString *WebConsoleMessageStorageMessageSource;
142 extern NSString *WebConsoleMessageAppCacheMessageSource;
143 extern NSString *WebConsoleMessageRenderingMessageSource;
144 extern NSString *WebConsoleMessageCSSMessageSource;
145 extern NSString *WebConsoleMessageSecurityMessageSource;
146 extern NSString *WebConsoleMessageContentBlockerMessageSource;
147 extern NSString *WebConsoleMessageOtherMessageSource;
148
149 // Message Levels.
150 extern NSString *WebConsoleMessageDebugMessageLevel;
151 extern NSString *WebConsoleMessageLogMessageLevel;
152 extern NSString *WebConsoleMessageInfoMessageLevel;
153 extern NSString *WebConsoleMessageWarningMessageLevel;
154 extern NSString *WebConsoleMessageErrorMessageLevel;
155
156 @class DDActionContext;
157 @class DOMElement;
158 @class DOMNode;
159 @class DOMRange;
160 @class WebSecurityOrigin;
161
162 #if ENABLE_FULLSCREEN_API
163 @protocol WebKitFullScreenListener<NSObject>
164 - (void)webkitWillEnterFullScreen;
165 - (void)webkitDidEnterFullScreen;
166 - (void)webkitWillExitFullScreen;
167 - (void)webkitDidExitFullScreen;
168 @end
169 #endif
170
171 @interface NSObject (WebUIDelegatePrivate)
172
173 - (void)webView:(WebView *)webView addMessageToConsole:(NSDictionary *)message;
174
175 /*!
176     @method webView:addMessageToConsole:withSource:
177     @param webView The WebView sending the delegate method.
178     @param message A dictionary representation of the console message.
179     @param source Where the message came from. See WebConsoleMessageXMLMessageSource and other source types.
180     @discussion The dictionary contains the following keys:
181
182     <dl>
183         <dt>message</dt>
184         <dd>The message itself.</dd>
185         <dt>lineNumber</dt>
186         <dd>If this came from a file, this is the line number in the file this message originates from.</dd>
187         <dt>sourceURL</dt>
188         <dd>If this came from a file, this is the URL to the file this message originates from.</dd>
189         <dt>MessageSource</dt>
190         <dd>
191             Where the message came from. XML, JavaScript, CSS, etc.
192             See WebConsoleMessageXMLMessageSource and similar constants.
193         </dd>
194         <dt>MessageLevel</dt>
195         <dd>
196             Severity level of the message. Debug, Log, Warning, etc.
197             See WebConsoleMessageDebugMessageLevel and similar constants.
198         </dd>
199     </dl>
200 */
201 - (void)webView:(WebView *)webView addMessageToConsole:(NSDictionary *)message withSource:(NSString *)source;
202
203 - (NSView *)webView:(WebView *)webView plugInViewWithArguments:(NSDictionary *)arguments;
204
205 #if ENABLE_DASHBOARD_SUPPORT
206 // regions is an dictionary whose keys are regions label and values are arrays of WebDashboardRegions.
207 - (void)webView:(WebView *)webView dashboardRegionsChanged:(NSDictionary *)regions;
208 #endif
209
210 #if !TARGET_OS_IPHONE
211 - (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;
212 #endif
213 - (void)webView:(WebView *)sender didDrawRect:(NSRect)rect;
214 - (void)webView:(WebView *)sender didScrollDocumentInFrameView:(WebFrameView *)frameView;
215 #if !TARGET_OS_IPHONE
216 - (void)webView:(WebView *)sender willPopupMenu:(NSMenu *)menu;
217 - (void)webView:(WebView *)sender saveFrameView:(WebFrameView *)frameView showingPanel:(BOOL)showingPanel;
218
219 // FIXME: Rename this because it's only used by immediate action code.
220 - (DDActionContext *)_webView:(WebView *)sender actionContextForHitTestResult:(NSDictionary *)hitTestResult range:(DOMRange **)range;
221
222 // Clients that want to maintain default behavior can return nil. To disable the immediate action entirely, return NSNull. And to
223 // do something custom, return an object that conforms to the NSImmediateActionAnimationController protocol.
224 - (id)_webView:(WebView *)sender immediateActionAnimationControllerForHitTestResult:(NSDictionary *)hitTestResult withType:(WebImmediateActionType)type;
225 #endif
226 - (BOOL)webView:(WebView *)sender didPressMissingPluginButton:(DOMElement *)element;
227 /*!
228     @method webView:frame:exceededDatabaseQuotaForSecurityOrigin:database:
229     @param sender The WebView sending the delegate method.
230     @param frame The WebFrame whose JavaScript initiated this call.
231     @param origin The security origin that needs a larger quota.
232     @param databaseIdentifier The identifier of the database involved.
233 */
234 - (void)webView:(WebView *)sender frame:(WebFrame *)frame exceededDatabaseQuotaForSecurityOrigin:(WebSecurityOrigin *)origin database:(NSString *)databaseIdentifier;
235
236 /*!
237     @method webView:exceededApplicationCacheOriginQuotaForSecurityOrigin:totalSpaceNeeded:
238     @param sender The WebView sending the delegate method.
239     @param origin The security origin that needs a larger quota.
240     @param totalSpaceNeeded The amount of space needed to store the new manifest and keep all other
241     previously stored caches for this origin.
242     @discussion This method is called when a page attempts to store more in the Application Cache
243     for an origin than was allowed by the quota (or default) set for the origin. This allows the
244     quota to be increased for the security origin.
245 */
246 - (void)webView:(WebView *)sender exceededApplicationCacheOriginQuotaForSecurityOrigin:(WebSecurityOrigin *)origin totalSpaceNeeded:(NSUInteger)totalSpaceNeeded;
247
248 - (WebView *)webView:(WebView *)sender createWebViewWithRequest:(NSURLRequest *)request windowFeatures:(NSDictionary *)features;
249
250 - (BOOL)webView:(WebView *)sender shouldReplaceUploadFile:(NSString *)path usingGeneratedFilename:(NSString **)filename;
251 - (NSString *)webView:(WebView *)sender generateReplacementFile:(NSString *)path;
252
253 /*!
254     @method webView:decidePolicyForGeolocationRequestFromOrigin:frame:listener:
255     @param webView The WebView sending the delegate method.
256     @param origin The security origin that would like to use Geolocation.
257     @param frame The WebFrame whose JavaScript initiated this call.
258     @param listener The object to call when the decision is made
259 */
260 - (void)webView:(WebView *)webView decidePolicyForGeolocationRequestFromOrigin:(WebSecurityOrigin *)origin
261                                                                          frame:(WebFrame *)frame
262                                                                       listener:(id<WebAllowDenyPolicyListener>)listener;
263 - (void)webView:(WebView *)webView decidePolicyForNotificationRequestFromOrigin:(WebSecurityOrigin *)origin listener:(id<WebAllowDenyPolicyListener>)listener;
264
265 - (void)webView:(WebView *)webView decidePolicyForUserMediaRequestFromOrigin:(WebSecurityOrigin *)origin listener:(id<WebAllowDenyPolicyListener>)listener;
266 - (void)webView:(WebView *)webView checkPolicyForUserMediaRequestFromOrigin:(WebSecurityOrigin *)origin listener:(id<WebAllowDenyPolicyListener>)listener;
267
268 - (void)webView:(WebView *)sender elementDidFocusNode:(DOMNode *)node;
269 - (void)webView:(WebView *)sender elementDidBlurNode:(DOMNode *)node;
270
271 /*!
272     @method webView:printFrame:
273     @abstract Informs that a WebFrame needs to be printed
274     @param sender The WebView sending the delegate method
275     @param frame The WebFrame needing to be printed
276     @discussion This method is called when a script or user requests the page to be printed.
277 */
278 - (void)webView:(WebView *)sender printFrame:(WebFrame *)frame;
279
280 #if ENABLE_FULLSCREEN_API
281 - (BOOL)webView:(WebView *)sender supportsFullScreenForElement:(DOMElement *)element;
282 - (void)webView:(WebView *)sender enterFullScreenForElement:(DOMElement *)element;
283 - (void)webView:(WebView *)sender exitFullScreenForElement:(DOMElement *)element;
284 #endif
285
286 - (void)webView:(WebView *)sender didDrawFrame:(WebFrame *)frame;
287
288 #if TARGET_OS_IPHONE
289 /*!
290  @method webViewSupportedOrientationsUpdated:
291  @param sender The WebView sending the delegate method
292  @abstract Notify the client that the content has updated the orientations it claims to support.
293  */
294 - (void)webViewSupportedOrientationsUpdated:(WebView *)sender;
295
296 - (BOOL)webViewCanCheckGeolocationAuthorizationStatus:(WebView *)sender;
297
298 #if __IPHONE_OS_VERSION_MIN_REQUIRED >= 110000
299 /*!
300  @method webView:dragDestinationActionMaskForSession:
301  @param sender The WebView sending the delegate method
302  @param session The drop session which this destination action mask will affect
303  @abstract May be implemented to adjust which destination actions are allowed upon dropping the given session.
304  */
305 - (WebDragDestinationAction)webView:(WebView *)sender dragDestinationActionMaskForSession:(id <UIDropSession>)session;
306 #endif
307 #endif
308
309 - (NSData *)webCryptoMasterKeyForWebView:(WebView *)sender;
310
311 @end