37352642fbb53b07f6eeb84ebe0e2de3053dcde5
[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 #if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4
38 #define WebNSInteger int
39 #define WebNSUInteger unsigned int
40 #else
41 #define WebNSInteger NSInteger
42 #define WebNSUInteger NSUInteger
43 #endif
44
45 @class NSError;
46 @class WebFrame;
47 @class WebDeviceOrientation;
48 @class WebGeolocationPosition;
49 @class WebInspector;
50 @class WebPreferences;
51 @class WebScriptWorld;
52 @class WebTextIterator;
53
54 @protocol WebDeviceOrientationProvider;
55 @protocol WebFormDelegate;
56
57 extern NSString *_WebCanGoBackKey;
58 extern NSString *_WebCanGoForwardKey;
59 extern NSString *_WebEstimatedProgressKey;
60 extern NSString *_WebIsLoadingKey;
61 extern NSString *_WebMainFrameIconKey;
62 extern NSString *_WebMainFrameTitleKey;
63 extern NSString *_WebMainFrameURLKey;
64 extern NSString *_WebMainFrameDocumentKey;
65
66 // pending public WebElementDictionary keys
67 extern NSString *WebElementTitleKey;             // NSString of the title of the element (used by Safari)
68 extern NSString *WebElementSpellingToolTipKey;   // NSString of a tooltip representing misspelling or bad grammar (used internally)
69 extern NSString *WebElementIsContentEditableKey; // NSNumber indicating whether the inner non-shared node is content editable (used internally)
70 extern NSString *WebElementMediaURLKey;          // NSURL of the media element
71
72 // other WebElementDictionary keys
73 extern NSString *WebElementLinkIsLiveKey;        // NSNumber of BOOL indicating whether the link is live or not
74 extern NSString *WebElementIsInScrollBarKey;
75
76 // One of the subviews of the WebView entered compositing mode.
77 extern NSString *_WebViewDidStartAcceleratedCompositingNotification;
78
79 #if ENABLE_DASHBOARD_SUPPORT
80 typedef enum {
81     WebDashboardBehaviorAlwaysSendMouseEventsToAllWindows,
82     WebDashboardBehaviorAlwaysSendActiveNullEventsToPlugIns,
83     WebDashboardBehaviorAlwaysAcceptsFirstMouse,
84     WebDashboardBehaviorAllowWheelScrolling,
85     WebDashboardBehaviorUseBackwardCompatibilityMode
86 } WebDashboardBehavior;
87 #endif
88
89 typedef enum {
90     WebInjectAtDocumentStart,
91     WebInjectAtDocumentEnd,
92 } WebUserScriptInjectionTime;
93
94 typedef enum {
95     WebInjectInAllFrames,
96     WebInjectInTopFrameOnly
97 } WebUserContentInjectedFrames;
98
99 enum {
100     WebFindOptionsCaseInsensitive = 1 << 0,
101     WebFindOptionsAtWordStarts = 1 << 1,
102     WebFindOptionsTreatMedialCapitalAsWordStart = 1 << 2,
103     WebFindOptionsBackwards = 1 << 3,
104     WebFindOptionsWrapAround = 1 << 4,
105     WebFindOptionsStartInSelection = 1 << 5
106 };
107 typedef NSUInteger WebFindOptions;
108
109 @interface WebController : NSTreeController {
110     IBOutlet WebView *webView;
111 }
112 - (WebView *)webView;
113 - (void)setWebView:(WebView *)newWebView;
114 @end
115
116 @interface WebView (WebViewEditingActionsPendingPublic)
117
118 - (void)outdent:(id)sender;
119
120 @end
121
122 @interface WebView (WebPendingPublic)
123
124 - (void)scheduleInRunLoop:(NSRunLoop *)runLoop forMode:(NSString *)mode;
125 - (void)unscheduleFromRunLoop:(NSRunLoop *)runLoop forMode:(NSString *)mode;
126
127 - (BOOL)findString:(NSString *)string options:(WebFindOptions)options;
128
129 - (void)setMainFrameDocumentReady:(BOOL)mainFrameDocumentReady;
130
131 - (void)setTabKeyCyclesThroughElements:(BOOL)cyclesElements;
132 - (BOOL)tabKeyCyclesThroughElements;
133
134 - (void)scrollDOMRangeToVisible:(DOMRange *)range;
135
136 // setHoverFeedbackSuspended: can be called by clients that want to temporarily prevent the webView
137 // from displaying feedback about mouse position. Each WebDocumentView class that displays feedback
138 // about mouse position should honor this setting.
139 - (void)setHoverFeedbackSuspended:(BOOL)newValue;
140 - (BOOL)isHoverFeedbackSuspended;
141
142 /*!
143 @method setScriptDebugDelegate:
144 @abstract Set the WebView's WebScriptDebugDelegate delegate.
145 @param delegate The WebScriptDebugDelegate to set as the delegate.
146 */    
147 - (void)setScriptDebugDelegate:(id)delegate;
148
149 /*!
150 @method scriptDebugDelegate
151 @abstract Return the WebView's WebScriptDebugDelegate.
152 @result The WebView's WebScriptDebugDelegate.
153 */    
154 - (id)scriptDebugDelegate;
155
156 /*!
157     @method setHistoryDelegate:
158     @abstract Set the WebView's WebHistoryDelegate delegate.
159     @param delegate The WebHistoryDelegate to set as the delegate.
160 */    
161 - (void)setHistoryDelegate:(id)delegate;
162
163 /*!
164     @method historyDelegate
165     @abstract Return the WebView's WebHistoryDelegate delegate.
166     @result The WebView's WebHistoryDelegate delegate.
167 */    
168 - (id)historyDelegate;
169
170 - (BOOL)shouldClose;
171
172 /*!
173     @method aeDescByEvaluatingJavaScriptFromString:
174     @param script The text of the JavaScript.
175     @result The result of the script, converted to an NSAppleEventDescriptor, or nil for failure.
176 */
177 - (NSAppleEventDescriptor *)aeDescByEvaluatingJavaScriptFromString:(NSString *)script;
178
179 // Support for displaying multiple text matches.
180 // These methods might end up moving into a protocol, so different document types can specify
181 // whether or not they implement the protocol. For now we'll just deal with HTML.
182 // These methods are still in flux; don't rely on them yet.
183 - (BOOL)canMarkAllTextMatches;
184 - (WebNSUInteger)countMatchesForText:(NSString *)string options:(WebFindOptions)options highlight:(BOOL)highlight limit:(WebNSUInteger)limit markMatches:(BOOL)markMatches;
185 - (WebNSUInteger)countMatchesForText:(NSString *)string inDOMRange:(DOMRange *)range options:(WebFindOptions)options highlight:(BOOL)highlight limit:(WebNSUInteger)limit markMatches:(BOOL)markMatches;
186 - (void)unmarkAllTextMatches;
187 - (NSArray *)rectsForTextMatches;
188
189 // Support for disabling registration with the undo manager. This is equivalent to the methods with the same names on NSTextView.
190 - (BOOL)allowsUndo;
191 - (void)setAllowsUndo:(BOOL)flag;
192
193 /*!
194     @method setPageSizeMultiplier:
195     @abstract Change the zoom factor of the page in views managed by this webView.
196     @param multiplier A fractional percentage value, 1.0 is 100%.
197 */    
198 - (void)setPageSizeMultiplier:(float)multiplier;
199
200 /*!
201     @method pageSizeMultiplier
202     @result The page size multipler.
203 */    
204 - (float)pageSizeMultiplier;
205
206 // Commands for doing page zoom.  Will end up in WebView (WebIBActions) <NSUserInterfaceValidations>
207 - (BOOL)canZoomPageIn;
208 - (IBAction)zoomPageIn:(id)sender;
209 - (BOOL)canZoomPageOut;
210 - (IBAction)zoomPageOut:(id)sender;
211 - (BOOL)canResetPageZoom;
212 - (IBAction)resetPageZoom:(id)sender;
213
214 // Sets a master volume control for all media elements in the WebView. Valid values are 0..1.
215 - (void)setMediaVolume:(float)volume;
216 - (float)mediaVolume;
217
218 // Add visited links
219 - (void)addVisitedLinks:(NSArray *)visitedLinks;
220
221 @end
222
223 @interface WebView (WebPrivate)
224
225 - (WebInspector *)inspector;
226
227 /*!
228     @method setBackgroundColor:
229     @param backgroundColor Color to use as the default background.
230     @abstract Sets what color the receiver draws under transparent page background colors and images.
231     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
232     in a non-opaque window, since the color is drawn using NSCompositeCopy.
233 */
234 - (void)setBackgroundColor:(NSColor *)backgroundColor;
235
236 /*!
237     @method backgroundColor
238     @result Returns the background color drawn under transparent page background colors and images.
239     This color is also used when no page is loaded. A color with alpha should only be used when the receiver is
240     in a non-opaque window, since the color is drawn using NSCompositeCopy.
241 */
242 - (NSColor *)backgroundColor;
243
244 /*!
245 Could be worth adding to the API.
246  @method _loadBackForwardListFromOtherView:
247  @abstract Loads the view with the contents of the other view, including its backforward list.
248  @param otherView   The WebView from which to copy contents.
249  */
250 - (void)_loadBackForwardListFromOtherView:(WebView *)otherView;
251
252 /*
253  @method _reportException:inContext:
254  @abstract Logs the exception to the Web Inspector. This only needs called for exceptions that
255  occur while using the JavaScriptCore APIs with a context owned by a WebKit.
256  @param exception The exception value to log.
257  @param context   The context the exception occured in.
258 */
259 + (void)_reportException:(JSValueRef)exception inContext:(JSContextRef)context;
260
261 /*!
262  @method _dispatchPendingLoadRequests:
263  @abstract Dispatches any pending load requests that have been scheduled because of recent DOM additions or style changes.
264  @discussion You only need to call this method if you require synchronous notification of loads through the resource load delegate.
265  Otherwise the resource load delegate will be notified about loads during a future run loop iteration.
266  */
267 - (void)_dispatchPendingLoadRequests;
268
269 + (NSArray *)_supportedFileExtensions;
270
271 /*!
272     @method canShowFile:
273     @abstract Checks if the WebKit can show the content of the file at the specified path.
274     @param path The path of the file to check
275     @result YES if the WebKit can show the content of the file at the specified path.
276 */
277 + (BOOL)canShowFile:(NSString *)path;
278
279 /*!
280     @method suggestedFileExtensionForMIMEType:
281     @param MIMEType The MIME type to check.
282     @result The extension based on the MIME type
283 */
284 + (NSString *)suggestedFileExtensionForMIMEType: (NSString *)MIMEType;
285
286 + (NSString *)_standardUserAgentWithApplicationName:(NSString *)applicationName;
287
288 /*!
289     @method canCloseAllWebViews
290     @abstract Checks if all the open WebViews can be closed (by dispatching the beforeUnload event to the pages).
291     @result YES if all the WebViews can be closed.
292 */
293 + (BOOL)canCloseAllWebViews;
294
295 // May well become public
296 - (void)_setFormDelegate:(id<WebFormDelegate>)delegate;
297 - (id<WebFormDelegate>)_formDelegate;
298
299 - (BOOL)_isClosed;
300
301 // _close is now replaced by public method -close. It remains here only for backward compatibility
302 // until callers can be weaned off of it.
303 - (void)_close;
304
305 // Indicates if the WebView is in the midst of a user gesture.
306 - (BOOL)_isProcessingUserGesture;
307
308 // SPI for DumpRenderTree
309 - (void)_updateActiveState;
310
311 /*!
312     @method _registerViewClass:representationClass:forURLScheme:
313     @discussion Register classes that implement WebDocumentView and WebDocumentRepresentation respectively.
314     @param viewClass The WebDocumentView class to use to render data for a given MIME type.
315     @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
316     @param scheme The URL scheme to represent with an object of the given class.
317 */
318 + (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
319
320 + (void)_unregisterViewClassAndRepresentationClassForMIMEType:(NSString *)MIMEType;
321
322 /*!
323      @method _canHandleRequest:
324      @abstract Performs a "preflight" operation that performs some
325      speculative checks to see if a request can be used to create
326      a WebDocumentView and WebDocumentRepresentation.
327      @discussion The result of this method is valid only as long as no
328      protocols or schemes are registered or unregistered, and as long as
329      the request is not mutated (if the request is mutable). Hence, clients
330      should be prepared to handle failures even if they have performed request
331      preflighting by caling this method.
332      @param request The request to preflight.
333      @result YES if it is likely that a WebDocumentView and WebDocumentRepresentation
334      can be created for the request, NO otherwise.
335 */
336 + (BOOL)_canHandleRequest:(NSURLRequest *)request;
337
338 + (NSString *)_decodeData:(NSData *)data;
339
340 + (void)_setAlwaysUsesComplexTextCodePath:(BOOL)f;
341 // This is the old name of the above method. Needed for Safari versions that call it.
342 + (void)_setAlwaysUseATSU:(BOOL)f;
343
344 + (void)_setAllowsRoundingHacks:(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 - (id)_initWithFrame:(NSRect)f frameName:(NSString *)frameName groupName:(NSString *)groupName usesDocumentViews:(BOOL)usesDocumentViews;
475 - (BOOL)_usesDocumentViews;
476
477 - (void)setSelectTrailingWhitespaceEnabled:(BOOL)flag;
478 - (BOOL)isSelectTrailingWhitespaceEnabled;
479
480 - (void)setMemoryCacheDelegateCallsEnabled:(BOOL)suspend;
481 - (BOOL)areMemoryCacheDelegateCallsEnabled;
482
483 - (void)_setJavaScriptURLsAreAllowed:(BOOL)setJavaScriptURLsAreAllowed;
484
485 + (NSCursor *)_pointingHandCursor;
486
487 // SPI for DumpRenderTree
488 - (BOOL)_postsAcceleratedCompositingNotifications;
489 - (void)_setPostsAcceleratedCompositingNotifications:(BOOL)flag;
490 - (BOOL)_isUsingAcceleratedCompositing;
491
492 // For DumpRenderTree
493 - (BOOL)interactiveFormValidationEnabled;
494 - (void)setInteractiveFormValidationEnabled:(BOOL)enabled;
495 - (int)validationMessageTimerMagnification;
496 - (void)setValidationMessageTimerMagnification:(int)newValue;
497
498 // Returns YES if NSView -displayRectIgnoringOpacity:inContext: will produce a faithful representation of the content.
499 - (BOOL)_isSoftwareRenderable;
500 // When drawing into a bitmap context, we normally flatten compositing layers (and distort 3D transforms).
501 // Clients who are able to capture their own copy of the compositing layers need to be able to disable this.
502 - (void)_setIncludesFlattenedCompositingLayersWhenDrawingToBitmap:(BOOL)flag;
503 - (BOOL)_includesFlattenedCompositingLayersWhenDrawingToBitmap;
504
505 // SPI for PluginHalter
506 + (BOOL)_isNodeHaltedPlugin:(DOMNode *)node;
507 + (BOOL)_hasPluginForNodeBeenHalted:(DOMNode *)node;
508 + (void)_restartHaltedPluginForNode:(DOMNode *)node;
509
510 // Which pasteboard text is coming from in editing delegate methods such as shouldInsertNode.
511 - (NSPasteboard *)_insertionPasteboard;
512
513 // Whitelists access from an origin (sourceOrigin) to a set of one or more origins described by the parameters:
514 // - destinationProtocol: The protocol to grant access to.
515 // - destinationHost: The host to grant access to.
516 // - allowDestinationSubdomains: If host is a domain, setting this to YES will whitelist host and all its subdomains, recursively.
517 + (void)_addOriginAccessWhitelistEntryWithSourceOrigin:(NSString *)sourceOrigin destinationProtocol:(NSString *)destinationProtocol destinationHost:(NSString *)destinationHost allowDestinationSubdomains:(BOOL)allowDestinationSubdomains;
518 + (void)_removeOriginAccessWhitelistEntryWithSourceOrigin:(NSString *)sourceOrigin destinationProtocol:(NSString *)destinationProtocol destinationHost:(NSString *)destinationHost allowDestinationSubdomains:(BOOL)allowDestinationSubdomains;
519
520 // Removes all white list entries created with _addOriginAccessWhitelistEntryWithSourceOrigin.
521 + (void)_resetOriginAccessWhitelists;
522
523 // 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.
524 + (void)_addUserScriptToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist injectionTime:(WebUserScriptInjectionTime)injectionTime;
525 + (void)_addUserStyleSheetToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist;
526
527 + (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;
528 + (void)_addUserStyleSheetToGroup:(NSString *)groupName world:(WebScriptWorld *)world source:(NSString *)source url:(NSURL *)url whitelist:(NSArray *)whitelist blacklist:(NSArray *)blacklist injectedFrames:(WebUserContentInjectedFrames)injectedFrames;
529 + (void)_removeUserScriptFromGroup:(NSString *)groupName world:(WebScriptWorld *)world url:(NSURL *)url;
530 + (void)_removeUserStyleSheetFromGroup:(NSString *)groupName world:(WebScriptWorld *)world url:(NSURL *)url;
531 + (void)_removeUserScriptsFromGroup:(NSString *)groupName world:(WebScriptWorld *)world;
532 + (void)_removeUserStyleSheetsFromGroup:(NSString *)groupName world:(WebScriptWorld *)world;
533 + (void)_removeAllUserContentFromGroup:(NSString *)groupName;
534
535 // SPI for DumpRenderTree
536 + (void)_setLoadResourcesSerially:(BOOL)serialize;
537
538 /*!
539     @method cssAnimationsSuspended
540     @abstract Returns whether or not CSS Animations are suspended.
541     @result YES if CSS Animations are suspended.
542 */
543 - (BOOL)cssAnimationsSuspended;
544
545 /*!
546     @method setCSSAnimationsSuspended
547     @param paused YES to suspend animations, NO to resume animations.
548     @discussion Suspends or resumes all running animations and transitions in the page.
549 */
550 - (void)setCSSAnimationsSuspended:(BOOL)suspended;
551
552 + (void)_setDomainRelaxationForbidden:(BOOL)forbidden forURLScheme:(NSString *)scheme;
553 + (void)_registerURLSchemeAsSecure:(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 // Deprecated. Use the methods in pending public above instead.
565 - (WebNSUInteger)markAllMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight limit:(WebNSUInteger)limit;
566 - (WebNSUInteger)countMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight limit:(WebNSUInteger)limit markMatches:(BOOL)markMatches;
567
568 /*!
569  @method searchFor:direction:caseSensitive:wrap:startInSelection:
570  @abstract Searches a document view for a string and highlights the string if it is found.
571  Starts the search from the current selection.  Will search across all frames.
572  @param string The string to search for.
573  @param forward YES to search forward, NO to seach backwards.
574  @param caseFlag YES to for case-sensitive search, NO for case-insensitive search.
575  @param wrapFlag YES to wrap around, NO to avoid wrapping.
576  @param startInSelection YES to begin search in the selected text (useful for incremental searching), NO to begin search after the selected text.
577  @result YES if found, NO if not found.
578  */
579 // Deprecated. Use findString.
580 - (BOOL)searchFor:(NSString *)string direction:(BOOL)forward caseSensitive:(BOOL)caseFlag wrap:(BOOL)wrapFlag startInSelection:(BOOL)startInSelection;
581
582 /*!
583     @method defaultMinimumTimerInterval
584     @discussion Should consider moving this to the public API.
585     @result Returns the default minimum timer interval.
586 */
587 + (double)_defaultMinimumTimerInterval;
588
589 /*!
590     @method setMinimumTimerInterval:
591     @discussion Sets the minimum interval for DOMTimers in this WebView. This method is
592     exposed here in the Mac port rather than through WebPreferences (which generally
593     governs Settings) because this value is something adjusted at run time, not set
594     globally via "defaults write". Should consider adding this to the public API.
595     @param intervalInSeconds The new minimum timer interval, in seconds.
596 */
597 - (void)_setMinimumTimerInterval:(double)intervalInSeconds;
598
599 /*!
600     @method _HTTPPipeliningEnabled
601     @abstract Checks the HTTP pipelining status.
602     @discussion Defaults to NO.
603     @result YES if HTTP pipelining is enabled, NO if not enabled.
604  */
605 + (BOOL)_HTTPPipeliningEnabled;
606
607 /*!
608     @method _setHTTPPipeliningEnabled:
609     @abstract Set the HTTP pipelining status.
610     @discussion Defaults to NO.
611     @param enabled The new HTTP pipelining status.
612  */
613 + (void)_setHTTPPipeliningEnabled:(BOOL)enabled;
614
615 @end
616
617 @interface WebView (WebViewPrintingPrivate)
618 /*!
619     @method _adjustPrintingMarginsForHeaderAndFooter:
620     @abstract Increase the top and bottom margins for the current print operation to
621     account for the header and footer height. 
622     @discussion Called by <WebDocument> implementors once when a print job begins. If the
623     <WebDocument> implementor implements knowsPageRange:, this should be called from there.
624     Otherwise this should be called from beginDocument. The <WebDocument> implementors need
625     to also call _drawHeaderAndFooter.
626 */
627 - (void)_adjustPrintingMarginsForHeaderAndFooter;
628
629 /*!
630     @method _drawHeaderAndFooter
631     @abstract Gives the WebView's UIDelegate a chance to draw a header and footer on the
632     printed page. 
633     @discussion This should be called by <WebDocument> implementors from an override of
634     drawPageBorderWithSize:.
635 */
636 - (void)_drawHeaderAndFooter;
637 @end
638
639 @interface WebView (WebViewGrammarChecking)
640
641 // FIXME: These two methods should be merged into WebViewEditing when we're not in API freeze
642 - (BOOL)isGrammarCheckingEnabled;
643 - (void)setGrammarCheckingEnabled:(BOOL)flag;
644
645 // FIXME: This method should be merged into WebIBActions when we're not in API freeze
646 - (void)toggleGrammarChecking:(id)sender;
647
648 @end
649
650 @interface WebView (WebViewTextChecking)
651
652 - (BOOL)isAutomaticQuoteSubstitutionEnabled;
653 - (BOOL)isAutomaticLinkDetectionEnabled;
654 - (BOOL)isAutomaticDashSubstitutionEnabled;
655 - (BOOL)isAutomaticTextReplacementEnabled;
656 - (BOOL)isAutomaticSpellingCorrectionEnabled;
657 #ifndef BUILDING_ON_LEOPARD
658 - (void)setAutomaticQuoteSubstitutionEnabled:(BOOL)flag;
659 - (void)toggleAutomaticQuoteSubstitution:(id)sender;
660 - (void)setAutomaticLinkDetectionEnabled:(BOOL)flag;
661 - (void)toggleAutomaticLinkDetection:(id)sender;
662 - (void)setAutomaticDashSubstitutionEnabled:(BOOL)flag;
663 - (void)toggleAutomaticDashSubstitution:(id)sender;
664 - (void)setAutomaticTextReplacementEnabled:(BOOL)flag;
665 - (void)toggleAutomaticTextReplacement:(id)sender;
666 - (void)setAutomaticSpellingCorrectionEnabled:(BOOL)flag;
667 - (void)toggleAutomaticSpellingCorrection:(id)sender;
668 #endif
669 #if !defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD)
670 - (void)handleCorrectionPanelResult:(NSString*)result;
671 #endif
672 @end
673
674 @interface WebView (WebViewEditingInMail)
675 - (void)_insertNewlineInQuotedContent;
676 - (void)_replaceSelectionWithNode:(DOMNode *)node matchStyle:(BOOL)matchStyle;
677 - (BOOL)_selectionIsCaret;
678 - (BOOL)_selectionIsAll;
679 @end
680
681 @interface WebView (WebViewDeviceOrientation)
682 - (void)_setDeviceOrientationProvider:(id<WebDeviceOrientationProvider>)deviceOrientationProvider;
683 - (id<WebDeviceOrientationProvider>)_deviceOrientationProvider;
684 @end
685
686 @protocol WebGeolocationProvider <NSObject>
687 - (void)registerWebView:(WebView *)webView;
688 - (void)unregisterWebView:(WebView *)webView;
689 - (WebGeolocationPosition *)lastPosition;
690 @end
691
692 @interface WebView (WebViewGeolocation)
693 - (void)_setGeolocationProvider:(id<WebGeolocationProvider>)locationProvider;
694 - (id<WebGeolocationProvider>)_geolocationProvider;
695
696 - (void)_geolocationDidChangePosition:(WebGeolocationPosition *)position;
697 - (void)_geolocationDidFailWithError:(NSError *)error;
698 @end
699
700 @interface WebView (WebViewPrivateStyleInfo)
701 - (JSValueRef)_computedStyleIncludingVisitedInfo:(JSContextRef)context forElement:(JSValueRef)value;
702 @end
703
704 @interface WebView (WebViewPrivateNodesFromRect)
705 - (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;
706 @end
707
708 @interface NSObject (WebFrameLoadDelegatePrivate)
709 - (void)webView:(WebView *)sender didFirstLayoutInFrame:(WebFrame *)frame;
710
711 // didFinishDocumentLoadForFrame is sent when the document has finished loading, though not necessarily all
712 // of its subresources.
713 // FIXME 5259339: Currently this callback is not sent for (some?) pages loaded entirely from the cache.
714 - (void)webView:(WebView *)sender didFinishDocumentLoadForFrame:(WebFrame *)frame;
715
716 // Addresses 4192534.  SPI for now.
717 - (void)webView:(WebView *)sender didHandleOnloadEventsForFrame:(WebFrame *)frame;
718
719 - (void)webView:(WebView *)sender didFirstVisuallyNonEmptyLayoutInFrame:(WebFrame *)frame;
720
721 // For implementing the WebInspector's test harness
722 - (void)webView:(WebView *)webView didClearInspectorWindowObject:(WebScriptObject *)windowObject forFrame:(WebFrame *)frame;
723
724 @end
725
726 @interface NSObject (WebResourceLoadDelegatePrivate)
727 // Addresses <rdar://problem/5008925> - SPI for now
728 - (NSCachedURLResponse *)webView:(WebView *)sender resource:(id)identifier willCacheResponse:(NSCachedURLResponse *)response fromDataSource:(WebDataSource *)dataSource;
729 @end
730
731 #ifdef __cplusplus
732 extern "C" {
733 #endif
734
735 // This is a C function to avoid calling +[WebView initialize].
736 void WebInstallMemoryPressureHandler(void);
737
738 #ifdef __cplusplus
739 }
740 #endif
741
742 #undef WebNSInteger
743 #undef WebNSUInteger