Reviewed by Brady.
[WebKit-https.git] / WebKit / WebView / WebViewPrivate.h
1 /*
2  * Copyright (C) 2005 Apple Computer, 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 Computer, 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 <WebKit/WebView.h>
30 #import <WebKit/WebFramePrivate.h>
31
32 #if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4
33 #define WebNSInteger int
34 #else
35 #define WebNSInteger NSInteger
36 #endif
37
38 @class NSError;
39 @class WebFrame;
40 @class WebPreferences;
41 @class WebCoreSettings;
42
43 @protocol WebFormDelegate;
44
45 typedef void (*WebDidCancelAuthenticationChallengeFunc)(id, SEL, WebView *, id, NSURLAuthenticationChallenge *, WebDataSource *);
46 typedef void (*WebDidReceiveAuthenticationChallengeFunc)(id, SEL, WebView *, id, NSURLAuthenticationChallenge *, WebDataSource *);
47 typedef id (*WebIdentifierForRequestFunc)(id, SEL, WebView *, NSURLRequest *, WebDataSource *);
48 typedef NSURLRequest *(*WebWillSendRequestFunc)(id, SEL, WebView *, id, NSURLRequest *, NSURLResponse *, WebDataSource *);
49 typedef void (*WebDidReceiveResponseFunc)(id, SEL, WebView *, id, NSURLResponse *, WebDataSource *);
50 typedef void (*WebDidReceiveContentLengthFunc)(id, SEL, WebView *, id, WebNSInteger, WebDataSource *);
51 typedef void (*WebDidFinishLoadingFromDataSourceFunc)(id, SEL, WebView *, id, WebDataSource *);
52 typedef void (*WebDidLoadResourceFromMemoryCacheFunc)(id, SEL, WebView *, NSURLRequest *, NSURLResponse *, WebNSInteger, WebDataSource *);
53
54 typedef struct _WebResourceDelegateImplementationCache {
55     uint delegateImplementsDidCancelAuthenticationChallenge:1;
56     uint delegateImplementsDidReceiveAuthenticationChallenge:1;
57     uint delegateImplementsDidReceiveResponse:1;
58     uint delegateImplementsDidReceiveContentLength:1;
59     uint delegateImplementsDidFinishLoadingFromDataSource:1;
60     uint delegateImplementsWillSendRequest:1;
61     uint delegateImplementsIdentifierForRequest:1;
62     uint delegateImplementsDidLoadResourceFromMemoryCache:1;
63
64     WebDidCancelAuthenticationChallengeFunc didCancelAuthenticationChallengeFunc;
65     WebDidReceiveAuthenticationChallengeFunc didReceiveAuthenticationChallengeFunc;
66     WebIdentifierForRequestFunc identifierForRequestFunc;
67     WebWillSendRequestFunc willSendRequestFunc;
68     WebDidReceiveResponseFunc didReceiveResponseFunc;
69     WebDidReceiveContentLengthFunc didReceiveContentLengthFunc;
70     WebDidFinishLoadingFromDataSourceFunc didFinishLoadingFromDataSourceFunc;
71     WebDidLoadResourceFromMemoryCacheFunc didLoadResourceFromMemoryCacheFunc;
72 } WebResourceDelegateImplementationCache;
73
74 extern NSString *_WebCanGoBackKey;
75 extern NSString *_WebCanGoForwardKey;
76 extern NSString *_WebEstimatedProgressKey;
77 extern NSString *_WebIsLoadingKey;
78 extern NSString *_WebMainFrameIconKey;
79 extern NSString *_WebMainFrameTitleKey;
80 extern NSString *_WebMainFrameURLKey;
81 extern NSString *_WebMainFrameDocumentKey;
82
83 // pending public WebElementDictionary keys
84 extern NSString *WebElementTitleKey;             // NSString of the title of the element (used by Safari)
85 extern NSString *WebElementSpellingToolTipKey;   // NSString of a tooltip representing misspelling or bad grammar (used internally)
86
87 typedef enum {
88     WebDashboardBehaviorAlwaysSendMouseEventsToAllWindows,
89     WebDashboardBehaviorAlwaysSendActiveNullEventsToPlugIns,
90     WebDashboardBehaviorAlwaysAcceptsFirstMouse,
91     WebDashboardBehaviorAllowWheelScrolling
92 } WebDashboardBehavior;
93
94 @interface WebController : NSTreeController {
95     IBOutlet WebView *webView;
96 }
97 - (WebView *)webView;
98 - (void)setWebView:(WebView *)newWebView;
99 @end
100
101 @interface WebView (WebPendingPublic)
102
103 - (void)outdent:(id)sender;
104
105 - (void)setMainFrameDocumentReady:(BOOL)mainFrameDocumentReady;
106
107 - (void)setTabKeyCyclesThroughElements:(BOOL)cyclesElements;
108 - (BOOL)tabKeyCyclesThroughElements;
109
110 - (void)scrollDOMRangeToVisible:(DOMRange *)range;
111
112 /*!
113 @method setScriptDebugDelegate:
114 @abstract Set the WebView's WebScriptDebugDelegate delegate.
115 @param delegate The WebScriptDebugDelegate to set as the delegate.
116 */    
117 - (void)setScriptDebugDelegate:(id)delegate;
118
119 /*!
120 @method scriptDebugDelegate
121 @abstract Return the WebView's WebScriptDebugDelegate.
122 @result The WebView's WebScriptDebugDelegate.
123 */    
124 - (id)scriptDebugDelegate;
125
126 - (BOOL)shouldClose;
127
128 /*!
129     @method aeDescByEvaluatingJavaScriptFromString:
130     @param script The text of the JavaScript.
131     @result The result of the script, converted to an NSAppleEventDescriptor, or nil for failure.
132 */
133 - (NSAppleEventDescriptor *)aeDescByEvaluatingJavaScriptFromString:(NSString *)script;
134
135 // Support for displaying multiple text matches.
136 // These methods might end up moving into a protocol, so different document types can specify
137 // whether or not they implement the protocol. For now we'll just deal with HTML.
138 // These methods are still in flux; don't rely on them yet.
139 - (unsigned)markAllMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight limit:(unsigned)limit;
140 - (void)unmarkAllTextMatches;
141 - (NSArray *)rectsForTextMatches;
142
143 @end
144
145 @interface WebView (WebPrivate)
146
147 + (BOOL)_developerExtrasEnabled;
148 + (BOOL)_scriptDebuggerEnabled;
149
150 /*!
151     @method setBackgroundColor:
152     @param backgroundColor Color to use as the default background.
153     @abstract Sets what color the receiver draws under transparent page background colors and images.
154     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
155     in a non-opaque window, since the color is drawn using NSCompositeCopy.
156 */
157 - (void)setBackgroundColor:(NSColor *)backgroundColor;
158
159 /*!
160     @method backgroundColor
161     @result Returns the background color drawn under transparent page background colors and images.
162     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
163     in a non-opaque window, since the color is drawn using NSCompositeCopy.
164 */
165 - (NSColor *)backgroundColor;
166
167 /*!
168 Could be worth adding to the API.
169  @method loadItemsFromOtherView:
170  @abstract Loads the view with the contents of the other view, including its backforward list.
171  @param otherView   The WebView from which to copy contents.
172  */
173 - (void)_loadBackForwardListFromOtherView:(WebView *)otherView;
174
175 + (NSArray *)_supportedFileExtensions;
176
177 /*!
178     @method canShowFile:
179     @abstract Checks if the WebKit can show the content of the file at the specified path.
180     @param path The path of the file to check
181     @result YES if the WebKit can show the content of the file at the specified path.
182 */
183 + (BOOL)canShowFile:(NSString *)path;
184
185 /*!
186     @method suggestedFileExtensionForMIMEType:
187     @param MIMEType The MIME type to check.
188     @result The extension based on the MIME type
189 */
190 + (NSString *)suggestedFileExtensionForMIMEType: (NSString *)MIMEType;
191
192 // May well become public
193 - (void)_setFormDelegate:(id<WebFormDelegate>)delegate;
194 - (id<WebFormDelegate>)_formDelegate;
195
196 - (void)_close;
197
198 /*!
199     @method _registerViewClass:representationClass:forURLScheme:
200     @discussion Register classes that implement WebDocumentView and WebDocumentRepresentation respectively.
201     @param viewClass The WebDocumentView class to use to render data for a given MIME type.
202     @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
203     @param scheme The URL scheme to represent with an object of the given class.
204 */
205 + (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
206
207 + (void)_unregisterViewClassAndRepresentationClassForMIMEType:(NSString *)MIMEType;
208
209 /*!
210      @method _canHandleRequest:
211      @abstract Performs a "preflight" operation that performs some
212      speculative checks to see if a request can be used to create
213      a WebDocumentView and WebDocumentRepresentation.
214      @discussion The result of this method is valid only as long as no
215      protocols or schemes are registered or unregistered, and as long as
216      the request is not mutated (if the request is mutable). Hence, clients
217      should be prepared to handle failures even if they have performed request
218      preflighting by caling this method.
219      @param request The request to preflight.
220      @result YES if it is likely that a WebDocumentView and WebDocumentRepresentation
221      can be created for the request, NO otherwise.
222 */
223 + (BOOL)_canHandleRequest:(NSURLRequest *)request;
224
225 + (NSString *)_decodeData:(NSData *)data;
226
227 + (void)_setAlwaysUseATSU:(BOOL)f;
228
229 - (NSCachedURLResponse *)_cachedResponseForURL:(NSURL *)URL;
230
231 - (void)_addScrollerDashboardRegions:(NSMutableDictionary *)regions;
232 - (NSDictionary *)_dashboardRegions;
233
234 - (void)_setDashboardBehavior:(WebDashboardBehavior)behavior to:(BOOL)flag;
235 - (void)handleAuthenticationForResource:(id)identifier challenge:(NSURLAuthenticationChallenge *)challenge fromDataSource:(WebDataSource *)dataSource;
236 - (BOOL)_dashboardBehavior:(WebDashboardBehavior)behavior;
237
238 + (void)_setShouldUseFontSmoothing:(BOOL)f;
239 + (BOOL)_shouldUseFontSmoothing;
240
241 + (NSString *)_minimumRequiredSafariBuildNumber;
242
243 /*!
244     @method setAlwaysShowVerticalScroller:
245     @result Forces the vertical scroller to be visible if flag is YES, otherwise
246     if flag is NO the scroller with automatically show and hide as needed.
247  */
248 - (void)setAlwaysShowVerticalScroller:(BOOL)flag;
249
250 /*!
251     @method alwaysShowVerticalScroller
252     @result YES if the vertical scroller is always shown
253  */
254 - (BOOL)alwaysShowVerticalScroller;
255
256 /*!
257     @method setAlwaysShowHorizontalScroller:
258     @result Forces the horizontal scroller to be visible if flag is YES, otherwise
259     if flag is NO the scroller with automatically show and hide as needed.
260  */
261 - (void)setAlwaysShowHorizontalScroller:(BOOL)flag;
262
263 /*!
264     @method alwaysShowHorizontalScroller
265     @result YES if the horizontal scroller is always shown
266  */
267 - (BOOL)alwaysShowHorizontalScroller;
268
269 /*!
270     @method setProhibitsMainFrameScrolling:
271     @abstract Prohibits scrolling in the WebView's main frame.  Used to "lock" a WebView
272     to a specific scroll position.
273   */
274 - (void)setProhibitsMainFrameScrolling:(BOOL)prohibits;
275
276 /*!
277     @method _setAdditionalWebPlugInPaths:
278     @abstract Sets additional plugin search paths for a specific WebView.
279  */
280 - (void)_setAdditionalWebPlugInPaths:(NSArray *)newPaths;
281
282 /*!
283     @method _setInViewSourceMode:
284     @abstract Used to place a WebView into a special source-viewing mode.
285   */
286 - (void)_setInViewSourceMode:(BOOL)flag;
287
288 /*!
289     @method _inViewSourceMode;
290     @abstract Whether or not the WebView is in source-view mode for HTML.
291   */
292 - (BOOL)_inViewSourceMode;
293
294 /*!
295     @method _attachScriptDebuggerToAllFrames
296     @abstract Attaches a script debugger to all frames belonging to the receiver.
297  */
298 - (void)_attachScriptDebuggerToAllFrames;
299
300 /*!
301     @method _detachScriptDebuggerFromAllFrames
302     @abstract Detaches any script debuggers from all frames belonging to the receiver.
303  */
304 - (void)_detachScriptDebuggerFromAllFrames;
305
306 - (BOOL)defersCallbacks; // called by QuickTime plug-in
307 - (void)setDefersCallbacks:(BOOL)defer; // called by QuickTime plug-in
308
309 @end
310
311 @interface WebView (WebViewPrintingPrivate)
312 /*!
313     @method _adjustPrintingMarginsForHeaderAndFooter:
314     @abstract Increase the top and bottom margins for the current print operation to
315     account for the header and footer height. 
316     @discussion Called by <WebDocument> implementors once when a print job begins. If the
317     <WebDocument> implementor implements knowsPageRange:, this should be called from there.
318     Otherwise this should be called from beginDocument. The <WebDocument> implementors need
319     to also call _drawHeaderAndFooter.
320 */
321 - (void)_adjustPrintingMarginsForHeaderAndFooter;
322
323 /*!
324     @method _drawHeaderAndFooter
325     @abstract Gives the WebView's UIDelegate a chance to draw a header and footer on the
326     printed page. 
327     @discussion This should be called by <WebDocument> implementors from an override of
328     drawPageBorderWithSize:.
329 */
330 - (void)_drawHeaderAndFooter;
331 @end
332
333 #if !BUILDING_ON_TIGER
334 @interface WebView (WebViewGrammarChecking)
335
336 // FIXME: These two methods should be merged into WebViewEditing when we're not in API freeze
337 - (BOOL)isGrammarCheckingEnabled;
338 - (void)setGrammarCheckingEnabled:(BOOL)flag;
339
340 // FIXME: This method should be merged into WebIBActions when we're not in API freeze
341 - (void)toggleGrammarChecking:(id)sender;
342 @end
343 #endif
344
345 @interface WebView (WebViewEditingInMail)
346 - (void)_insertNewlineInQuotedContent;
347 - (BOOL)_selectWordBeforeMenuEvent;
348 - (void)_setSelectWordBeforeMenuEvent:(BOOL)flag;
349 - (void)_replaceSelectionWithNode:(DOMNode *)node matchStyle:(BOOL)matchStyle;
350 @end
351
352 @interface _WebSafeForwarder : NSObject
353 {
354     id target; // Non-retained. Don't retain delegates.
355     id defaultTarget;
356     Class templateClass;
357 }
358 - (id)initWithTarget:(id)t defaultTarget:(id)dt templateClass:(Class)aClass;
359 + (id)safeForwarderWithTarget:(id)t defaultTarget:(id)dt templateClass:(Class)aClass;
360 @end
361
362 @interface NSObject (WebFrameLoadDelegatePrivate)
363 - (void)webView:(WebView *)sender didFirstLayoutInFrame:(WebFrame *)frame;
364 // Addresses 4192534.  Private API for now.
365 - (void)webView:(WebView *)sender didHandleOnloadEventsForFrame:(WebFrame *)frame;
366 @end
367
368 #undef WebNSInteger