2011-05-29 Jer Noble <jer.noble@apple.com>
[WebKit-https.git] / Source / WebCore / html / HTMLFrameElementBase.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Simon Hausmann <hausmann@kde.org>
5  * Copyright (C) 2004, 2006, 2008, 2009 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef HTMLFrameElementBase_h
25 #define HTMLFrameElementBase_h
26
27 #include "HTMLFrameOwnerElement.h"
28 #include "ScrollTypes.h"
29
30 namespace WebCore {
31
32 class HTMLFrameElementBase : public HTMLFrameOwnerElement {
33 public:
34     KURL location() const;
35     void setLocation(const String&);
36
37     virtual ScrollbarMode scrollingMode() const { return m_scrolling; }
38     
39     int marginWidth() const { return m_marginWidth; }
40     int marginHeight() const { return m_marginHeight; }
41
42     int width() const;
43     int height() const;
44
45     void setRemainsAliveOnRemovalFromTree(bool);
46 #if ENABLE(FULLSCREEN_API)
47     virtual bool allowFullScreen() const;
48 #endif
49
50     virtual bool canContainRangeEndPoint() const { return false; }
51
52 protected:
53     HTMLFrameElementBase(const QualifiedName&, Document*);
54
55     bool isURLAllowed() const;
56
57     virtual void parseMappedAttribute(Attribute*);
58     virtual void insertedIntoDocument();
59     virtual void attach();
60
61 private:
62     virtual bool supportsFocus() const;
63     virtual void setFocus(bool);
64     
65     virtual bool isURLAttribute(Attribute*) const;
66     virtual bool isFrameElementBase() const { return true; }
67
68     virtual void willRemove();
69     void checkInDocumentTimerFired(Timer<HTMLFrameElementBase>*);
70     void updateOnReparenting();
71
72     bool viewSourceMode() const { return m_viewSource; }
73
74     void setNameAndOpenURL();
75     void openURL(bool lockHistory = true, bool lockBackForwardList = true);
76
77     AtomicString m_URL;
78     AtomicString m_frameName;
79
80     ScrollbarMode m_scrolling;
81
82     int m_marginWidth;
83     int m_marginHeight;
84
85     // This is a performance optimization some call "magic iframe" which avoids
86     // tearing down the frame hierarchy when a web page calls adoptNode on a
87     // frame owning element but does not immediately insert it into the new
88     // document before JavaScript yields to WebCore.  If the element is not yet
89     // in a document by the time this timer fires, the frame hierarchy teardown
90     // will continue.  This can also be seen as implementation of:
91     // "Removing an iframe from a Document does not cause its browsing context
92     // to be discarded. Indeed, an iframe's browsing context can survive its
93     // original parent Document if its iframe is moved to another Document."
94     // From HTML5: http://www.whatwg.org/specs/web-apps/current-work/multipage/the-iframe-element.html#the-iframe-element
95     Timer<HTMLFrameElementBase> m_checkInDocumentTimer;
96
97     bool m_viewSource;
98     bool m_remainsAliveOnRemovalFromTree;
99 };
100
101 } // namespace WebCore
102
103 #endif // HTMLFrameElementBase_h