2c8f87b826fccc401efe55199afefd31bc01aa5f
[WebKit-https.git] / WebKit / WebView / WebFrameInternal.h
1 /*
2  * Copyright (C) 2005, 2006 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 "WebFramePrivate.h"
32
33 #import "WebFrameLoaderClient.h"
34 #import "WebPolicyDelegatePrivate.h"
35
36 #import "WebFrameLoader.h"
37
38 @class WebDocumentLoader;
39 @class WebInspector;
40 @class WebFrameView;
41 @class WebFrameBridge;
42 @class WebFormState;
43
44 // One day we might want to expand the use of this kind of class such that we'd receive one
45 // over the bridge, and possibly hand it on through to the FormsDelegate.
46 // Today it is just used internally to keep some state as we make our way through a bunch
47 // layers while doing a load.
48 @interface WebFormState : NSObject
49 {
50     DOMElement *_form;
51     NSDictionary *_values;
52     WebFrame *_sourceFrame;
53 }
54 - (id)initWithForm:(DOMElement *)form values:(NSDictionary *)values sourceFrame:(WebFrame *)sourceFrame;
55 - (DOMElement *)form;
56 - (NSDictionary *)values;
57 - (WebFrame *)sourceFrame;
58 @end
59
60 @interface WebFrame (WebInternal)
61
62 - (void)_updateBackground;
63 - (void)_setInternalLoadDelegate:(id)internalLoadDelegate;
64 - (id)_internalLoadDelegate;
65 - (void)_unmarkAllMisspellings;
66 // Note that callers should not perform any ops on these views that could change the set of frames
67 - (NSArray *)_documentViews;
68
69 - (BOOL)_hasSelection;
70 - (void)_clearSelection;
71 - (WebFrame *)_findFrameWithSelection;
72 - (void)_clearSelectionInOtherFrames;
73 - (id)_initWithWebFrameView:(WebFrameView *)fv webView:(WebView *)v bridge:(WebFrameBridge *)bridge;
74
75 - (void)_addPlugInView:(NSView *)plugInView;
76 - (void)_removeAllPlugInViews;
77
78 // This should be called when leaving a page or closing the WebView
79 - (void)_willCloseURL;
80
81 - (BOOL)_isMainFrame;
82
83 - (void)_addInspector:(WebInspector *)inspector;
84 - (void)_removeInspector:(WebInspector *)inspector;
85
86 - (WebFrameLoader *)_frameLoader;
87 - (void)_prepareForDataSourceReplacement;
88 - (void)_frameLoadCompleted;
89 - (WebDataSource *)_dataSourceForDocumentLoader:(WebDocumentLoader *)loader;
90 - (WebDocumentLoader *)_createDocumentLoaderWithRequest:(NSURLRequest *)request;
91
92 - (NSURLRequest *)_webDataRequestForData:(NSData *)data MIMEType:(NSString *)MIMEType textEncodingName:(NSString *)encodingName baseURL:(NSURL *)URL unreachableURL:(NSURL *)unreachableURL;
93
94 - (WebFrameBridge *)_bridge;
95
96 - (void)_goToItem:(WebHistoryItem *)item withLoadType:(FrameLoadType)type;
97 - (void)_loadURL:(NSURL *)URL referrer:(NSString *)referrer intoChild:(WebFrame *)childFrame;
98
99 - (void)_viewWillMoveToHostWindow:(NSWindow *)hostWindow;
100 - (void)_viewDidMoveToHostWindow;
101
102 - (void)_addChild:(WebFrame *)child;
103
104 - (WebHistoryItem *)_itemForSavingDocState;
105 - (WebHistoryItem *)_itemForRestoringDocState;
106
107 - (void)_saveDocumentAndScrollState;
108
109 - (void)_setTitle:(NSString *)title forURL:(NSURL *)URL;
110
111 + (CFAbsoluteTime)_timeOfLastCompletedLoad;
112 - (BOOL)_canCachePage;
113 - (void)_purgePageCache;
114
115 // used to decide to use loadType=Same
116 - (BOOL)_shouldTreatURLAsSameAsCurrent:(NSURL *)URL;
117
118 - (WebFrame *)_nextFrameWithWrap:(BOOL)wrapFlag;
119 - (WebFrame *)_previousFrameWithWrap:(BOOL)wrapFlag;
120
121 - (BOOL)_shouldCreateRenderers;
122
123 - (int)_numPendingOrLoadingRequests:(BOOL)recurse;
124
125 - (void)_reloadForPluginChanges;
126
127 - (void)_attachScriptDebugger;
128 - (void)_detachScriptDebugger;
129
130 - (void)_recursive_pauseNullEventsForAllNetscapePlugins;
131 - (void)_recursive_resumeNullEventsForAllNetscapePlugins;
132
133 - (void)_restoreScrollPositionAndViewState;
134
135 - (void)_provisionalLoadStarted;
136 - (void)_addHistoryItemForFragmentScroll;
137 - (void)_didFinishLoad;
138
139 @end
140
141 @interface NSObject (WebInternalFrameLoadDelegate)
142 - (void)webFrame:(WebFrame *)webFrame didFinishLoadWithError:(NSError *)error;
143 @end
144
145 @interface WebFrame (FrameTraversal)
146 - (WebFrame *)_firstChildFrame;
147 - (WebFrame *)_lastChildFrame;
148 - (unsigned)_childFrameCount;
149 - (WebFrame *)_previousSiblingFrame;
150 - (WebFrame *)_nextSiblingFrame;
151 - (WebFrame *)_traverseNextFrameStayWithin:(WebFrame *)stayWithin;
152 @end
153
154 @interface WebFrame (WebFrameLoaderClient) <WebFrameLoaderClient>
155 @end