Rename Source/WebKit to Source/WebKitLegacy.
[WebKit-https.git] / Source / WebKitLegacy / mac / WebView / WebHTMLViewPrivate.h
1 /*
2  * Copyright (C) 2005, 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  *
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 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 #import <WebKitLegacy/WebHTMLView.h>
30
31 #if !TARGET_OS_IPHONE
32 #if !defined(ENABLE_NETSCAPE_PLUGIN_API)
33 #define ENABLE_NETSCAPE_PLUGIN_API 1
34 #endif
35 #endif
36
37 @class DOMDocumentFragment;
38 @class DOMNode;
39 @class DOMRange;
40 @class WebPluginController;
41
42 extern const float _WebHTMLViewPrintingMinimumShrinkFactor;
43 extern const float _WebHTMLViewPrintingMaximumShrinkFactor;
44
45 @interface WebHTMLView (WebPrivate)
46
47 + (NSArray *)supportedMIMETypes;
48 + (NSArray *)supportedMediaMIMETypes;
49 + (NSArray *)supportedImageMIMETypes;
50 + (NSArray *)supportedNonImageMIMETypes;
51 + (NSArray *)unsupportedTextMIMETypes;
52
53 - (void)close;
54
55 #if !TARGET_OS_IPHONE
56 // Modifier (flagsChanged) tracking SPI
57 + (void)_postFlagsChangedEvent:(NSEvent *)flagsChangedEvent;
58 - (void)_updateMouseoverWithFakeEvent;
59
60 - (void)_setAsideSubviews;
61 - (void)_restoreSubviews;
62 #endif
63
64 - (BOOL)_insideAnotherHTMLView;
65 - (void)_clearLastHitViewIfSelf;
66 #if !TARGET_OS_IPHONE
67 - (void)_updateMouseoverWithEvent:(NSEvent *)event;
68
69 + (NSArray *)_insertablePasteboardTypes;
70 + (NSString *)_dummyPasteboardType;
71 + (NSArray *)_selectionPasteboardTypes;
72 - (void)_writeSelectionToPasteboard:(NSPasteboard *)pasteboard;
73 #endif
74
75 - (void)_frameOrBoundsChanged;
76
77 #if !TARGET_OS_IPHONE
78 - (void)_handleAutoscrollForMouseDragged:(NSEvent *)event;
79 #endif
80 - (WebPluginController *)_pluginController;
81
82 // FIXME: _selectionRect is deprecated in favor of selectionRect, which is in protocol WebDocumentSelection.
83 // We can't remove this yet because it's still in use by Mail.
84 - (NSRect)_selectionRect;
85
86 #if !TARGET_OS_IPHONE
87 - (void)_startAutoscrollTimer:(NSEvent *)event;
88 #else
89 - (void)_startAutoscrollTimer:(WebEvent *)event;
90 #endif
91 - (void)_stopAutoscrollTimer;
92
93 - (BOOL)_canEdit;
94 - (BOOL)_canEditRichly;
95 - (BOOL)_canAlterCurrentSelection;
96 - (BOOL)_hasSelection;
97 - (BOOL)_hasSelectionOrInsertionPoint;
98 - (BOOL)_isEditable;
99
100 - (BOOL)_transparentBackground;
101 - (void)_setTransparentBackground:(BOOL)isBackgroundTransparent;
102
103 - (void)_setToolTip:(NSString *)string;
104
105 #if !TARGET_OS_IPHONE
106 // SPI used by Mail.
107 // FIXME: These should all be moved to WebView; we won't always have a WebHTMLView.
108 - (NSImage *)_selectionDraggingImage;
109 - (NSRect)_selectionDraggingRect;
110 - (DOMNode *)_insertOrderedList;
111 - (DOMNode *)_insertUnorderedList;
112 - (BOOL)_canIncreaseSelectionListLevel;
113 - (BOOL)_canDecreaseSelectionListLevel;
114 - (DOMNode *)_increaseSelectionListLevel;
115 - (DOMNode *)_increaseSelectionListLevelOrdered;
116 - (DOMNode *)_increaseSelectionListLevelUnordered;
117 - (void)_decreaseSelectionListLevel;
118 - (DOMDocumentFragment *)_documentFragmentFromPasteboard:(NSPasteboard *)pasteboard forType:(NSString *)pboardType inContext:(DOMRange *)context subresources:(NSArray **)subresources;
119 #endif
120
121 #if ENABLE_NETSCAPE_PLUGIN_API
122 - (void)_resumeNullEventsForAllNetscapePlugins;
123 - (void)_pauseNullEventsForAllNetscapePlugins;
124 #endif
125
126 - (BOOL)_isUsingAcceleratedCompositing;
127 - (NSView *)_compositingLayersHostingView;
128
129 #if !TARGET_OS_IPHONE
130 // SPI for printing (should be converted to API someday). When the WebHTMLView isn't being printed
131 // directly, this method must be called before paginating, or the computed height might be incorrect.
132 // Typically this would be called from inside an override of -[NSView knowsPageRange:].
133 - (void)_layoutForPrinting;
134 #endif
135 - (CGFloat)_adjustedBottomOfPageWithTop:(CGFloat)top bottom:(CGFloat)bottom limit:(CGFloat)bottomLimit;
136 - (BOOL)_isInPrintMode;
137 - (BOOL)_beginPrintModeWithPageWidth:(float)pageWidth height:(float)pageHeight shrinkToFit:(BOOL)shrinkToFit;
138 // Lays out to pages of the given minimum width and height or more (increasing both dimensions proportionally)
139 // as needed for the content to fit, but no more than the given maximum width.
140 - (BOOL)_beginPrintModeWithMinimumPageWidth:(CGFloat)minimumPageWidth height:(CGFloat)minimumPageHeight maximumPageWidth:(CGFloat)maximumPageWidth;
141 - (void)_endPrintMode;
142
143 - (BOOL)_isInScreenPaginationMode;
144 - (BOOL)_beginScreenPaginationModeWithPageSize:(CGSize)pageSize shrinkToFit:(BOOL)shrinkToFit;
145 - (void)_endScreenPaginationMode;
146
147 #if !TARGET_OS_IPHONE
148 - (BOOL)_canSmartReplaceWithPasteboard:(NSPasteboard *)pasteboard;
149 #endif
150
151 #if TARGET_OS_IPHONE
152 - (id)accessibilityRootElement;
153 #endif
154
155 @end