79ce46b3b46774764e9c96e31678a87884c51dac
[WebKit-https.git] / WebCore / page / FrameTree.h
1 // -*- mode: c++; c-basic-offset: 4 -*-
2 /*
3  * Copyright (C) 2006 Apple Computer, Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef FrameTree_h
22 #define FrameTree_h
23
24 #include "AtomicString.h"
25 #include "Frame.h"
26
27 namespace WebCore {
28
29     class FrameTree : Noncopyable {
30     public:
31         FrameTree(Frame* thisFrame, Frame* parentFrame) 
32             : m_thisFrame(thisFrame)
33             , m_parent(parentFrame)
34             , m_previousSibling(0)
35             , m_lastChild(0)
36             , m_childCount(0)
37         {
38         }
39         ~FrameTree();
40
41         const AtomicString& name() const { return m_name; }
42         void setName(const AtomicString&);
43         Frame* parent() const { return m_parent; }
44         void setParent(Frame* parent) { m_parent = parent; }
45         
46         Frame* nextSibling() const { return m_nextSibling.get(); }
47         Frame* previousSibling() const { return m_previousSibling; }
48         Frame* firstChild() const { return m_firstChild.get(); }
49         Frame* lastChild() const { return m_lastChild; }
50         unsigned childCount() const { return m_childCount; }
51
52         bool isDescendantOf(const Frame* ancestor) const;
53         Frame* traverseNext(const Frame* stayWithin = 0) const;
54         Frame* traverseNextWithWrap(bool) const;
55         Frame* traversePreviousWithWrap(bool) const;
56         
57         void appendChild(PassRefPtr<Frame>);
58         void removeChild(Frame*);
59
60         Frame* child(unsigned index) const;
61         Frame* child(const AtomicString& name) const;
62         Frame* find(const AtomicString& name) const;
63
64         AtomicString uniqueChildName(const AtomicString& requestedName) const;
65
66         Frame* top() const;
67
68     private:
69         Frame* deepLastChild() const;
70
71         Frame* m_thisFrame;
72
73         Frame* m_parent;
74         AtomicString m_name;
75
76         // FIXME: use ListRefPtr?
77         RefPtr<Frame> m_nextSibling;
78         Frame* m_previousSibling;
79         RefPtr<Frame> m_firstChild;
80         Frame* m_lastChild;
81         unsigned m_childCount;
82     };
83
84 } // namespace WebCore
85
86 #endif // FrameTree_h