WebKit:
[WebKit-https.git] / WebKit / WebView.subproj / WebViewPrivate.h
1 /*      
2     WebViewPrivate.m
3     Copyright 2001, Apple, Inc. All rights reserved.
4 */
5
6 #import <WebKit/WebView.h>
7 #import <WebKit/WebFramePrivate.h>
8
9 @class NSError;
10 @class WebFrame;
11 @class WebPreferences;
12 @class WebCoreSettings;
13
14 @protocol WebFormDelegate;
15
16 typedef struct _WebResourceDelegateImplementationCache {
17     uint delegateImplementsDidCancelAuthenticationChallenge:1;
18     uint delegateImplementsDidReceiveAuthenticationChallenge:1;
19     uint delegateImplementsDidReceiveResponse:1;
20     uint delegateImplementsDidReceiveContentLength:1;
21     uint delegateImplementsDidFinishLoadingFromDataSource:1;
22     uint delegateImplementsWillSendRequest:1;
23     uint delegateImplementsIdentifierForRequest:1;
24 } WebResourceDelegateImplementationCache;
25
26 extern NSString *_WebCanGoBackKey;
27 extern NSString *_WebCanGoForwardKey;
28 extern NSString *_WebEstimatedProgressKey;
29 extern NSString *_WebIsLoadingKey;
30 extern NSString *_WebMainFrameIconKey;
31 extern NSString *_WebMainFrameTitleKey;
32 extern NSString *_WebMainFrameURLKey;
33
34 typedef enum {
35         WebDashboardBehaviorAlwaysSendMouseEventsToAllWindows,
36         WebDashboardBehaviorAlwaysSendActiveNullEventsToPlugIns
37 } WebDashboardBehavior;
38
39
40 @interface WebView (WebPendingPublic)
41
42 - (void)setMainFrameURL:(NSString *)URLString;
43 - (NSString *)mainFrameURL;
44 - (BOOL)isLoading;
45 - (NSString *)mainFrameTitle;
46 - (NSImage *)mainFrameIcon;
47
48 - (void)setDrawsBackground:(BOOL)drawsBackround;
49 - (BOOL)drawsBackground;
50
51 - (IBAction)toggleContinuousSpellChecking:(id)sender;
52
53 - (BOOL)isContinuousGrammarCheckingEnabled;
54 - (void)setContinuousGrammarCheckingEnabled:(BOOL)flag;
55 - (void)toggleContinuousGrammarChecking:(id)sender;
56
57 - (void)toggleSmartInsertDelete:(id)sender;
58
59 @end
60
61 @interface WebView (WebPrivate)
62
63 + (BOOL)_viewClass:(Class *)vClass andRepresentationClass:(Class *)rClass forMIMEType:(NSString *)MIMEType;
64
65 + (NSArray *)_supportedFileExtensions;
66
67 /*!
68     @method canShowFile:
69     @abstract Checks if the WebKit can show the content of the file at the specified path.
70     @param path The path of the file to check
71     @result YES if the WebKit can show the content of the file at the specified path.
72 */
73 + (BOOL)canShowFile:(NSString *)path;
74
75 /*!
76     @method suggestedFileExtensionForMIMEType:
77     @param MIMEType The MIME type to check.
78     @result The extension based on the MIME type
79 */
80 + (NSString *)suggestedFileExtensionForMIMEType: (NSString *)MIMEType;
81
82 /*!
83     @method frameForDataSource:
84     @abstract Return the frame associated with the data source.
85     @discussion Traverses the frame tree to find the frame associated
86     with a datasource.
87     @param datasource The datasource to  match against each frame.
88     @result The frame that has the associated datasource.
89 */
90 - (WebFrame *)_frameForDataSource: (WebDataSource *)dataSource;
91
92     /*!
93             @method frameForView:
94      @abstract Return the frame associated with the view.
95      @discussion Traverses the frame tree to find the view.
96      @param aView The view to match against each frame.
97      @result The frame that has the associated view.
98      */
99 - (WebFrame *)_frameForView: (WebFrameView *)aView;
100
101 - (WebFrame *)_createFrameNamed:(NSString *)name inParent:(WebFrame *)parent allowsScrolling:(BOOL)allowsScrolling;
102
103 - (void)_finishedLoadingResourceFromDataSource:(WebDataSource *)dataSource;
104 - (void)_receivedError:(NSError *)error fromDataSource:(WebDataSource *)dataSource;
105 - (void)_mainReceivedBytesSoFar:(unsigned)bytesSoFar fromDataSource:(WebDataSource *)dataSource complete:(BOOL)isComplete;
106 - (void)_mainReceivedError:(NSError *)error fromDataSource:(WebDataSource *)dataSource complete:(BOOL)isComplete;
107 + (NSString *)_MIMETypeForFile:(NSString *)path;
108 - (void)_downloadURL:(NSURL *)URL;
109 - (void)_downloadURL:(NSURL *)URL toDirectory:(NSString *)directoryPath;
110
111 - (BOOL)defersCallbacks;
112 - (void)setDefersCallbacks:(BOOL)defers;
113
114 - (void)_setTopLevelFrameName:(NSString *)name;
115 - (WebFrame *)_findFrameInThisWindowNamed: (NSString *)name;
116 - (WebFrame *)_findFrameNamed: (NSString *)name;
117
118 - (WebView *)_openNewWindowWithRequest:(NSURLRequest *)request;
119
120 - (NSMenu *)_menuForElement:(NSDictionary *)element;
121
122 - (void)_mouseDidMoveOverElement:(NSDictionary *)dictionary modifierFlags:(unsigned)modifierFlags;
123
124 /*!
125 Could be worth adding to the API.
126     @method loadItem:
127     @abstract Loads the view with the contents described by the item, including frame content
128         described by child items.
129     @param item   The item to load.  It is not retained, but a copy will appear in the
130         BackForwardList on this WebView.
131 */
132 - (void)_loadItem:(WebHistoryItem *)item;
133 /*!
134 Could be worth adding to the API.
135     @method loadItemsFromOtherView:
136     @abstract Loads the view with the contents of the other view, including its backforward list.
137     @param otherView   The WebView from which to copy contents.
138 */
139 - (void)_loadBackForwardListFromOtherView:(WebView *)otherView;
140
141 - (void)_goToItem:(WebHistoryItem *)item withLoadType:(WebFrameLoadType)type;
142
143 // May well become public
144 - (void)_setFormDelegate:(id<WebFormDelegate>)delegate;
145 - (id<WebFormDelegate>)_formDelegate;
146
147 - (WebCoreSettings *)_settings;
148 - (void)_updateWebCoreSettingsFromPreferences:(WebPreferences *)prefs;
149
150 - (id)_frameLoadDelegateForwarder;
151 - (id)_resourceLoadDelegateForwarder;
152 - (void)_cacheResourceLoadDelegateImplementations;
153 - (WebResourceDelegateImplementationCache)_resourceLoadDelegateImplementations;
154 - (id)_policyDelegateForwarder;
155 - (id)_UIDelegateForwarder;
156 - (id)_editingDelegateForwarder;
157
158 - (void)_closeWindow;
159
160 - (void)_setInitiatedDrag:(BOOL)initiatedDrag;
161
162 - (void)_close;
163
164 /*!
165     @method _registerViewClass:representationClass:forURLScheme:
166     @discussion Register classes that implement WebDocumentView and WebDocumentRepresentation respectively.
167     @param viewClass The WebDocumentView class to use to render data for a given MIME type.
168     @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
169     @param scheme The URL scheme to represent with an object of the given class.
170 */
171 + (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
172
173 + (void)_unregisterViewClassAndRepresentationClassForMIMEType:(NSString *)MIMEType;
174
175 + (NSString *)_generatedMIMETypeForURLScheme:(NSString *)URLScheme;
176 + (BOOL)_representationExistsForURLScheme:(NSString *)URLScheme;
177 /*!
178      @method _canHandleRequest:
179      @abstract Performs a "preflight" operation that performs some
180      speculative checks to see if a request can be used to create
181      a WebDocumentView and WebDocumentRepresentation.
182      @discussion The result of this method is valid only as long as no
183      protocols or schemes are registered or unregistered, and as long as
184      the request is not mutated (if the request is mutable). Hence, clients
185      should be prepared to handle failures even if they have performed request
186      preflighting by caling this method.
187      @param request The request to preflight.
188      @result YES if it is likely that a WebDocumentView and WebDocumentRepresentation
189      can be created for the request, NO otherwise.
190 */
191 + (BOOL)_canHandleRequest:(NSURLRequest *)request;
192
193 + (NSString *)_decodeData:(NSData *)data;
194
195 - (void)_pushPerformingProgrammaticFocus;
196 - (void)_popPerformingProgrammaticFocus;
197 - (BOOL)_isPerformingProgrammaticFocus;
198
199 // Methods dealing with the estimated progress completion.
200 - (void)_progressStarted:(WebFrame *)frame;
201 - (void)_progressCompleted:(WebFrame *)frame;
202 - (void)_incrementProgressForConnectionDelegate:(id)connectionDelegate response:(NSURLResponse *)response;
203 - (void)_incrementProgressForConnectionDelegate:(id)connectionDelegate data:(NSData *)dataSource;
204 - (void)_completeProgressForConnectionDelegate:(id)connectionDelegate;
205
206 - (void)_didStartProvisionalLoadForFrame:(WebFrame *)frame;
207 - (void)_didCommitLoadForFrame:(WebFrame *)frame;
208 - (void)_didFinishLoadForFrame:(WebFrame *)frame;
209 - (void)_didFailLoadWithError:(NSError *)error forFrame:(WebFrame *)frame;
210 - (void)_didFailProvisionalLoadWithError:(NSError *)error forFrame:(WebFrame *)frame;
211
212 - (void)_willChangeValueForKey:(NSString *)key;
213 - (void)_didChangeValueForKey:(NSString *)key;
214
215 - (void)_reloadForPluginChanges;
216 + (void)_setAlwaysUseATSU:(BOOL)f;
217
218 - (NSCachedURLResponse *)_cachedResponseForURL:(NSURL *)URL;
219
220 - (void)_writeImageElement:(NSDictionary *)element withPasteboardTypes:(NSArray *)types toPasteboard:(NSPasteboard *)pasteboard;
221 - (void)_writeLinkElement:(NSDictionary *)element withPasteboardTypes:(NSArray *)types toPasteboard:(NSPasteboard *)pasteboard;
222
223 - (void)_addScrollerDashboardRegions:(NSMutableDictionary *)regions;
224 - (NSDictionary *)_dashboardRegions;
225
226 - (void)_setDashboardBehavior:(WebDashboardBehavior)behavior to:(BOOL)flag;
227 - (BOOL)_dashboardBehavior:(WebDashboardBehavior)behavior;
228
229
230 @end
231
232 @interface WebView (WebViewPrintingPrivate)
233 /*!
234     @method _adjustPrintingMarginsForHeaderAndFooter:
235     @abstract Increase the top and bottom margins for the current print operation to
236     account for the header and footer height. 
237     @discussion Called by <WebDocument> implementors once when a print job begins. If the
238     <WebDocument> implementor implements knowsPageRange:, this should be called from there.
239     Otherwise this should be called from beginDocument. The <WebDocument> implementors need
240     to also call _drawHeaderAndFooter.
241 */
242 - (void)_adjustPrintingMarginsForHeaderAndFooter;
243
244 /*!
245     @method _drawHeaderAndFooter
246     @abstract Gives the WebView's UIDelegate a chance to draw a header and footer on the
247     printed page. 
248     @discussion This should be called by <WebDocument> implementors from an override of
249     drawPageBorderWithSize:.
250 */
251 - (void)_drawHeaderAndFooter;
252 @end
253
254 @interface _WebSafeForwarder : NSObject
255 {
256     id target;  // Non-retained.  Don't retain delegates;
257     id defaultTarget;
258     Class templateClass;
259 }
260 - (id)initWithTarget:(id)t defaultTarget:(id)dt templateClass:(Class)aClass;
261 + (id)safeForwarderWithTarget:(id)t defaultTarget:(id)dt templateClass:(Class)aClass;
262 @end
263
264 @interface NSObject (WebFrameLoadDelegatePrivate)
265 - (void)webView:(WebView *)sender didFirstLayoutInFrame:(WebFrame *)frame;
266 @end