Reviewed by Darin
[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 #import "WebPolicyDelegatePrivate.h"
33 #import <WebCore/FrameLoaderTypes.h>
34
35 @class WebDocumentLoader;
36 @class WebInspector;
37 @class WebFrameView;
38 @class WebFrameBridge;
39
40 #ifdef __cplusplus
41 namespace WebCore {
42     class DocumentLoader;
43     class FrameLoader;
44 }
45 typedef WebCore::DocumentLoader WebCoreDocumentLoader;
46 typedef WebCore::FrameLoader WebCoreFrameLoader;
47 #else
48 @class WebCoreDocumentLoader;
49 @class WebCoreFrameLoader;
50 #endif
51
52 @interface WebFrame (WebInternal)
53
54 - (void)_updateBackground;
55 - (void)_setInternalLoadDelegate:(id)internalLoadDelegate;
56 - (id)_internalLoadDelegate;
57 #if !BUILDING_ON_TIGER
58 - (void)_unmarkAllBadGrammar;
59 #endif
60 - (void)_unmarkAllMisspellings;
61 // Note that callers should not perform any ops on these views that could change the set of frames
62 - (NSArray *)_documentViews;
63
64 - (BOOL)_hasSelection;
65 - (void)_clearSelection;
66 - (WebFrame *)_findFrameWithSelection;
67 - (void)_clearSelectionInOtherFrames;
68 - (id)_initWithWebFrameView:(WebFrameView *)fv webView:(WebView *)v bridge:(WebFrameBridge *)bridge;
69
70 - (void)_addPlugInView:(NSView *)plugInView;
71 - (void)_removeAllPlugInViews;
72
73 // This should be called when leaving a page or closing the WebView
74 - (void)_willCloseURL;
75
76 - (BOOL)_isMainFrame;
77
78 - (void)_addInspector:(WebInspector *)inspector;
79 - (void)_removeInspector:(WebInspector *)inspector;
80
81 - (WebCoreFrameLoader*)_frameLoader;
82 - (WebDataSource *)_dataSourceForDocumentLoader:(WebCoreDocumentLoader*)loader;
83
84 - (NSURLRequest *)_webDataRequestForData:(NSData *)data MIMEType:(NSString *)MIMEType textEncodingName:(NSString *)encodingName baseURL:(NSURL *)URL unreachableURL:(NSURL *)unreachableURL;
85
86 - (WebFrameBridge *)_bridge;
87
88 - (void)_goToItem:(WebHistoryItem *)item withLoadType:(FrameLoadType)type;
89 - (void)_loadURL:(NSURL *)URL referrer:(NSString *)referrer intoChild:(WebFrame *)childFrame;
90
91 - (void)_viewWillMoveToHostWindow:(NSWindow *)hostWindow;
92 - (void)_viewDidMoveToHostWindow;
93
94 - (void)_addChild:(WebFrame *)child;
95
96 - (WebHistoryItem *)_itemForSavingDocState;
97 - (WebHistoryItem *)_itemForRestoringDocState;
98
99 - (void)_saveDocumentAndScrollState;
100
101 + (CFAbsoluteTime)_timeOfLastCompletedLoad;
102 - (BOOL)_canCachePage;
103 - (void)_purgePageCache;
104
105
106 - (WebFrame *)_nextFrameWithWrap:(BOOL)wrapFlag;
107 - (WebFrame *)_previousFrameWithWrap:(BOOL)wrapFlag;
108
109 - (int)_numPendingOrLoadingRequests:(BOOL)recurse;
110
111 - (void)_reloadForPluginChanges;
112
113 - (void)_attachScriptDebugger;
114 - (void)_detachScriptDebugger;
115
116 - (void)_recursive_pauseNullEventsForAllNetscapePlugins;
117 - (void)_recursive_resumeNullEventsForAllNetscapePlugins;
118
119 - (void)_addDocumentLoader:(WebCoreDocumentLoader*)loader toUnarchiveState:(WebArchive *)archive;
120
121 @end
122
123 @interface NSObject (WebInternalFrameLoadDelegate)
124 - (void)webFrame:(WebFrame *)webFrame didFinishLoadWithError:(NSError *)error;
125 @end
126
127 @interface WebFrame (FrameTraversal)
128 - (WebFrame *)_firstChildFrame;
129 - (WebFrame *)_lastChildFrame;
130 - (unsigned)_childFrameCount;
131 - (WebFrame *)_previousSiblingFrame;
132 - (WebFrame *)_nextSiblingFrame;
133 - (WebFrame *)_traverseNextFrameStayWithin:(WebFrame *)stayWithin;
134 @end