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