78b5ca175b71b4afee9c7609b2a42f64d4f595c2
[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., 59 Temple Place - Suite 330,
18  * Boston, MA 02111-1307, USA.
19  */
20
21 #ifndef FRAME_TREE_H
22 #define FRAME_TREE_H
23
24 #include "AtomicString.h"
25
26 namespace WebCore {
27
28     class Frame;
29
30     class FrameTree : Noncopyable {
31     public:
32         FrameTree(Frame* thisFrame, Frame* parentFrame) 
33             : m_thisFrame(thisFrame)
34             , m_parent(parentFrame)
35             , m_previousSibling(0)
36             , m_lastChild(0)
37             , m_childCount(0)
38         {
39         }
40         ~FrameTree();
41
42         const AtomicString& name() const { return m_name; }
43         void setName(const AtomicString&);
44         Frame* parent() const { return m_parent; }
45         void setParent(Frame* parent) { m_parent = parent; }
46         
47         Frame* nextSibling() const { return m_nextSibling.get(); }
48         Frame* previousSibling() const { return m_previousSibling; }
49         Frame* firstChild() const { return m_firstChild.get(); }
50         Frame* lastChild() const { return m_lastChild; }
51         unsigned childCount() const { return m_childCount; }
52
53         bool isDescendantOf(Frame* ancestor) const;
54         Frame* traverseNext(Frame* stayWithin = 0) const;
55         Frame* traverseNextWithWrap(bool) const;
56         Frame* traversePreviousWithWrap(bool) const;
57         
58         void appendChild(PassRefPtr<Frame>);
59         void removeChild(Frame*);
60
61         Frame* child(unsigned index) const;
62         Frame* child(const AtomicString& name) const;
63         Frame* find(const AtomicString& name) const;
64
65         AtomicString uniqueChildName(const AtomicString& requestedName) const;
66
67     private:
68         Frame* deepLastChild() const;
69
70         Frame* m_thisFrame;
71
72         Frame* m_parent;
73         AtomicString m_name;
74
75         // FIXME: use ListRefPtr?
76         RefPtr<Frame> m_nextSibling;
77         Frame* m_previousSibling;
78         RefPtr<Frame> m_firstChild;
79         Frame* m_lastChild;
80         unsigned m_childCount;
81     };
82
83 } // namespace WebCore
84
85 #endif // FRAME_TREE_H