dbe094c15ce11088de163d0bea7a400a4a2f116d
[WebKit-https.git] / Source / WebKit / mac / WebView / WebViewPrivate.h
1 /*
2  * Copyright (C) 2005, 2006, 2007, 2008, 2009 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 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 #import <JavaScriptCore/JSBase.h>
32
33 #if !defined(ENABLE_DASHBOARD_SUPPORT)
34 #define ENABLE_DASHBOARD_SUPPORT 1
35 #endif
36
37 @class NSError;
38 @class WebFrame;
39 @class WebDeviceOrientation;
40 @class WebGeolocationPosition;
41 @class WebInspector;
42 @class WebPreferences;
43 @class WebScriptWorld;
44 @class WebTextIterator;
45
46 @protocol WebDeviceOrientationProvider;
47 @protocol WebFormDelegate;
48
49 extern NSString *_WebCanGoBackKey;
50 extern NSString *_WebCanGoForwardKey;
51 extern NSString *_WebEstimatedProgressKey;
52 extern NSString *_WebIsLoadingKey;
53 extern NSString *_WebMainFrameIconKey;
54 extern NSString *_WebMainFrameTitleKey;
55 extern NSString *_WebMainFrameURLKey;
56 extern NSString *_WebMainFrameDocumentKey;
57
58 // pending public WebElementDictionary keys
59 extern NSString *WebElementTitleKey;             // NSString of the title of the element (used by Safari)
60 extern NSString *WebElementSpellingToolTipKey;   // NSString of a tooltip representing misspelling or bad grammar (used internally)
61 extern NSString *WebElementIsContentEditableKey; // NSNumber indicating whether the inner non-shared node is content editable (used internally)
62 extern NSString *WebElementMediaURLKey;          // NSURL of the media element
63
64 // other WebElementDictionary keys
65 extern NSString *WebElementLinkIsLiveKey;        // NSNumber of BOOL indicating whether the link is live or not
66 extern NSString *WebElementIsInScrollBarKey;
67
68 // One of the subviews of the WebView entered compositing mode.
69 extern NSString *_WebViewDidStartAcceleratedCompositingNotification;
70
71 #if ENABLE_DASHBOARD_SUPPORT
72 typedef enum {
73     WebDashboardBehaviorAlwaysSendMouseEventsToAllWindows,
74     WebDashboardBehaviorAlwaysSendActiveNullEventsToPlugIns,
75     WebDashboardBehaviorAlwaysAcceptsFirstMouse,
76     WebDashboardBehaviorAllowWheelScrolling,
77     WebDashboardBehaviorUseBackwardCompatibilityMode
78 } WebDashboardBehavior;
79 #endif
80
81 typedef enum {
82     WebInjectAtDocumentStart,
83     WebInjectAtDocumentEnd,
84 } WebUserScriptInjectionTime;
85
86 typedef enum {
87     WebInjectInAllFrames,
88     WebInjectInTopFrameOnly
89 } WebUserContentInjectedFrames;
90
91 enum {
92     WebFindOptionsCaseInsensitive = 1 << 0,
93     WebFindOptionsAtWordStarts = 1 << 1,
94     WebFindOptionsTreatMedialCapitalAsWordStart = 1 << 2,
95     WebFindOptionsBackwards = 1 << 3,
96     WebFindOptionsWrapAround = 1 << 4,
97     WebFindOptionsStartInSelection = 1 << 5
98 };
99 typedef NSUInteger WebFindOptions;
100
101 typedef enum {
102     WebPaginationModeUnpaginated,
103     WebPaginationModeHorizontal,
104     WebPaginationModeVertical,
105 } WebPaginationMode;
106
107 @interface WebController : NSTreeController {
108     IBOutlet WebView *webView;
109 }
110 - (WebView *)webView;
111 - (void)setWebView:(WebView *)newWebView;
112 @end
113
114 @interface WebView (WebViewEditingActionsPendingPublic)
115
116 - (void)outdent:(id)sender;
117
118 @end
119
120 @interface WebView (WebPendingPublic)
121
122 - (void)scheduleInRunLoop:(NSRunLoop *)runLoop forMode:(NSString *)mode;
123 - (void)unscheduleFromRunLoop:(NSRunLoop *)runLoop forMode:(NSString *)mode;
124
125 - (BOOL)findString:(NSString *)string options:(WebFindOptions)options;
126 - (DOMRange *)DOMRangeOfString:(NSString *)string relativeTo:(DOMRange *)previousRange options:(WebFindOptions)options;
127
128 - (void)setMainFrameDocumentReady:(BOOL)mainFrameDocumentReady;
129
130 - (void)setTabKeyCyclesThroughElements:(BOOL)cyclesElements;
131 - (BOOL)tabKeyCyclesThroughElements;
132
133 - (void)scrollDOMRangeToVisible:(DOMRange *)range;
134
135 // setHoverFeedbackSuspended: can be called by clients that want to temporarily prevent the webView
136 // from displaying feedback about mouse position. Each WebDocumentView class that displays feedback
137 // about mouse position should honor this setting.
138 - (void)setHoverFeedbackSuspended:(BOOL)newValue;
139 - (BOOL)isHoverFeedbackSuspended;
140
141 /*!
142 @method setScriptDebugDelegate:
143 @abstract Set the WebView's WebScriptDebugDelegate delegate.
144 @param delegate The WebScriptDebugDelegate to set as the delegate.
145 */    
146 - (void)setScriptDebugDelegate:(id)delegate;
147
148 /*!
149 @method scriptDebugDelegate
150 @abstract Return the WebView's WebScriptDebugDelegate.
151 @result The WebView's WebScriptDebugDelegate.
152 */    
153 - (id)scriptDebugDelegate;
154
155 /*!
156     @method setHistoryDelegate:
157     @abstract Set the WebView's WebHistoryDelegate delegate.
158     @param delegate The WebHistoryDelegate to set as the delegate.
159 */    
160 - (void)setHistoryDelegate:(id)delegate;
161
162 /*!
163     @method historyDelegate
164     @abstract Return the WebView's WebHistoryDelegate delegate.
165     @result The WebView's WebHistoryDelegate delegate.
166 */    
167 - (id)historyDelegate;
168
169 - (BOOL)shouldClose;
170
171 /*!
172     @method aeDescByEvaluatingJavaScriptFromString:
173     @param script The text of the JavaScript.
174     @result The result of the script, converted to an NSAppleEventDescriptor, or nil for failure.
175 */
176 - (NSAppleEventDescriptor *)aeDescByEvaluatingJavaScriptFromString:(NSString *)script;
177
178 // Support for displaying multiple text matches.
179 // These methods might end up moving into a protocol, so different document types can specify
180 // whether or not they implement the protocol. For now we'll just deal with HTML.
181 // These methods are still in flux; don't rely on them yet.
182 - (BOOL)canMarkAllTextMatches;
183 - (NSUInteger)countMatchesForText:(NSString *)string options:(WebFindOptions)options highlight:(BOOL)highlight limit:(NSUInteger)limit markMatches:(BOOL)markMatches;
184 - (NSUInteger)countMatchesForText:(NSString *)string inDOMRange:(DOMRange *)range options:(WebFindOptions)options highlight:(BOOL)highlight limit:(NSUInteger)limit markMatches:(BOOL)markMatches;
185 - (void)unmarkAllTextMatches;
186 - (NSArray *)rectsForTextMatches;
187
188 // Support for disabling registration with the undo manager. This is equivalent to the methods with the same names on NSTextView.
189 - (BOOL)allowsUndo;
190 - (void)setAllowsUndo:(BOOL)flag;
191
192 /*!
193     @method setPageSizeMultiplier:
194     @abstract Change the zoom factor of the page in views managed by this webView.
195     @param multiplier A fractional percentage value, 1.0 is 100%.
196 */    
197 - (void)setPageSizeMultiplier:(float)multiplier;
198
199 /*!
200     @method pageSizeMultiplier
201     @result The page size multipler.
202 */    
203 - (float)pageSizeMultiplier;
204
205 // Commands for doing page zoom.  Will end up in WebView (WebIBActions) <NSUserInterfaceValidations>
206 - (BOOL)canZoomPageIn;
207 - (IBAction)zoomPageIn:(id)sender;
208 - (BOOL)canZoomPageOut;
209 - (IBAction)zoomPageOut:(id)sender;
210 - (BOOL)canResetPageZoom;
211 - (IBAction)resetPageZoom:(id)sender;
212
213 // Sets a master volume control for all media elements in the WebView. Valid values are 0..1.
214 - (void)setMediaVolume:(float)volume;
215 - (float)mediaVolume;
216
217 // Add visited links
218 - (void)addVisitedLinks:(NSArray *)visitedLinks;
219
220 @end
221
222 @interface WebView (WebPrivate)
223
224 - (WebInspector *)inspector;
225
226 /*!
227     @method setBackgroundColor:
228     @param backgroundColor Color to use as the default background.
229     @abstract Sets what color the receiver draws under transparent page background colors and images.
230     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
231     in a non-opaque window, since the color is drawn using NSCompositeCopy.
232 */
233 - (void)setBackgroundColor:(NSColor *)backgroundColor;
234
235 /*!
236     @method backgroundColor
237     @result Returns the background color drawn under transparent page background colors and images.
238     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
239     in a non-opaque window, since the color is drawn using NSCompositeCopy.
240 */
241 - (NSColor *)backgroundColor;
242
243 /*!
244 Could be worth adding to the API.
245  @method _loadBackForwardListFromOtherView:
246  @abstract Loads the view with the contents of the other view, including its backforward list.
247  @param otherView   The WebView from which to copy contents.
248  */
249 - (void)_loadBackForwardListFromOtherView:(WebView *)otherView;
250
251 /*
252  @method _reportException:inContext:
253  @abstract Logs the exception to the Web Inspector. This only needs called for exceptions that
254  occur while using the JavaScriptCore APIs with a context owned by a WebKit.
255  @param exception The exception value to log.
256  @param context   The context the exception occured in.
257 */
258 + (void)_reportException:(JSValueRef)exception inContext:(JSContextRef)context;
259
260 /*!
261  @method _dispatchPendingLoadRequests:
262  @abstract Dispatches any pending load requests that have been scheduled because of recent DOM additions or style changes.
263  @discussion You only need to call this method if you require synchronous notification of loads through the resource load delegate.
264  Otherwise the resource load delegate will be notified about loads during a future run loop iteration.
265  */
266 - (void)_dispatchPendingLoadRequests;
267
268 + (NSArray *)_supportedFileExtensions;
269
270 /*!
271     @method canShowFile:
272     @abstract Checks if the WebKit can show the content of the file at the specified path.
273     @param path The path of the file to check
274     @result YES if the WebKit can show the content of the file at the specified path.
275 */
276 + (BOOL)canShowFile:(NSString *)path;
277
278 /*!
279     @method suggestedFileExtensionForMIMEType:
280     @param MIMEType The MIME type to check.
281     @result The extension based on the MIME type
282 */
283 + (NSString *)suggestedFileExtensionForMIMEType: (NSString *)MIMEType;
284
285 + (NSString *)_standardUserAgentWithApplicationName:(NSString *)applicationName;
286
287 /*!
288     @method canCloseAllWebViews
289     @abstract Checks if all the open WebViews can be closed (by dispatching the beforeUnload event to the pages).
290     @result YES if all the WebViews can be closed.
291 */
292 + (BOOL)canCloseAllWebViews;
293
294 // May well become public
295 - (void)_setFormDelegate:(id<WebFormDelegate>)delegate;
296 - (id<WebFormDelegate>)_formDelegate;
297
298 - (BOOL)_isClosed;
299
300 // _close is now replaced by public method -close. It remains here only for backward compatibility
301 // until callers can be weaned off of it.
302 - (void)_close;
303
304 // Indicates if the WebView is in the midst of a user gesture.
305 - (BOOL)_isProcessingUserGesture;
306
307 // SPI for DumpRenderTree
308 - (void)_updateActiveState;
309
310 /*!
311     @method _registerViewClass:representationClass:forURLScheme:
312     @discussion Register classes that implement WebDocumentView and WebDocumentRepresentation respectively.
313     @param viewClass The WebDocumentView class to use to render data for a given MIME type.
314     @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
315     @param scheme The URL scheme to represent with an object of the given class.
316 */
317 + (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
318
319 + (void)_unregisterViewClassAndRepresentationClassForMIMEType:(NSString *)MIMEType;
320
321 /*!
322      @method _canHandleRequest:
323      @abstract Performs a "preflight" operation that performs some
324      speculative checks to see if a request can be used to create
325      a WebDocumentView and WebDocumentRepresentation.
326      @discussion The result of this method is valid only as long as no
327      protocols or schemes are registered or unregistered, and as long as
328      the request is not mutated (if the request is mutable). Hence, clients
329      should be prepared to handle failures even if they have performed request
330      preflighting by caling this method.
331      @param request The request to preflight.
332      @result YES if it is likely that a WebDocumentView and WebDocumentRepresentation
333      can be created for the request, NO otherwise.
334 */
335 + (BOOL)_canHandleRequest:(NSURLRequest *)request;
336
337 + (NSString *)_decodeData:(NSData *)data;
338
339 + (void)_setAlwaysUsesComplexTextCodePath:(BOOL)f;
340 // This is the old name of the above method. Needed for Safari versions that call it.
341 + (void)_setAlwaysUseATSU:(BOOL)f;
342
343 + (void)_setAllowsRoundingHacks:(BOOL)allowsRoundingHacks;
344 + (BOOL)_allowsRoundingHacks;
345
346 - (NSCachedURLResponse *)_cachedResponseForURL:(NSURL *)URL;
347
348 #if ENABLE_DASHBOARD_SUPPORT
349 - (void)_addScrollerDashboardRegions:(NSMutableDictionary *)regions;
350 - (NSDictionary *)_dashboardRegions;
351
352 - (void)_setDashboardBehavior:(WebDashboardBehavior)behavior to:(BOOL)flag;
353 - (BOOL)_dashboardBehavior:(WebDashboardBehavior)behavior;
354 #endif
355
356 + (void)_setShouldUseFontSmoothing:(BOOL)f;
357 + (BOOL)_shouldUseFontSmoothing;
358
359 - (void)_setCatchesDelegateExceptions:(BOOL)f;
360 - (BOOL)_catchesDelegateExceptions;
361
362 // These two methods are useful for a test harness that needs a consistent appearance for the focus rings
363 // regardless of OS X version.
364 + (void)_setUsesTestModeFocusRingColor:(BOOL)f;
365 + (BOOL)_usesTestModeFocusRingColor;
366
367 /*!
368     @method setAlwaysShowVerticalScroller:
369     @result Forces the vertical scroller to be visible if flag is YES, otherwise
370     if flag is NO the scroller with automatically show and hide as needed.
371  */
372 - (void)setAlwaysShowVerticalScroller:(BOOL)flag;
373
374 /*!
375     @method alwaysShowVerticalScroller
376     @result YES if the vertical scroller is always shown
377  */
378 - (BOOL)alwaysShowVerticalScroller;
379
380 /*!
381     @method setAlwaysShowHorizontalScroller:
382     @result Forces the horizontal scroller to be visible if flag is YES, otherwise
383     if flag is NO the scroller with automatically show and hide as needed.
384  */
385 - (void)setAlwaysShowHorizontalScroller:(BOOL)flag;
386
387 /*!
388     @method alwaysShowHorizontalScroller
389     @result YES if the horizontal scroller is always shown
390  */
391 - (BOOL)alwaysShowHorizontalScroller;
392
393 /*!
394     @method setProhibitsMainFrameScrolling:
395     @abstract Prohibits scrolling in the WebView's main frame.  Used to "lock" a WebView
396     to a specific scroll position.
397   */
398 - (void)setProhibitsMainFrameScrolling:(BOOL)prohibits;
399
400 /*!
401     @method _setAdditionalWebPlugInPaths:
402     @abstract Sets additional plugin search paths for a specific WebView.
403  */
404 - (void)_setAdditionalWebPlugInPaths:(NSArray *)newPaths;
405
406 /*!
407     @method _setInViewSourceMode:
408     @abstract Used to place a WebView into a special source-viewing mode.
409   */
410 - (void)_setInViewSourceMode:(BOOL)flag;
411
412 /*!
413     @method _inViewSourceMode;
414     @abstract Whether or not the WebView is in source-view mode for HTML.
415   */
416 - (BOOL)_inViewSourceMode;
417
418 /*!
419     @method _attachScriptDebuggerToAllFrames
420     @abstract Attaches a script debugger to all frames belonging to the receiver.
421  */
422 - (void)_attachScriptDebuggerToAllFrames;
423
424 /*!
425     @method _detachScriptDebuggerFromAllFrames
426     @abstract Detaches any script debuggers from all frames belonging to the receiver.
427  */
428 - (void)_detachScriptDebuggerFromAllFrames;
429
430 - (BOOL)defersCallbacks; // called by QuickTime plug-in
431 - (void)setDefersCallbacks:(BOOL)defer; // called by QuickTime plug-in
432
433 - (BOOL)usesPageCache;
434 - (void)setUsesPageCache:(BOOL)usesPageCache;
435
436 - (WebHistoryItem *)_globalHistoryItem;
437
438 /*!
439     @method textIteratorForRect:
440     @param rect The rectangle of the document that we're interested in text from.
441     @result WebTextIterator object, initialized with a range that corresponds to
442     the passed-in rectangle.
443     @abstract This method gives the text for the approximate range of the document
444     corresponding to the rectangle. The range is determined by using hit testing at
445     the top left and bottom right of the rectangle. Because of that, there can be
446     text visible in the rectangle that is not included in the iterator. If you need
447     a guarantee of iterating all text that is visible, then you need to instead make
448     a WebTextIterator with a DOMRange that covers the entire document.
449  */
450 - (WebTextIterator *)textIteratorForRect:(NSRect)rect;
451
452 #if ENABLE_DASHBOARD_SUPPORT
453 // <rdar://problem/5217124> Clients other than Dashboard, don't use this.
454 // As of this writing, Dashboard uses this on Tiger, but not on Leopard or newer.
455 - (void)handleAuthenticationForResource:(id)identifier challenge:(NSURLAuthenticationChallenge *)challenge fromDataSource:(WebDataSource *)dataSource;
456 #endif
457
458 - (void)_clearUndoRedoOperations;
459
460 /* Used to do fast (lower quality) scaling of images so that window resize can be quick. */
461 - (BOOL)_inFastImageScalingMode;
462 - (void)_setUseFastImageScalingMode:(BOOL)flag;
463
464 - (BOOL)_cookieEnabled;
465 - (void)_setCookieEnabled:(BOOL)enable;
466
467 // SPI for DumpRenderTree
468 - (void)_executeCoreCommandByName:(NSString *)name value:(NSString *)value;
469 - (void)_clearMainFrameName;
470
471 - (void)_setCustomHTMLTokenizerTimeDelay:(double)timeDelay;
472 - (void)_setCustomHTMLTokenizerChunkSize:(int)chunkSize;
473
474 - (void)setSelectTrailingWhitespaceEnabled:(BOOL)flag;
475 - (BOOL)isSelectTrailingWhitespaceEnabled;
476
477 - (void)setMemoryCacheDelegateCallsEnabled:(BOOL)suspend;
478 - (BOOL)areMemoryCacheDelegateCallsEnabled;
479
480 - (void)_setJavaScriptURLsAreAllowed:(BOOL)setJavaScriptURLsAreAllowed;
481
482 + (NSCursor *)_pointingHandCursor;
483
484 // SPI for DumpRenderTree
485 - (BOOL)_postsAcceleratedCompositingNotifications;
486 - (void)_setPostsAcceleratedCompositingNotifications:(BOOL)flag;
487 - (BOOL)_isUsingAcceleratedCompositing;
488 - (void)_setBaseCTM:(CGAffineTransform)transform forContext:(CGContextRef)context;
489
490 // For DumpRenderTree
491 - (BOOL)interactiveFormValidationEnabled;
492 - (void)setInteractiveFormValidationEnabled:(BOOL)enabled;
493 - (int)validationMessageTimerMagnification;
494 - (void)setValidationMessageTimerMagnification:(int)newValue;
495
496 // Returns YES if NSView -displayRectIgnoringOpacity:inContext: will produce a faithful representation of the content.
497 - (BOOL)_isSoftwareRenderable;
498 // When drawing into a bitmap context, we normally flatten compositing layers (and distort 3D transforms).
499 // Clients who are able to capture their own copy of the compositing layers need to be able to disable this.
500 - (void)_setIncludesFlattenedCompositingLayersWhenDrawingToBitmap:(BOOL)flag;
501 - (BOOL)_includesFlattenedCompositingLayersWhenDrawingToBitmap;
502
503 - (void)setTracksRepaints:(BOOL)flag;
504 - (BOOL)isTrackingRepaints;
505 - (void)resetTrackedRepaints;
506 - (NSArray*)trackedRepaintRects; // Returned array contains rectValue NSValues.
507
508 // Which pasteboard text is coming from in editing delegate methods such as shouldInsertNode.
509 - (NSPasteboard *)_insertionPasteboard;
510
511 // Whitelists access from an origin (sourceOrigin) to a set of one or more origins described by the parameters:
512 // - destinationProtocol: The protocol to grant access to.
513 // - destinationHost: The host to grant access to.
514 // - allowDestinationSubdomains: If host is a domain, setting this to YES will whitelist host and all its subdomains, recursively.
515 + (void)_addOriginAccessWhitelistEntryWithSourceOrigin:(NSString *)sourceOrigin destinationProtocol:(NSString *)destinationProtocol destinationHost:(NSString *)destinationHost allowDestinationSubdomains:(BOOL)allowDestinationSubdomains;
516 + (void)_removeOriginAccessWhitelistEntryWithSourceOrigin:(NSString *)sourceOrigin destinationProtocol:(NSString *)destinationProtocol destinationHost:(NSString *)destinationHost allowDestinationSubdomains:(BOOL)allowDestinationSubdomains;
517
518 // Removes all white list entries created with _addOriginAccessWhitelistEntryWithSourceOrigin.
519 + (void)_resetOriginAccessWhitelists;
520
521 // FIXME: The following two methods are deprecated in favor of the overloads below that take the WebUserContentInjectedFrames argument. https://bugs.webkit.org/show_bug.cgi?id=41800.
522 + (void)_addUserScriptToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist injectionTime:(WebUserScriptInjectionTime)injectionTime;
523 + (void)_addUserStyleSheetToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist;
524
525 + (void)_addUserScriptToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist injectionTime:(WebUserScriptInjectionTime)injectionTime injectedFrames:(WebUserContentInjectedFrames)injectedFrames;
526 + (void)_addUserStyleSheetToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist injectedFrames:(WebUserContentInjectedFrames)injectedFrames;
527 + (void)_removeUserScriptFromGroup:(NSString *)groupName world:(WebScriptWorld *)world url:(NSURL *)url;
528 + (void)_removeUserStyleSheetFromGroup:(NSString *)groupName world:(WebScriptWorld *)world url:(NSURL *)url;
529 + (void)_removeUserScriptsFromGroup:(NSString *)groupName world:(WebScriptWorld *)world;
530 + (void)_removeUserStyleSheetsFromGroup:(NSString *)groupName world:(WebScriptWorld *)world;
531 + (void)_removeAllUserContentFromGroup:(NSString *)groupName;
532
533 // SPI for DumpRenderTree
534 + (void)_setLoadResourcesSerially:(BOOL)serialize;
535
536 /*!
537     @method cssAnimationsSuspended
538     @abstract Returns whether or not CSS Animations are suspended.
539     @result YES if CSS Animations are suspended.
540 */
541 - (BOOL)cssAnimationsSuspended;
542
543 /*!
544     @method setCSSAnimationsSuspended
545     @param paused YES to suspend animations, NO to resume animations.
546     @discussion Suspends or resumes all running animations and transitions in the page.
547 */
548 - (void)setCSSAnimationsSuspended:(BOOL)suspended;
549
550 + (void)_setDomainRelaxationForbidden:(BOOL)forbidden forURLScheme:(NSString *)scheme;
551 + (void)_registerURLSchemeAsSecure:(NSString *)scheme;
552 + (void)_registerURLSchemeAsAllowingLocalStorageAccessInPrivateBrowsing:(NSString *)scheme;
553 + (void)_registerURLSchemeAsAllowingDatabaseAccessInPrivateBrowsing:(NSString *)scheme;
554
555 - (void)_scaleWebView:(float)scale atOrigin:(NSPoint)origin;
556 - (float)_viewScaleFactor;
557
558 - (void)_setUseFixedLayout:(BOOL)fixed;
559 - (void)_setFixedLayoutSize:(NSSize)size;
560
561 - (BOOL)_useFixedLayout;
562 - (NSSize)_fixedLayoutSize;
563
564 - (void)_setPaginationMode:(WebPaginationMode)paginationMode;
565 - (WebPaginationMode)_paginationMode;
566 // Set to 0 to have the page length equal the view length.
567 - (void)_setPageLength:(CGFloat)pageLength;
568 - (CGFloat)_pageLength;
569 - (void)_setGapBetweenPages:(CGFloat)pageGap;
570 - (CGFloat)_gapBetweenPages;
571 - (NSUInteger)_pageCount;
572
573 - (void)_setCustomBackingScaleFactor:(CGFloat)overrideScaleFactor;
574 - (CGFloat)_backingScaleFactor;
575
576 // Deprecated. Use the methods in pending public above instead.
577 - (NSUInteger)markAllMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight limit:(NSUInteger)limit;
578 - (NSUInteger)countMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight limit:(NSUInteger)limit markMatches:(BOOL)markMatches;
579
580 /*!
581  @method searchFor:direction:caseSensitive:wrap:startInSelection:
582  @abstract Searches a document view for a string and highlights the string if it is found.
583  Starts the search from the current selection.  Will search across all frames.
584  @param string The string to search for.
585  @param forward YES to search forward, NO to seach backwards.
586  @param caseFlag YES to for case-sensitive search, NO for case-insensitive search.
587  @param wrapFlag YES to wrap around, NO to avoid wrapping.
588  @param startInSelection YES to begin search in the selected text (useful for incremental searching), NO to begin search after the selected text.
589  @result YES if found, NO if not found.
590  */
591 // Deprecated. Use findString.
592 - (BOOL)searchFor:(NSString *)string direction:(BOOL)forward caseSensitive:(BOOL)caseFlag wrap:(BOOL)wrapFlag startInSelection:(BOOL)startInSelection;
593
594 /*!
595     @method defaultMinimumTimerInterval
596     @discussion Should consider moving this to the public API.
597     @result Returns the default minimum timer interval.
598 */
599 + (double)_defaultMinimumTimerInterval;
600
601 /*!
602     @method setMinimumTimerInterval:
603     @discussion Sets the minimum interval for DOMTimers in this WebView. This method is
604     exposed here in the Mac port rather than through WebPreferences (which generally
605     governs Settings) because this value is something adjusted at run time, not set
606     globally via "defaults write". Should consider adding this to the public API.
607     @param intervalInSeconds The new minimum timer interval, in seconds.
608 */
609 - (void)_setMinimumTimerInterval:(double)intervalInSeconds;
610
611 /*!
612     @method _HTTPPipeliningEnabled
613     @abstract Checks the HTTP pipelining status.
614     @discussion Defaults to NO.
615     @result YES if HTTP pipelining is enabled, NO if not enabled.
616  */
617 + (BOOL)_HTTPPipeliningEnabled;
618
619 /*!
620     @method _setHTTPPipeliningEnabled:
621     @abstract Set the HTTP pipelining status.
622     @discussion Defaults to NO.
623     @param enabled The new HTTP pipelining status.
624  */
625 + (void)_setHTTPPipeliningEnabled:(BOOL)enabled;
626
627 @end
628
629 @interface WebView (WebViewPrintingPrivate)
630 /*!
631     @method _adjustPrintingMarginsForHeaderAndFooter:
632     @abstract Increase the top and bottom margins for the current print operation to
633     account for the header and footer height. 
634     @discussion Called by <WebDocument> implementors once when a print job begins. If the
635     <WebDocument> implementor implements knowsPageRange:, this should be called from there.
636     Otherwise this should be called from beginDocument. The <WebDocument> implementors need
637     to also call _drawHeaderAndFooter.
638 */
639 - (void)_adjustPrintingMarginsForHeaderAndFooter;
640
641 /*!
642     @method _drawHeaderAndFooter
643     @abstract Gives the WebView's UIDelegate a chance to draw a header and footer on the
644     printed page. 
645     @discussion This should be called by <WebDocument> implementors from an override of
646     drawPageBorderWithSize:.
647 */
648 - (void)_drawHeaderAndFooter;
649 @end
650
651 @interface WebView (WebViewGrammarChecking)
652
653 // FIXME: These two methods should be merged into WebViewEditing when we're not in API freeze
654 - (BOOL)isGrammarCheckingEnabled;
655 - (void)setGrammarCheckingEnabled:(BOOL)flag;
656
657 // FIXME: This method should be merged into WebIBActions when we're not in API freeze
658 - (void)toggleGrammarChecking:(id)sender;
659
660 @end
661
662 @interface WebView (WebViewTextChecking)
663
664 - (BOOL)isAutomaticQuoteSubstitutionEnabled;
665 - (BOOL)isAutomaticLinkDetectionEnabled;
666 - (BOOL)isAutomaticDashSubstitutionEnabled;
667 - (BOOL)isAutomaticTextReplacementEnabled;
668 - (BOOL)isAutomaticSpellingCorrectionEnabled;
669 #ifndef BUILDING_ON_LEOPARD
670 - (void)setAutomaticQuoteSubstitutionEnabled:(BOOL)flag;
671 - (void)toggleAutomaticQuoteSubstitution:(id)sender;
672 - (void)setAutomaticLinkDetectionEnabled:(BOOL)flag;
673 - (void)toggleAutomaticLinkDetection:(id)sender;
674 - (void)setAutomaticDashSubstitutionEnabled:(BOOL)flag;
675 - (void)toggleAutomaticDashSubstitution:(id)sender;
676 - (void)setAutomaticTextReplacementEnabled:(BOOL)flag;
677 - (void)toggleAutomaticTextReplacement:(id)sender;
678 - (void)setAutomaticSpellingCorrectionEnabled:(BOOL)flag;
679 - (void)toggleAutomaticSpellingCorrection:(id)sender;
680 #endif
681 #if !defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD)
682 - (void)handleCorrectionPanelResult:(NSString*)result;
683 #endif
684 @end
685
686 @interface WebView (WebViewEditingInMail)
687 - (void)_insertNewlineInQuotedContent;
688 - (void)_replaceSelectionWithNode:(DOMNode *)node matchStyle:(BOOL)matchStyle;
689 - (BOOL)_selectionIsCaret;
690 - (BOOL)_selectionIsAll;
691 @end
692
693 @interface WebView (WebViewDeviceOrientation)
694 - (void)_setDeviceOrientationProvider:(id<WebDeviceOrientationProvider>)deviceOrientationProvider;
695 - (id<WebDeviceOrientationProvider>)_deviceOrientationProvider;
696 @end
697
698 @protocol WebGeolocationProvider <NSObject>
699 - (void)registerWebView:(WebView *)webView;
700 - (void)unregisterWebView:(WebView *)webView;
701 - (WebGeolocationPosition *)lastPosition;
702 @end
703
704 @interface WebView (WebViewGeolocation)
705 - (void)_setGeolocationProvider:(id<WebGeolocationProvider>)locationProvider;
706 - (id<WebGeolocationProvider>)_geolocationProvider;
707
708 - (void)_geolocationDidChangePosition:(WebGeolocationPosition *)position;
709 - (void)_geolocationDidFailWithError:(NSError *)error;
710 @end
711
712 @interface WebView (WebViewPrivateStyleInfo)
713 - (JSValueRef)_computedStyleIncludingVisitedInfo:(JSContextRef)context forElement:(JSValueRef)value;
714 @end
715
716 @interface WebView (WebViewPrivateNodesFromRect)
717 - (JSValueRef)_nodesFromRect:(JSContextRef)context forDocument:(JSValueRef)value x:(int)x  y:(int)y top:(unsigned)top right:(unsigned)right bottom:(unsigned)bottom left:(unsigned)left ignoreClipping:(BOOL)ignoreClipping;
718 @end
719
720 @interface NSObject (WebViewFrameLoadDelegatePrivate)
721 - (void)webView:(WebView *)sender didFirstLayoutInFrame:(WebFrame *)frame;
722
723 // didFinishDocumentLoadForFrame is sent when the document has finished loading, though not necessarily all
724 // of its subresources.
725 // FIXME 5259339: Currently this callback is not sent for (some?) pages loaded entirely from the cache.
726 - (void)webView:(WebView *)sender didFinishDocumentLoadForFrame:(WebFrame *)frame;
727
728 // Addresses 4192534.  SPI for now.
729 - (void)webView:(WebView *)sender didHandleOnloadEventsForFrame:(WebFrame *)frame;
730
731 - (void)webView:(WebView *)sender didFirstVisuallyNonEmptyLayoutInFrame:(WebFrame *)frame;
732
733 // For implementing the WebInspector's test harness
734 - (void)webView:(WebView *)webView didClearInspectorWindowObject:(WebScriptObject *)windowObject forFrame:(WebFrame *)frame;
735
736 @end
737
738 @interface NSObject (WebViewResourceLoadDelegatePrivate)
739 // Addresses <rdar://problem/5008925> - SPI for now
740 - (NSCachedURLResponse *)webView:(WebView *)sender resource:(id)identifier willCacheResponse:(NSCachedURLResponse *)response fromDataSource:(WebDataSource *)dataSource;
741 @end
742
743 #ifdef __cplusplus
744 extern "C" {
745 #endif
746
747 // This is a C function to avoid calling +[WebView initialize].
748 void WebInstallMemoryPressureHandler(void);
749
750 #ifdef __cplusplus
751 }
752 #endif