WebCore/page/FrameTree.h

   1 /*
   2  * Copyright (C) 2006 Apple Computer, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public License
  15  * along with this library; see the file COPYING.LIB.  If not, write to
  16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef FrameTree_h
  21 #define FrameTree_h
  22
  23 #include "AtomicString.h"
  24
  25 namespace WebCore {
  26
  27     class Frame;
  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         void clearName();
  44         Frame* parent(bool checkForDisconnectedFrame = false) const;
  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(const Frame* ancestor) const;
  54         Frame* traverseNext(const Frame* stayWithin = 0) const;
  55         Frame* traverseNextWithWrap(bool) const;
  56         Frame* traversePreviousWithWrap(bool) const;
  57
  58         void appendChild(PassRefPtr<Frame>);
  59         void detachFromParent() { m_parent = 0; }
  60         void removeChild(Frame*);
  61
  62         Frame* child(unsigned index) const;
  63         Frame* child(const AtomicString& name) const;
  64         Frame* find(const AtomicString& name) const;
  65
  66         AtomicString uniqueChildName(const AtomicString& requestedName) const;
  67
  68         Frame* top(bool checkForDisconnectedFrame = false) const;
  69
  70     private:
  71         Frame* deepLastChild() const;
  72
  73         Frame* m_thisFrame;
  74
  75         Frame* m_parent;
  76         AtomicString m_name;
  77
  78         // FIXME: use ListRefPtr?
  79         RefPtr<Frame> m_nextSibling;
  80         Frame* m_previousSibling;
  81         RefPtr<Frame> m_firstChild;
  82         Frame* m_lastChild;
  83         unsigned m_childCount;
  84     };
  85
  86 } // namespace WebCore
  87
  88 #endif // FrameTree_h