2006-12-18 Ada Chan <adachan@apple.com>
[WebKit-https.git] / WebCore / page / mac / FrameMac.h
1 /*
2  * Copyright (C) 2004, 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef FrameMac_h
27 #define FrameMac_h
28
29 #import "Frame.h"
30
31 class NPObject;
32
33 namespace KJS {
34     namespace Bindings {
35         class Instance;
36         class RootObject;
37     }
38 }
39
40 #ifdef __OBJC__
41
42 @class NSArray;
43 @class NSDictionary;
44 @class NSFont;
45 @class NSImage;
46 @class NSMenu;
47 @class NSMutableDictionary;
48 @class NSString;
49 @class WebCoreFrameBridge;
50 @class WebScriptObject;
51
52 #else
53
54 class NSArray;
55 class NSDictionary;
56 class NSFont;
57 class NSImage;
58 class NSMenu;
59 class NSMutableDictionary;
60 class NSString;
61 class WebCoreFrameBridge;
62 class WebScriptObject;
63
64 typedef unsigned int NSDragOperation;
65 typedef int NSWritingDirection;
66
67 #endif
68
69 namespace WebCore {
70
71 class ClipboardMac;
72 class EditorClient;
73 class HTMLTableCellElement;
74 class RenderWidget;
75
76 class FrameMac : public Frame {
77     friend class Frame;
78
79 public:
80     FrameMac(Page*, HTMLFrameOwnerElement*, FrameLoaderClient*);
81     ~FrameMac();
82
83     void setBridge(WebCoreFrameBridge*);
84     WebCoreFrameBridge* bridge() const { return _bridge; }
85
86 private:    
87     WebCoreFrameBridge* _bridge;
88
89 // === undecided, may or may not belong here
90
91 public:
92     virtual void setView(FrameView*);
93     
94     static WebCoreFrameBridge* bridgeForWidget(const Widget*);
95
96     NSString* searchForLabelsAboveCell(RegularExpression*, HTMLTableCellElement*);
97     NSString* searchForLabelsBeforeElement(NSArray* labels, Element*);
98     NSString* matchLabelsAgainstElement(NSArray* labels, Element*);
99
100     virtual KJS::Bindings::Instance* getEmbedInstanceForWidget(Widget*);
101     virtual KJS::Bindings::Instance* getObjectInstanceForWidget(Widget*);
102     virtual KJS::Bindings::Instance* getAppletInstanceForWidget(Widget*);
103     virtual KJS::Bindings::RootObject* bindingRootObject();
104
105     void addPluginRootObject(KJS::Bindings::RootObject*);
106
107     KJS::Bindings::RootObject* executionContextForDOM();
108     
109     WebScriptObject* windowScriptObject();
110     NPObject* windowScriptNPObject();
111     
112     NSMutableDictionary* dashboardRegionsDictionary();
113     void dashboardRegionsChanged();
114
115     void willPopupMenu(NSMenu *);
116
117     void cleanupPluginObjects();
118
119     NSImage* selectionImage(bool forceWhiteText = false) const;
120     NSImage* snapshotDragImage(Node*, NSRect* imageRect, NSRect* elementRect) const;
121
122 private:    
123     NSImage* imageFromRect(NSRect) const;
124
125     KJS::Bindings::RootObject* _bindingRoot; // The root object used for objects bound outside the context of a plugin.
126     Vector<KJS::Bindings::RootObject*> m_rootObjects;
127     WebScriptObject* _windowScriptObject;
128     NPObject* _windowScriptNPObject;
129
130 // === to be moved into Chrome
131
132 public:
133     virtual void setStatusBarText(const String&);
134
135     virtual void focusWindow();
136     virtual void unfocusWindow();
137
138     virtual void runJavaScriptAlert(const String&);
139     virtual bool runJavaScriptConfirm(const String&);
140     virtual bool runJavaScriptPrompt(const String& message, const String& defaultValue, String& result);
141     virtual bool shouldInterruptJavaScript();    
142
143     FloatRect customHighlightLineRect(const AtomicString& type, const FloatRect& lineRect);
144     void paintCustomHighlight(const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect, bool text, bool line);
145
146     virtual void print();
147
148 // === to be moved into Editor
149
150 public:
151
152     NSDictionary* fontAttributesForSelectionStart() const;
153     
154     NSWritingDirection baseWritingDirectionForSelectionStart() const;
155
156     virtual void issueCutCommand();
157     virtual void issueCopyCommand();
158     virtual void issuePasteCommand();
159     virtual void issuePasteAndMatchStyleCommand();
160     virtual void issueTransposeCommand();
161     virtual void respondToChangedSelection(const Selection& oldSelection, bool closeTyping);
162     virtual bool isContentEditable() const;
163     virtual bool shouldChangeSelection(const Selection& oldSelection, const Selection& newSelection, EAffinity affinity, bool stillSelecting) const;
164     virtual bool shouldDeleteSelection(const Selection&) const;
165     
166     virtual void setSecureKeyboardEntry(bool);
167     virtual bool isSecureKeyboardEntry();
168
169     void setMarkedTextRange(const Range* , NSArray* attributes, NSArray* ranges);
170     virtual Range* markedTextRange() const { return m_markedTextRange.get(); }
171
172     virtual void textFieldDidBeginEditing(Element*);
173     virtual void textFieldDidEndEditing(Element*);
174     virtual void textDidChangeInTextField(Element*);
175     virtual bool doTextFieldCommandFromEvent(Element*, KeyboardEvent*);
176     virtual void textWillBeDeletedInTextField(Element*);
177     virtual void textDidChangeInTextArea(Element*);
178     
179 private:
180     RefPtr<Range> m_markedTextRange;
181     
182 // === to be moved into the Platform directory
183
184 public:
185     virtual String mimeTypeForFileName(const String&) const;
186     virtual bool isCharacterSmartReplaceExempt(UChar, bool);
187     
188 };
189
190 inline FrameMac* Mac(Frame* frame) { return static_cast<FrameMac*>(frame); }
191 inline const FrameMac* Mac(const Frame* frame) { return static_cast<const FrameMac*>(frame); }
192
193 }
194
195 #endif