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
30namespace WebCore {
31
32class HTMLFrameElementBase : public HTMLFrameOwnerElement {
33public:
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
50protected:
51    HTMLFrameElementBase(const QualifiedName&, Document*);
52
53    bool isURLAllowed() const;
54
55    virtual void parseMappedAttribute(Attribute*);
56    virtual void insertedIntoDocument();
57    virtual void attach();
58
59private:
60    virtual bool supportsFocus() const;
61    virtual void setFocus(bool);
62
63    virtual bool isURLAttribute(Attribute*) const;
64
65    virtual void willRemove();
66    void checkInDocumentTimerFired(Timer<HTMLFrameElementBase>*);
67    void updateOnReparenting();
68
69    bool viewSourceMode() const { return m_viewSource; }
70
71    void setNameAndOpenURL();
72    void openURL(bool lockHistory = true, bool lockBackForwardList = true);
73
74    AtomicString m_URL;
75    AtomicString m_frameName;
76
77    ScrollbarMode m_scrolling;
78
79    int m_marginWidth;
80    int m_marginHeight;
81
82    // This is a performance optimization some call "magic iframe" which avoids
83    // tearing down the frame hierarchy when a web page calls adoptNode on a
84    // frame owning element but does not immediately insert it into the new
85    // document before JavaScript yields to WebCore.  If the element is not yet
86    // in a document by the time this timer fires, the frame hierarchy teardown
87    // will continue.  This can also be seen as implementation of:
88    // "Removing an iframe from a Document does not cause its browsing context
89    // to be discarded. Indeed, an iframe's browsing context can survive its
90    // original parent Document if its iframe is moved to another Document."
91    // From HTML5: http://www.whatwg.org/specs/web-apps/current-work/multipage/the-iframe-element.html#the-iframe-element
92    Timer<HTMLFrameElementBase> m_checkInDocumentTimer;
93
94    bool m_viewSource;
95    bool m_remainsAliveOnRemovalFromTree;
96};
97
98} // namespace WebCore
99
100#endif // HTMLFrameElementBase_h
101