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