<http://webkit.org/b/59838> Implement HTTP pipelining for CoreFoundation-based networking
[WebKit-https.git] / Source / WebKit / win / Interfaces / IWebViewPrivate.idl
1 /*
2  * Copyright (C) 2006, 2007, 2008 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef DO_NO_IMPORTS
27 import "oaidl.idl";
28 import "ocidl.idl";
29 import "IWebFormDelegate.idl";
30 import "IWebFrameLoadDelegatePrivate.idl";
31 import "IWebHistoryDelegate.idl";
32 import "IWebInspector.idl";
33 import "IWebInspectorPrivate.idl";
34 #endif
35
36 // Sent when IWebView::close is called. No userInfo is associated with this notification.
37 cpp_quote("#define WebViewWillCloseNotification L\"WebViewWillCloseNotification\"")
38
39 interface IEnumTextMatches;
40 interface IWebFormDelegate;
41 interface IWebFrameLoadDelegatePrivate;
42 interface IWebHistoryDelegate;
43 interface IWebInspector;
44 interface IWebInspectorPrivate;
45 interface IWebPluginHalterDelegate;
46 interface IWebURLRequest;
47 interface IWebView;
48
49 typedef enum {
50     WebInjectAtDocumentStart = 0,
51     WebInjectAtDocumentEnd,
52 } WebUserScriptInjectionTime;
53
54 [
55     object,
56     oleautomation,
57     uuid(44914369-DEB5-4fcf-A6A3-30C02E73154F),
58     pointer_default(unique)
59 ]
60 interface IWebViewPrivate : IUnknown
61 {
62     /*!
63         @method _setInViewSourceMode:
64         @abstract Used to place a WebView into a special source-viewing mode.
65         - (void)_setInViewSourceMode:(BOOL)flag;
66       */
67     HRESULT setInViewSourceMode([in] BOOL flag);
68
69     /*!
70         @method _inViewSourceMode;
71         @abstract Whether or not the WebView is in source-view mode for HTML.
72         - (BOOL)_inViewSourceMode;
73       */
74     HRESULT inViewSourceMode([out, retval] BOOL* flag);
75
76     HRESULT viewWindow([out, retval] OLE_HANDLE* window);
77
78     // May well become public
79     //- (void)_setFormDelegate:(id<WebFormDelegate>)delegate;
80     HRESULT setFormDelegate([in] IWebFormDelegate* formDelegate);
81
82     //- (id<WebFormDelegate>)_formDelegate;
83     HRESULT formDelegate([out, retval] IWebFormDelegate** formDelegate);
84
85     HRESULT setFrameLoadDelegatePrivate([in] IWebFrameLoadDelegatePrivate* frameLoadDelegatePrivate);
86     HRESULT frameLoadDelegatePrivate([out, retval] IWebFrameLoadDelegatePrivate** frameLoadDelegatePrivate);
87
88     HRESULT scrollOffset([out, retval] LPPOINT offset);
89     HRESULT scrollBy([in] LPPOINT offset);
90     HRESULT visibleContentRect([out, retval] LPRECT rect);
91     
92     // SPI for DumpRenderTree
93     HRESULT updateFocusedAndActiveState();
94
95     // Support for displaying multiple text matches.
96     HRESULT markAllMatchesForText([in] BSTR search, [in] BOOL caseSensitive, [in] BOOL highlight, [in] UINT limit, [out] UINT* matches);
97     HRESULT unmarkAllTextMatches();
98     HRESULT rectsForTextMatches([out]IEnumTextMatches** pmatches);
99     HRESULT selectionRect([in, out] RECT* rc);
100     HRESULT generateSelectionImage(BOOL forceWhiteText, [out, retval] OLE_HANDLE* hBitmap);
101
102     HRESULT canHandleRequest([in] IWebURLRequest* request, [out, retval] BOOL* result);
103
104     HRESULT clearFocusNode();
105
106     HRESULT setTabKeyCyclesThroughElements([in] BOOL cycles);
107     HRESULT tabKeyCyclesThroughElements([out, retval] BOOL* result);
108
109     HRESULT setAllowSiteSpecificHacks([in] BOOL allows);
110     HRESULT addAdditionalPluginDirectory([in] BSTR directory);
111
112     HRESULT loadBackForwardListFromOtherView([in] IWebView* otherView);
113
114     HRESULT setCustomDropTarget([in] IDropTarget* dt);
115     HRESULT removeCustomDropTarget();
116
117     HRESULT setInitialFocus([in] BOOL forward);
118
119     HRESULT inspector([out, retval] IWebInspector**);
120
121     HRESULT clearUndoRedoOperations();
122
123     HRESULT setProhibitsMainFrameScrolling([in] BOOL prohibits);
124
125     // SPI for DumpRenderTree. This is global to all WebViews.
126     HRESULT setShouldApplyMacFontAscentHack([in] BOOL shouldApply);
127
128     /*!
129         @method shouldClose:
130         @abstract This function will fire the before unload handler for a page.  
131         If the user cancels the closing of a webview from the alert popped up by the 
132         before unload handler, then this function will return false.
133     */
134     HRESULT shouldClose([out, retval] BOOL* result);
135
136     // SPI for DumpRenderTree
137     HRESULT executeCoreCommandByName([in] BSTR name, [in] BSTR value);
138
139     HRESULT windowAncestryDidChange();
140
141     HRESULT paintDocumentRectToContext([in] RECT rect, [in] OLE_HANDLE dc);
142
143     HRESULT setDefersCallbacks([in] BOOL defersCallbacks);
144     HRESULT defersCallbacks([out, retval] BOOL* defersCallbacks);
145
146     HRESULT standardUserAgentWithApplicationName([in] BSTR applicationName, [retval][out] BSTR* groupName);
147
148     HRESULT setCustomHTMLTokenizerTimeDelay([in] double timeDelay);
149     HRESULT setCustomHTMLTokenizerChunkSize([in] int chunkSize);
150
151     HRESULT backingStore([out, retval] OLE_HANDLE* hBitmap);
152
153     HRESULT setTransparent([in] BOOL transparent);
154     HRESULT transparent([out, retval] BOOL* transparent);
155
156     HRESULT setUsesLayeredWindow([in] BOOL usesLayeredWindow);
157     HRESULT usesLayeredWindow([out, retval] BOOL* usesLayeredWindow);
158
159     HRESULT setAlwaysUsesComplexTextCodePath([in] BOOL complex);
160     HRESULT alwaysUsesComplexTextCodePath([out, retval] BOOL* complex);
161
162     HRESULT setCookieEnabled([in] BOOL enable);
163     HRESULT cookieEnabled([out, retval] BOOL* enabled);
164
165     HRESULT setMediaVolume([in] float volume);
166     HRESULT mediaVolume([out, retval] float* volume);
167
168     // SPI for DumpRenderTree
169     HRESULT clearMainFrameName();
170
171     HRESULT globalHistoryItem([out, retval] IWebHistoryItem**);
172
173     HRESULT registerEmbeddedViewMIMEType([in] BSTR mimeType);
174
175     HRESULT setMemoryCacheDelegateCallsEnabled([in] BOOL enabled);
176
177     HRESULT setJavaScriptURLsAreAllowed([in] BOOL areAllowed);
178
179     HRESULT setCanStartPlugins([in] BOOL canStartPlugins);
180
181     /*!
182         @method MIMETypeForExtension:
183         @abstract Returns the mime type for a certian file extension.
184         @param path The extension of the file to check.
185         @result The mime type of the specified extension.
186         + (BSTR)MIMETypeForPath:(NSString *)path;
187     */
188     HRESULT MIMETypeForExtension([in] BSTR extension, [out, retval] BSTR* mimeType);
189
190     HRESULT addUserScriptToGroup([in] BSTR groupName, [in] IWebScriptWorld*, [in] BSTR source, [in] BSTR url,
191                                  [in] unsigned whitelistCount, [in, size_is(whitelistCount)] BSTR* whitelist,
192                                  [in] unsigned blacklistCount, [in, size_is(blacklistCount)] BSTR* blacklist,
193                                  [in] WebUserScriptInjectionTime injectionTime);
194     HRESULT addUserStyleSheetToGroup([in] BSTR groupName, [in] IWebScriptWorld*, [in] BSTR source, [in] BSTR url,
195                                      [in] unsigned whitelistCount, [in, size_is(whitelistCount)] BSTR* whitelist,
196                                      [in] unsigned blacklistCount, [in, size_is(blacklistCount)] BSTR* blacklist);
197     HRESULT removeUserScriptFromGroup([in] BSTR groupName, [in] IWebScriptWorld*, [in] BSTR url);
198     HRESULT removeUserStyleSheetFromGroup([in] BSTR groupName, [in] IWebScriptWorld*, [in] BSTR url);
199     HRESULT removeUserScriptsFromGroup([in] BSTR groupName, [in] IWebScriptWorld*);
200     HRESULT removeUserStyleSheetsFromGroup([in] BSTR groupName, [in] IWebScriptWorld*);
201     HRESULT removeAllUserContentFromGroup([in] BSTR groupName);
202
203     HRESULT setPluginHalterDelegate([in] IWebPluginHalterDelegate* d);
204     HRESULT pluginHalterDelegate([retval, out] IWebPluginHalterDelegate** d);
205
206     // If rect is 0, the entire backing store will be invalidated.
207     HRESULT invalidateBackingStore([in] const RECT* rect);
208
209     // Whitelists access from an origin (sourceOrigin) to a set of one or more origins described by the parameters:
210     // - destinationProtocol: The protocol to grant access to.
211     // - destinationHost: The host to grant access to.
212     // - allowDestinationSubdomains: If host is a domain, setting this to YES will whitelist host and all its subdomains, recursively.
213     HRESULT addOriginAccessWhitelistEntry([in] BSTR sourceOrigin, [in] BSTR destinationProtocol, [in] BSTR destinationHost, [in] BOOL allowDestinationSubdomains);
214
215     // Removes a white list entry created with addOriginAccessWhitelistEntry. See above.
216     HRESULT removeOriginAccessWhitelistEntry([in] BSTR sourceOrigin, [in] BSTR destinationProtocol, [in] BSTR destinationHost, [in] BOOL allowDestinationSubdomains);
217
218     // Removes all white list entries created with addOriginAccessWhitelistEntry.
219     HRESULT resetOriginAccessWhitelists();
220
221     HRESULT setHistoryDelegate([in] IWebHistoryDelegate* historyDelegate);
222     HRESULT historyDelegate([out,retval] IWebHistoryDelegate** historyDelegate);
223     HRESULT addVisitedLinks([in] BSTR* visitedURLs, [in] unsigned visitedURLCount);
224
225     HRESULT isNodeHaltedPlugin([in] IDOMNode*, [retval, out] BOOL*);
226     HRESULT restartHaltedPluginForNode([in] IDOMNode*);
227     HRESULT hasPluginForNodeBeenHalted([in] IDOMNode*, [retval, out] BOOL*);
228
229     HRESULT setGeolocationProvider([in] IWebGeolocationProvider* locationProvider);
230     HRESULT geolocationProvider([out, retval] IWebGeolocationProvider** locationProvider);
231     HRESULT geolocationDidChangePosition([in] IWebGeolocationPosition* position);
232     HRESULT geolocationDidFailWithError([in] IWebError* error);
233
234     HRESULT setDomainRelaxationForbiddenForURLScheme([in] BOOL forbidden, [in] BSTR scheme);
235
236     HRESULT registerURLSchemeAsSecure([in] BSTR scheme);
237
238     HRESULT nextDisplayIsSynchronous();
239
240     HRESULT paintScrollViewRectToContextAtPoint([in] RECT rect, [in] POINT pt, [in] OLE_HANDLE dc);
241
242     [local] HRESULT reportException([in] JSContextRef context, [in] JSValueRef exception);
243
244     [local] HRESULT elementFromJS([in] JSContextRef context, [in] JSValueRef nodeObject, [out, retval] IDOMElement** element);
245
246
247     /*!
248         @method defaultMinimumTimerInterval
249         @discussion Returns the default minimum interval for DOMTimers on all pages, not
250         just the one associated with this receiver.
251         - (double)interval;
252     */
253     HRESULT defaultMinimumTimerInterval([out, retval] double* interval);
254
255     /*!
256         @method setMinimumTimerInterval
257         @discussion Sets the minimum interval for DOMTimers on the web page associated
258         with the receiver.
259         - (double)interval;
260     */
261     HRESULT setMinimumTimerInterval([in] double interval);
262
263     /*!
264         @method _HTTPPipeliningEnabled
265         @abstract Checks the HTTP pipelining status.
266         @discussion Defaults to NO.
267         @result YES if HTTP pipelining is enabled, NO if not enabled.
268      */
269     HRESULT httpPipeliningEnabled([out, retval] BOOL* enabled);
270
271     /*!
272         @method _setHTTPPipeliningEnabled:
273         @abstract Set the HTTP pipelining status.
274         @discussion Defaults to NO.
275         @param enabled The new HTTP pipelining status.
276      */
277     HRESULT setHTTPPipeliningEnabled([in] BOOL enabled);
278 }