Reviewed by Darin.
[WebKit-https.git] / WebCore / page / FrameTreeNode.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_NODE_H
22 #define FRAME_TREE_NODE_H
23
24 #include <kxmlcore/RefPtr.h>
25 #include <kxmlcore/PassRefPtr.h>
26 #include "dom_string.h"
27
28 namespace WebCore {
29
30 class Frame;
31
32 class FrameTreeNode
33 {
34 public:
35     FrameTreeNode(Frame* thisFrame, Frame* parentFrame) 
36         : m_thisFrame(thisFrame)
37         , m_parent(parentFrame)
38         , m_previousSibling(0)
39         , m_lastChild(0)
40         , m_childCount(0)
41     {
42     }
43     ~FrameTreeNode();
44
45     DOMString& name() { return m_name; }
46     void setName(const DOMString& name);
47     Frame* parent() { return m_parent; }
48     void setParent(Frame* parent) { m_parent = parent; }
49     
50     Frame* nextSibling() { return m_nextSibling.get(); }
51     Frame* previousSibling() { return m_previousSibling; }
52     Frame* firstChild() { return m_firstChild.get(); }
53     Frame* lastChild() { return m_lastChild; }
54     int childCount() { return m_childCount; }
55
56     void appendChild(PassRefPtr<Frame> child);
57     void removeChild(Frame *child);
58
59  private:
60     Frame* m_thisFrame;
61
62     Frame *m_parent;
63     DOMString m_name;
64
65     // FIXME: use ListRefPtr?
66     RefPtr<Frame> m_nextSibling;
67     Frame* m_previousSibling;
68     RefPtr<Frame> m_firstChild;
69     Frame* m_lastChild;
70     int m_childCount;
71
72     // uncopyable
73     FrameTreeNode(const FrameTreeNode&);
74     FrameTreeNode& operator=(const FrameTreeNode&);
75 };
76
77 }
78
79 #endif // FRAME_TREE_NODE_H