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