Reviewed by Darin
[WebKit-https.git] / WebKit / WebView / WebFrameInternal.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 // This header contains WebFrame declarations that can be used anywhere in WebKit, but are neither SPI nor API.
30
31 #import <WebKit/WebFramePrivate.h>
32 #import "WebPolicyDelegatePrivate.h"
33
34 @class WebDocumentLoadState;
35 @class WebInspector;
36 @class WebFrameLoader;
37 @class WebFrameView;
38 @class WebFrameBridge;
39 @class WebFormState;
40
41 // One day we might want to expand the use of this kind of class such that we'd receive one
42 // over the bridge, and possibly hand it on through to the FormsDelegate.
43 // Today it is just used internally to keep some state as we make our way through a bunch
44 // layers while doing a load.
45 @interface WebFormState : NSObject
46 {
47     DOMElement *_form;
48     NSDictionary *_values;
49     WebFrame *_sourceFrame;
50 }
51 - (id)initWithForm:(DOMElement *)form values:(NSDictionary *)values sourceFrame:(WebFrame *)sourceFrame;
52 - (DOMElement *)form;
53 - (NSDictionary *)values;
54 - (WebFrame *)sourceFrame;
55 @end
56
57 @interface WebFrame (WebInternal)
58
59 - (void)_updateBackground;
60 - (void)_setInternalLoadDelegate:(id)internalLoadDelegate;
61 - (id)_internalLoadDelegate;
62 - (void)_unmarkAllMisspellings;
63 // Note that callers should not perform any ops on these views that could change the set of frames
64 - (NSArray *)_documentViews;
65
66 - (NSURLRequest *)_requestFromDelegateForRequest:(NSURLRequest *)request identifier:(id *)identifier error:(NSError **)error;
67 - (void)_sendRemainingDelegateMessagesWithIdentifier:(id)identifier response:(NSURLResponse *)response length:(unsigned)length error:(NSError *)error;
68 - (void)_safeLoadURL:(NSURL *)URL;
69
70 - (BOOL)_hasSelection;
71 - (void)_clearSelection;
72 - (WebFrame *)_findFrameWithSelection;
73 - (void)_clearSelectionInOtherFrames;
74 - (BOOL)_subframeIsLoading;
75 - (id)_initWithWebFrameView:(WebFrameView *)fv webView:(WebView *)v bridge:(WebFrameBridge *)bridge;
76
77 - (void)_addPlugInView:(NSView *)plugInView;
78 - (void)_removeAllPlugInViews;
79
80 // This should be called when leaving a page or closing the WebView
81 - (void)_willCloseURL;
82
83 - (void)_addExtraFieldsToRequest:(NSMutableURLRequest *)request mainResource:(BOOL)mainResource alwaysFromRequest:(BOOL)f;
84 - (BOOL)_isMainFrame;
85
86 - (void)_addInspector:(WebInspector *)inspector;
87 - (void)_removeInspector:(WebInspector *)inspector;
88
89 - (WebFrameLoader *)_frameLoader;
90 - (void)_provisionalLoadStarted;
91 - (void)_prepareForDataSourceReplacement;
92 - (void)_frameLoadCompleted;
93 - (WebDataSource *)_dataSourceForDocumentLoadState:(WebDocumentLoadState *)loadState;
94 - (WebDocumentLoadState *)_createDocumentLoadStateWithRequest:(NSURLRequest *)request;
95 - (void)_didReceiveServerRedirectForProvisionalLoadForFrame;
96
97 - (NSURLRequest *)_webDataRequestForData:(NSData *)data MIMEType:(NSString *)MIMEType textEncodingName:(NSString *)encodingName baseURL:(NSURL *)URL unreachableURL:(NSURL *)unreachableURL;
98
99 - (void)_detachFromParent;
100 - (void)_detachChildren;
101 - (void)_closeOldDataSources;
102 - (void)_commitProvisionalLoad:(NSDictionary *)pageCache;
103 - (void)_checkLoadCompleteForThisFrame;
104 - (void)_handledOnloadEvents;
105 - (void)_checkLoadComplete;
106 - (WebFrameBridge *)_bridge;
107
108 - (void)_goToItem:(WebHistoryItem *)item withLoadType:(WebFrameLoadType)type;
109 - (void)_loadURL:(NSURL *)URL referrer:(NSString *)referrer loadType:(WebFrameLoadType)loadType target:(NSString *)target triggeringEvent:(NSEvent *)event form:(DOMElement *)form formValues:(NSDictionary *)values;
110 - (void)_loadURL:(NSURL *)URL referrer:(NSString *)referrer intoChild:(WebFrame *)childFrame;
111 - (void)_postWithURL:(NSURL *)URL referrer:(NSString *)referrer target:(NSString *)target data:(NSArray *)postData contentType:(NSString *)contentType triggeringEvent:(NSEvent *)event form:(DOMElement *)form formValues:(NSDictionary *)values;
112
113 - (void)_loadRequest:(NSURLRequest *)request inFrameNamed:(NSString *)frameName;
114
115 - (void)_clientRedirectedTo:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date lockHistory:(BOOL)lockHistory isJavaScriptFormAction:(BOOL)isJavaScriptFormAction;
116 - (void)_clientRedirectCancelledOrFinished:(BOOL)cancelWithLoadInProgress;
117
118 - (void)_defersCallbacksChanged;
119
120 - (void)_viewWillMoveToHostWindow:(NSWindow *)hostWindow;
121 - (void)_viewDidMoveToHostWindow;
122
123 - (void)_addChild:(WebFrame *)child;
124
125 - (NSDictionary *)_actionInformationForNavigationType:(WebNavigationType)navigationType event:(NSEvent *)event originalURL:(NSURL *)URL;
126
127 - (WebHistoryItem *)_itemForSavingDocState;
128 - (WebHistoryItem *)_itemForRestoringDocState;
129
130 - (void)_saveDocumentAndScrollState;
131
132 - (void)_setTitle:(NSString *)title;
133
134 - (void)_receivedMainResourceError:(NSError *)error;
135
136 + (CFAbsoluteTime)_timeOfLastCompletedLoad;
137 - (BOOL)_canCachePage;
138 - (void)_purgePageCache;
139
140 - (void)_opened;
141 // used to decide to use loadType=Same
142 - (BOOL)_shouldTreatURLAsSameAsCurrent:(NSURL *)URL;
143
144 - (WebFrame *)_nextFrameWithWrap:(BOOL)wrapFlag;
145 - (WebFrame *)_previousFrameWithWrap:(BOOL)wrapFlag;
146
147
148 - (BOOL)_shouldCreateRenderers;
149
150 - (int)_numPendingOrLoadingRequests:(BOOL)recurse;
151
152 - (void)_reloadForPluginChanges;
153
154 - (void)_attachScriptDebugger;
155 - (void)_detachScriptDebugger;
156
157 - (void)_recursive_pauseNullEventsForAllNetscapePlugins;
158 - (void)_recursive_resumeNullEventsForAllNetscapePlugins;
159
160 - (void)_restoreScrollPositionAndViewState;
161
162 @end
163
164 @interface NSObject (WebInternalFrameLoadDelegate)
165 - (void)webFrame:(WebFrame *)webFrame didFinishLoadWithError:(NSError *)error;
166 @end