Reviewed by Geoff.
[WebKit-https.git] / WebKit / WebView / WebViewPrivate.h
1 /*
2  * Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import <WebKit/WebView.h>
30 #import <WebKit/WebFramePrivate.h>
31
32 @class NSError;
33 @class WebFrame;
34 @class WebPreferences;
35 @class WebCoreSettings;
36
37 @protocol WebFormDelegate;
38
39 typedef struct _WebResourceDelegateImplementationCache {
40     uint delegateImplementsDidCancelAuthenticationChallenge:1;
41     uint delegateImplementsDidReceiveAuthenticationChallenge:1;
42     uint delegateImplementsDidReceiveResponse:1;
43     uint delegateImplementsDidReceiveContentLength:1;
44     uint delegateImplementsDidFinishLoadingFromDataSource:1;
45     uint delegateImplementsWillSendRequest:1;
46     uint delegateImplementsIdentifierForRequest:1;
47 } WebResourceDelegateImplementationCache;
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 extern NSString *WebElementTitleKey;   // NSString of the title of the element (pending public, used by Safari)
59
60 typedef enum {
61     WebDashboardBehaviorAlwaysSendMouseEventsToAllWindows,
62     WebDashboardBehaviorAlwaysSendActiveNullEventsToPlugIns,
63     WebDashboardBehaviorAlwaysAcceptsFirstMouse,
64     WebDashboardBehaviorAllowWheelScrolling
65 } WebDashboardBehavior;
66
67 @interface WebController : NSTreeController {
68     IBOutlet WebView *webView;
69 }
70 - (WebView *)webView;
71 - (void)setWebView:(WebView *)newWebView;
72 @end
73
74 @interface WebView (WebPendingPublic)
75
76 - (void)setMainFrameURL:(NSString *)URLString;
77 - (NSString *)mainFrameURL;
78 - (BOOL)isLoading;
79 - (NSString *)mainFrameTitle;
80 - (NSImage *)mainFrameIcon;
81
82 - (void)setMainFrameDocumentReady:(BOOL)mainFrameDocumentReady;
83 - (DOMDocument *)mainFrameDocument;
84
85 - (void)setDrawsBackground:(BOOL)drawsBackround;
86 - (BOOL)drawsBackground;
87
88 - (IBAction)toggleContinuousSpellChecking:(id)sender;
89
90 - (IBAction)toggleSmartInsertDelete:(id)sender;
91
92 - (BOOL)canMakeTextStandardSize;
93 - (IBAction)makeTextStandardSize:(id)sender;
94
95 // If true, the selection will be maintained even when the first responder is outside
96 // of the webview. Returns true only if self is editable at this level. Subclasses can
97 // override to enforce additional criteria.
98 - (BOOL)maintainsInactiveSelection;
99
100 // Returns the frame that contains the first responder, if any. Otherwise returns the
101 // frame that contains a non-zero-length selection, if any. Returns nil if no frame
102 // meets these criteria.
103 - (WebFrame *)selectedFrame;
104
105 /*!
106 @method setScriptDebugDelegate:
107 @abstract Set the WebView's WebScriptDebugDelegate delegate.
108 @param delegate The WebScriptDebugDelegate to set as the delegate.
109 */    
110 - (void)setScriptDebugDelegate:(id)delegate;
111
112 /*!
113 @method scriptDebugDelegate
114 @abstract Return the WebView's WebScriptDebugDelegate.
115 @result The WebView's WebScriptDebugDelegate.
116 */    
117 - (id)scriptDebugDelegate;
118
119 - (BOOL)shouldClose;
120
121 /*!
122     @method aeDescByEvaluatingJavaScriptFromString:
123     @param script The text of the JavaScript.
124     @result The result of the script, converted to an NSAppleEventDescriptor, or nil for failure.
125 */
126 - (NSAppleEventDescriptor *)aeDescByEvaluatingJavaScriptFromString:(NSString *)script;
127
128 // Support for displaying multiple text matches.
129 // These methods might end up moving into a protocol, so different document types can specify
130 // whether or not they implement the protocol. For now we'll just deal with HTML.
131 // These methods are still in flux; don't rely on them yet.
132 - (unsigned)markAllMatchesForText:(NSString *)string caseSensitive:(BOOL)caseFlag highlight:(BOOL)highlight;
133 - (void)unmarkAllTextMatches;
134 - (NSArray *)rectsForTextMatches;
135
136 @end
137
138 @interface WebView (WebViewEditingPendingPublic)
139
140 - (IBAction)moveToBeginningOfSentence:(id)sender;
141 - (IBAction)moveToBeginningOfSentenceAndModifySelection:(id)sender;
142 - (IBAction)moveToEndOfSentence:(id)sender;
143 - (IBAction)moveToEndOfSentenceAndModifySelection:(id)sender;
144 - (IBAction)selectSentence:(id)sender;
145
146 @end
147
148 @interface WebView (WebPrivate)
149
150 + (BOOL)_developerExtrasEnabled;
151 + (BOOL)_scriptDebuggerEnabled;
152
153 /*!
154 Could be worth adding to the API.
155  @method loadItemsFromOtherView:
156  @abstract Loads the view with the contents of the other view, including its backforward list.
157  @param otherView   The WebView from which to copy contents.
158  */
159 - (void)_loadBackForwardListFromOtherView:(WebView *)otherView;
160
161 + (NSArray *)_supportedFileExtensions;
162
163 /*!
164     @method canShowFile:
165     @abstract Checks if the WebKit can show the content of the file at the specified path.
166     @param path The path of the file to check
167     @result YES if the WebKit can show the content of the file at the specified path.
168 */
169 + (BOOL)canShowFile:(NSString *)path;
170
171 /*!
172     @method suggestedFileExtensionForMIMEType:
173     @param MIMEType The MIME type to check.
174     @result The extension based on the MIME type
175 */
176 + (NSString *)suggestedFileExtensionForMIMEType: (NSString *)MIMEType;
177
178
179 // May well become public
180 - (void)_setFormDelegate:(id<WebFormDelegate>)delegate;
181 - (id<WebFormDelegate>)_formDelegate;
182
183 - (void)_close;
184
185 /*!
186     @method _registerViewClass:representationClass:forURLScheme:
187     @discussion Register classes that implement WebDocumentView and WebDocumentRepresentation respectively.
188     @param viewClass The WebDocumentView class to use to render data for a given MIME type.
189     @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
190     @param scheme The URL scheme to represent with an object of the given class.
191 */
192 + (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
193
194 + (void)_unregisterViewClassAndRepresentationClassForMIMEType:(NSString *)MIMEType;
195
196 /*!
197      @method _canHandleRequest:
198      @abstract Performs a "preflight" operation that performs some
199      speculative checks to see if a request can be used to create
200      a WebDocumentView and WebDocumentRepresentation.
201      @discussion The result of this method is valid only as long as no
202      protocols or schemes are registered or unregistered, and as long as
203      the request is not mutated (if the request is mutable). Hence, clients
204      should be prepared to handle failures even if they have performed request
205      preflighting by caling this method.
206      @param request The request to preflight.
207      @result YES if it is likely that a WebDocumentView and WebDocumentRepresentation
208      can be created for the request, NO otherwise.
209 */
210 + (BOOL)_canHandleRequest:(NSURLRequest *)request;
211
212 + (NSString *)_decodeData:(NSData *)data;
213
214 + (void)_setAlwaysUseATSU:(BOOL)f;
215
216 - (NSCachedURLResponse *)_cachedResponseForURL:(NSURL *)URL;
217
218 - (void)_addScrollerDashboardRegions:(NSMutableDictionary *)regions;
219 - (NSDictionary *)_dashboardRegions;
220
221 - (void)_setDashboardBehavior:(WebDashboardBehavior)behavior to:(BOOL)flag;
222 - (BOOL)_dashboardBehavior:(WebDashboardBehavior)behavior;
223
224 + (void)_setShouldUseFontSmoothing:(BOOL)f;
225 + (BOOL)_shouldUseFontSmoothing;
226
227 + (NSString *)_minimumRequiredSafariBuildNumber;
228
229 /*!
230     @method setAlwaysShowVerticalScroller:
231     @result Forces the vertical scroller to be visible if flag is YES, otherwise
232     if flag is NO the scroller with automatically show and hide as needed.
233  */
234 - (void)setAlwaysShowVerticalScroller:(BOOL)flag;
235
236 /*!
237     @method alwaysShowVerticalScroller
238     @result YES if the vertical scroller is always shown
239  */
240 - (BOOL)alwaysShowVerticalScroller;
241
242 /*!
243     @method setAlwaysShowHorizontalScroller:
244     @result Forces the horizontal scroller to be visible if flag is YES, otherwise
245     if flag is NO the scroller with automatically show and hide as needed.
246  */
247 - (void)setAlwaysShowHorizontalScroller:(BOOL)flag;
248
249 /*!
250     @method alwaysShowHorizontalScroller
251     @result YES if the horizontal scroller is always shown
252  */
253 - (BOOL)alwaysShowHorizontalScroller;
254
255 /*!
256     @method _setAdditionalWebPlugInPaths:
257     @abstract Sets additional plugin search paths for a specific WebView.
258  */
259 - (void)_setAdditionalWebPlugInPaths:(NSArray *)newPaths;
260
261 /*!
262     @method _attachScriptDebuggerToAllFrames
263     @abstract Attaches a script debugger to all frames belonging to the receiver.
264  */
265 - (void)_attachScriptDebuggerToAllFrames;
266
267 /*!
268     @method _detachScriptDebuggerFromAllFrames
269     @abstract Detaches any script debuggers from all frames belonging to the receiver.
270  */
271 - (void)_detachScriptDebuggerFromAllFrames;
272
273 @end
274
275 @interface WebView (WebViewPrintingPrivate)
276 /*!
277     @method _adjustPrintingMarginsForHeaderAndFooter:
278     @abstract Increase the top and bottom margins for the current print operation to
279     account for the header and footer height. 
280     @discussion Called by <WebDocument> implementors once when a print job begins. If the
281     <WebDocument> implementor implements knowsPageRange:, this should be called from there.
282     Otherwise this should be called from beginDocument. The <WebDocument> implementors need
283     to also call _drawHeaderAndFooter.
284 */
285 - (void)_adjustPrintingMarginsForHeaderAndFooter;
286
287 /*!
288     @method _drawHeaderAndFooter
289     @abstract Gives the WebView's UIDelegate a chance to draw a header and footer on the
290     printed page. 
291     @discussion This should be called by <WebDocument> implementors from an override of
292     drawPageBorderWithSize:.
293 */
294 - (void)_drawHeaderAndFooter;
295 @end
296
297 @interface WebView (WebViewEditingInMail)
298 - (void)_insertNewlineInQuotedContent;
299 - (BOOL)_selectWordBeforeMenuEvent;
300 - (void)_setSelectWordBeforeMenuEvent:(BOOL)flag;
301 @end
302
303 @interface _WebSafeForwarder : NSObject
304 {
305     id target; // Non-retained. Don't retain delegates.
306     id defaultTarget;
307     Class templateClass;
308 }
309 - (id)initWithTarget:(id)t defaultTarget:(id)dt templateClass:(Class)aClass;
310 + (id)safeForwarderWithTarget:(id)t defaultTarget:(id)dt templateClass:(Class)aClass;
311 @end
312
313 @interface NSObject (WebFrameLoadDelegatePrivate)
314 - (void)webView:(WebView *)sender didFirstLayoutInFrame:(WebFrame *)frame;
315 // Addresses 4192534.  Private API for now.
316 - (void)webView:(WebView *)sender didHandleOnloadEventsForFrame:(WebFrame *)frame;
317 @end