WebCore:
[WebKit-https.git] / WebKit / mac / WebView / WebFramePrivate.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 the WebFrame SPI.
30
31 #import <WebKit/WebFrame.h>
32 #import <JavaScriptCore/JSBase.h>
33
34 #if !defined(ENABLE_NETSCAPE_PLUGIN_API)
35 #define ENABLE_NETSCAPE_PLUGIN_API 1
36 #endif
37
38 @class WebIconFetcher;
39 @class WebScriptObject;
40
41 // Keys for accessing the values in the page cache dictionary.
42 extern NSString *WebPageCacheEntryDateKey;
43 extern NSString *WebPageCacheDataSourceKey;
44 extern NSString *WebPageCacheDocumentViewKey;
45
46 typedef enum {
47     WebFrameLoadTypeStandard,
48     WebFrameLoadTypeBack,
49     WebFrameLoadTypeForward,
50     WebFrameLoadTypeIndexedBackForward, // a multi-item hop in the backforward list
51     WebFrameLoadTypeReload,
52     WebFrameLoadTypeReloadAllowingStaleData,
53     WebFrameLoadTypeSame,               // user loads same URL again (but not reload button)
54     WebFrameLoadTypeInternal,           // maps to WebCore::FrameLoadTypeRedirectWithLockedHistory
55     WebFrameLoadTypeReplace
56 } WebFrameLoadType;
57
58 @interface WebFrame (WebPrivate)
59 - (BOOL)_isDescendantOfFrame:(WebFrame *)frame;
60 - (void)_setShouldCreateRenderers:(BOOL)f;
61 - (NSColor *)_bodyBackgroundColor;
62 - (BOOL)_isFrameSet;
63 - (BOOL)_firstLayoutDone;
64 - (WebFrameLoadType)_loadType;
65
66 // These methods take and return NSRanges based on the root editable element as the positional base.
67 // This fits with AppKit's idea of an input context. These methods are slow compared to their DOMRange equivalents.
68 // You should use WebView's selectedDOMRange and setSelectedDOMRange whenever possible.
69 - (NSRange)_selectedNSRange;
70 - (void)_selectNSRange:(NSRange)range;
71
72 - (BOOL)_isDisplayingStandaloneImage;
73
74 - (unsigned) _pendingFrameUnloadEventCount;
75
76 - (WebIconFetcher *)fetchApplicationIcon:(id)target
77                                 selector:(SEL)selector;
78
79 - (void)_setIsDisconnected:(bool)isDisconnected;
80 - (void)_setExcludeFromTextSearch:(bool)exclude;
81
82 #if ENABLE_NETSCAPE_PLUGIN_API
83 - (void)_recursive_resumeNullEventsForAllNetscapePlugins;
84 - (void)_recursive_pauseNullEventsForAllNetscapePlugins;
85 #endif
86
87 @end