LayoutTests:
[WebKit-https.git] / WebCore / page / Frame.h
1 // -*- c-basic-offset: 4 -*-
2  /* This file is part of the KDE project
3  *
4  * Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
5  *                     1999-2001 Lars Knoll <knoll@kde.org>
6  *                     1999-2001 Antti Koivisto <koivisto@kde.org>
7  *                     2000-2001 Simon Hausmann <hausmann@kde.org>
8  *                     2000-2001 Dirk Mueller <mueller@kde.org>
9  *                     2000 Stefan Schimanski <1Stein@gmx.de>
10  * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.
11  *
12  * This library is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU Library General Public
14  * License as published by the Free Software Foundation; either
15  * version 2 of the License, or (at your option) any later version.
16  *
17  * This library is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * Library General Public License for more details.
21  *
22  * You should have received a copy of the GNU Library General Public License
23  * along with this library; see the file COPYING.LIB.  If not, write to
24  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25  * Boston, MA 02111-1307, USA.
26  */
27
28 #ifndef Frame_H
29 #define Frame_H
30
31 #include "Color.h"
32 #include "EditAction.h"
33 #include "RenderLayer.h"
34 #include "TextAffinity.h"
35 #include "TextGranularity.h"
36 #include "UChar.h"
37 #include <wtf/Forward.h>
38 #include <wtf/Vector.h>
39
40 namespace KJS {
41     class JSValue;
42     class PausedTimeouts;
43     class SavedBuiltins;
44     class SavedProperties;
45
46     namespace Bindings {
47         class Instance;
48         class RootObject;
49     }
50 }
51
52 namespace WebCore {
53
54 class CSSComputedStyleDeclaration;
55 class CSSMutableStyleDeclaration;
56 class CSSStyleDeclaration;
57 class CommandByName;
58 class DOMWindow;
59 class Document;
60 class EditCommand;
61 class Editor;
62 class EditorClient;
63 class Element;
64 class FloatRect;
65 class FrameLoader;
66 class FramePrivate;
67 class FrameTree;
68 class FrameView;
69 class GraphicsContext;
70 class HTMLFormElement;
71 class HitTestResult;
72 class IntRect;
73 class KJSProxy;
74 class KURL;
75 class MouseEventWithHitTestResults;
76 class Node;
77 class Page;
78 class Range;
79 class RenderObject;
80 class RenderPart;
81 class RenderStyle;
82 class Selection;
83 class SelectionController;
84 class Settings;
85 class VisiblePosition;
86 class Widget;
87
88 struct FrameLoadRequest;
89
90 template <typename T> class Timer;
91
92 struct MarkedTextUnderline {
93     MarkedTextUnderline() 
94         : startOffset(0), endOffset(0), thick(false) { }
95     MarkedTextUnderline(unsigned s, unsigned e, const Color& c, bool t) 
96         : startOffset(s), endOffset(e), color(c), thick(t) { }
97     unsigned startOffset;
98     unsigned endOffset;
99     Color color;
100     bool thick;
101 };
102
103 class Frame : public Shared<Frame> {
104 public:
105     Frame(Page*, Element*, PassRefPtr<EditorClient>);
106     virtual void setView(FrameView*);
107     virtual ~Frame();
108
109     Page* page() const;
110     Element* ownerElement();
111
112     void pageDestroyed();
113     void disconnectOwnerElement();
114
115     Document* document() const;
116     FrameView* view() const;
117
118     CommandByName* command() const;
119     DOMWindow* domWindow() const;
120     Editor* editor() const;
121     FrameLoader* loader() const;
122     SelectionController* selectionController() const;
123     const Settings* settings() const;
124     FrameTree* tree() const;
125
126     RenderObject* renderer() const; // root renderer for the document contained in this frame
127     RenderPart* ownerRenderer(); // renderer for the element that contains this frame
128
129     friend class FrameGdk;
130     friend class FrameLoader;
131     friend class FrameMac;
132     friend class FramePrivate;
133     friend class FrameQt;
134     friend class FrameWin;
135
136 private:
137     FramePrivate* d;
138
139 // === undecided, may or may not belong here
140
141 public:
142     bool javaScriptEnabled() const;
143     bool javaEnabled() const;
144     bool pluginsEnabled() const;
145
146     void setSettings(Settings*);
147     void reparseConfiguration();
148
149     void paint(GraphicsContext*, const IntRect&);
150
151     void setUserStyleSheetLocation(const KURL&);
152     void setUserStyleSheet(const String& styleSheetData);
153
154     void setStandardFont(const String& name);
155     void setFixedFont(const String& name);
156
157     void setZoomFactor(int percent);
158     int zoomFactor() const;
159
160     bool inViewSourceMode() const;
161     void setInViewSourceMode(bool = true) const;
162
163     void setJSStatusBarText(const String&);
164     void setJSDefaultStatusBarText(const String&);
165     String jsStatusBarText() const;
166     String jsDefaultStatusBarText() const;
167
168     virtual void setupRootForPrinting(bool onOrOff) { }
169     virtual Vector<IntRect> computePageRects(const IntRect& printRect, float userScaleFactor) { return Vector<IntRect>(); }
170
171     void keepAlive(); // Used to keep the frame alive when running a script that might destroy it.
172     static void endAllLifeSupport();
173
174     virtual KJS::Bindings::Instance* getEmbedInstanceForWidget(Widget*) = 0;
175     virtual KJS::Bindings::Instance* getObjectInstanceForWidget(Widget*) = 0;
176     virtual KJS::Bindings::Instance* getAppletInstanceForWidget(Widget*) = 0;
177     virtual KJS::Bindings::RootObject* bindingRootObject() = 0;
178
179     void setDocument(Document*);
180
181     KJSProxy* scriptProxy();
182
183     bool isFrameSet() const;
184
185     bool scrollOverflow(ScrollDirection, ScrollGranularity);
186
187     void adjustPageHeight(float* newBottom, float oldTop, float oldBottom, float bottomLimit);
188
189     static void clearDocumentFocus(Widget*);
190
191     void forceLayout();
192     void forceLayoutWithPageWidthRange(float minPageWidth, float maxPageWidth);
193
194     void sendResizeEvent();
195     void sendScrollEvent();
196     bool canMouseDownStartSelect(Node*);
197
198     void clearTimers();
199     static void clearTimers(FrameView*);
200
201     bool isActive() const;
202     virtual void setIsActive(bool flag);
203     void setWindowHasFocus(bool flag);
204
205     // Convenience, to avoid repeating the code to dig down to get this.
206     UChar backslashAsCurrencySymbol() const;
207
208     void setNeedsReapplyStyles();
209     String documentTypeString() const;
210
211 protected:
212     virtual void cleanupPluginObjects() { }
213
214 private:
215     void lifeSupportTimerFired(Timer<Frame>*);
216     void endLifeSupport();
217
218 // === to be moved into Chrome
219
220 public:
221     virtual void addMessageToConsole(const String& message,  unsigned int lineNumber, const String& sourceID) = 0;
222
223     virtual void runJavaScriptAlert(const String& message) = 0;
224     virtual bool runJavaScriptConfirm(const String& message) = 0;
225     virtual bool runJavaScriptPrompt(const String& message, const String& defaultValue, String& result) = 0;  
226     virtual bool shouldInterruptJavaScript() = 0;
227     virtual void scheduleClose() = 0;
228     virtual void focusWindow() = 0;
229     virtual void unfocusWindow() = 0;
230     virtual void print() = 0;
231
232 private:
233     virtual void setStatusBarText(const String&);
234
235 // === to be moved into Editor
236
237 public:
238     virtual String selectedText() const;  
239     bool findString(const String&, bool, bool, bool);
240
241     const Selection& mark() const; // Mark, to be used as emacs uses it.
242     void setMark(const Selection&);
243
244     void transpose();
245
246     void copyToPasteboard();
247     void cutToPasteboard();
248     void pasteFromPasteboard();
249     void pasteAndMatchStyle();
250     void redo();
251     void undo();
252     virtual bool canRedo() const = 0;
253     virtual bool canUndo() const = 0;
254     void computeAndSetTypingStyle(CSSStyleDeclaration* , EditAction = EditActionUnspecified);
255     enum TriState { falseTriState, trueTriState, mixedTriState };
256     TriState selectionHasStyle(CSSStyleDeclaration*) const;
257     String selectionStartStylePropertyValue(int stylePropertyID) const;
258     void applyEditingStyleToBodyElement() const;
259     void removeEditingStyleFromBodyElement() const;
260     void applyEditingStyleToElement(Element*) const;
261     void removeEditingStyleFromElement(Element*) const;
262
263     virtual void markMisspellingsInAdjacentWords(const VisiblePosition&) = 0;
264     virtual void markMisspellings(const Selection&) = 0;
265     virtual Range* markedTextRange() const = 0;
266     virtual void registerCommandForUndo(PassRefPtr<EditCommand>) = 0;
267     virtual void registerCommandForRedo(PassRefPtr<EditCommand>) = 0;
268     virtual void clearUndoRedoOperations() = 0;
269     virtual void issueUndoCommand() = 0;
270     virtual void issueRedoCommand() = 0;
271     virtual void issueCutCommand() = 0;
272     virtual void issueCopyCommand() = 0;
273     virtual void issuePasteCommand() = 0;
274     virtual void issuePasteAndMatchStyleCommand() = 0;
275     virtual void issueTransposeCommand() = 0;
276     virtual void respondToChangedSelection(const Selection& oldSelection, bool closeTyping) = 0;
277     virtual void respondToChangedContents(const Selection& endingSelection) = 0;
278     virtual bool shouldChangeSelection(const Selection& oldSelection, const Selection& newSelection, EAffinity, bool stillSelecting) const = 0;
279
280     RenderStyle* styleForSelectionStart(Node* &nodeToRemove) const;
281
282     const Vector<MarkedTextUnderline>& markedTextUnderlines() const;  
283     bool markedTextUsesUnderlines() const;
284   
285     unsigned markAllMatchesForText(const String&, bool caseFlag, unsigned limit);
286     bool markedTextMatchesAreHighlighted() const;
287     void setMarkedTextMatchesAreHighlighted(bool flag);
288   
289     CSSComputedStyleDeclaration* selectionComputedStyle(Node*& nodeToRemove) const;
290
291     virtual void textFieldDidBeginEditing(Element*);
292     virtual void textFieldDidEndEditing(Element*);
293     virtual void textDidChangeInTextField(Element*);
294     virtual bool doTextFieldCommandFromEvent(Element*, KeyboardEvent*);
295     virtual void textWillBeDeletedInTextField(Element* input);
296     virtual void textDidChangeInTextArea(Element*);
297
298 // === to be moved into EventHandler
299
300 public:
301     virtual bool shouldDragAutoNode(Node*, const IntPoint&) const; // -webkit-user-drag == auto
302
303     virtual bool lastEventIsMouseUp() const = 0;
304
305     virtual bool tabsToLinks(KeyboardEvent*) const;
306     virtual bool tabsToAllControls(KeyboardEvent*) const;
307     virtual void handleMousePressEvent(const MouseEventWithHitTestResults&);
308     virtual void handleMouseMoveEvent(const MouseEventWithHitTestResults&);
309     virtual void handleMouseReleaseEvent(const MouseEventWithHitTestResults&);
310
311     void updateSelectionForMouseDragOverPosition(const VisiblePosition&);
312
313     void selectClosestWordFromMouseEvent(const PlatformMouseEvent&, Node* innerNode);
314
315     virtual bool mouseDownMayStartSelect() const { return true; }
316     bool mouseDownMayStartAutoscroll() const;
317     void setMouseDownMayStartAutoscroll(bool b);
318
319     bool mouseDownMayStartDrag() const;
320     void setMouseDownMayStartDrag(bool b);
321
322     static Frame* frameForWidget(const Widget*);
323     static Node* nodeForWidget(const Widget*);
324     static Frame* frameForNode(Node*);
325
326     Node* mousePressNode();
327
328     void stopAutoscrollTimer(bool rendererIsBeingDestroyed = false);
329     RenderObject* autoscrollRenderer() const;
330
331     HitTestResult hitTestResultAtPoint(const IntPoint&, bool allowShadowContent);
332
333     bool prohibitsScrolling() const;
334     void setProhibitsScrolling(const bool);
335   
336     virtual bool inputManagerHasMarkedText() const { return false; }
337
338 private:
339     void handleAutoscroll(RenderObject*);
340     void startAutoscrollTimer();
341     void setAutoscrollRenderer(RenderObject*);
342
343     void autoscrollTimerFired(Timer<Frame>*);
344
345     void handleMousePressEventSingleClick(const MouseEventWithHitTestResults&);
346     void handleMousePressEventDoubleClick(const MouseEventWithHitTestResults&);
347     void handleMousePressEventTripleClick(const MouseEventWithHitTestResults&);
348
349 // === to be moved into SelectionController
350
351 public:
352     TextGranularity selectionGranularity() const;
353     void setSelectionGranularity(TextGranularity) const;
354
355     bool shouldChangeSelection(const Selection&) const;
356     virtual bool shouldDeleteSelection(const Selection&) const;
357     void clearCaretRectIfNeeded();
358     void setFocusNodeIfNeeded();
359     void selectionLayoutChanged();
360     void notifyRendererOfSelectionChange(bool userTriggered);
361
362     void invalidateSelection();
363
364     void setCaretVisible(bool = true);
365     void paintCaret(GraphicsContext*, const IntRect&) const;  
366     void paintDragCaret(GraphicsContext*, const IntRect&) const;
367
368     void setXPosForVerticalArrowNavigation(int);
369     int xPosForVerticalArrowNavigation() const;
370
371     virtual bool isContentEditable() const; // if true, everything in frame is editable
372
373     virtual void setSecureKeyboardEntry(bool) { }
374     virtual bool isSecureKeyboardEntry() { return false; }
375
376     void appliedEditing(PassRefPtr<EditCommand>);
377     void unappliedEditing(PassRefPtr<EditCommand>);
378     void reappliedEditing(PassRefPtr<EditCommand>);
379
380     CSSMutableStyleDeclaration* typingStyle() const;
381     void setTypingStyle(CSSMutableStyleDeclaration*);
382     void clearTypingStyle();
383
384     IntRect selectionRect() const;
385     FloatRect visibleSelectionRect() const;
386
387     HTMLFormElement* currentForm() const;
388
389     void revealSelection(const RenderLayer::ScrollAlignment& = RenderLayer::gAlignCenterIfNeeded) const;
390     void revealCaret(const RenderLayer::ScrollAlignment& = RenderLayer::gAlignCenterIfNeeded) const;
391     void setSelectionFromNone();
392
393 private:
394     void caretBlinkTimerFired(Timer<Frame>*);
395
396 // === to be moved into the Platform directory
397
398 public:
399     virtual String mimeTypeForFileName(const String&) const = 0;
400     virtual bool isCharacterSmartReplaceExempt(UChar, bool);
401
402 // === to be deleted
403
404 public:
405     SelectionController* dragCaretController() const;
406
407 };
408
409 } // namespace WebCore
410
411 #endif // Frame_H