mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 06:35:42 +00:00
148 lines
4.2 KiB
C++
148 lines
4.2 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape Public
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
* implied. See the License for the specific language governing
|
|
* rights and limitations under the License.
|
|
*
|
|
* The Original Code is Mozilla Communicator client code.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape Communications
|
|
* Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
#ifndef nsFrameList_h___
|
|
#define nsFrameList_h___
|
|
|
|
#include "nsIFrame.h"
|
|
|
|
/**
|
|
* A class for managing a singly linked list of frames. Frames are
|
|
* linked together through their next-sibling pointer.
|
|
*/
|
|
class nsFrameList {
|
|
public:
|
|
nsFrameList() {
|
|
mFirstChild = nsnull;
|
|
}
|
|
|
|
nsFrameList(nsIFrame* aHead) {
|
|
mFirstChild = aHead;
|
|
}
|
|
|
|
~nsFrameList() {
|
|
}
|
|
|
|
void DestroyFrames(nsIPresContext* aPresContext);
|
|
|
|
void SetFrames(nsIFrame* aFrameList) {
|
|
mFirstChild = aFrameList;
|
|
}
|
|
|
|
void AppendFrames(nsIFrame* aParent, nsIFrame* aFrameList);
|
|
|
|
void AppendFrames(nsIFrame* aParent, nsFrameList& aFrameList) {
|
|
AppendFrames(aParent, aFrameList.mFirstChild);
|
|
aFrameList.mFirstChild = nsnull;
|
|
}
|
|
|
|
void AppendFrame(nsIFrame* aParent, nsIFrame* aFrame);
|
|
|
|
// Take aFrame out of the frame list. This also disconnects aFrame
|
|
// from the sibling list. This will return PR_FALSE if aFrame is
|
|
// nsnull or if aFrame is not in the list.
|
|
PRBool RemoveFrame(nsIFrame* aFrame);
|
|
|
|
// Remove the first child from the list. The caller is assumed to be
|
|
// holding a reference to the first child. This call is equivalent
|
|
// in behavior to calling RemoveFrame(FirstChild()).
|
|
PRBool RemoveFirstChild();
|
|
|
|
// Take aFrame out of the frame list and then destroy it. This also
|
|
// disconnects aFrame from the sibling list. This will return
|
|
// PR_FALSE if aFrame is nsnull or if aFrame is not in the list.
|
|
PRBool DestroyFrame(nsIPresContext* aPresContext, nsIFrame* aFrame);
|
|
|
|
void InsertFrame(nsIFrame* aParent,
|
|
nsIFrame* aPrevSibling,
|
|
nsIFrame* aNewFrame);
|
|
|
|
void InsertFrames(nsIFrame* aParent,
|
|
nsIFrame* aPrevSibling,
|
|
nsIFrame* aFrameList);
|
|
|
|
void InsertFrames(nsIFrame* aParent, nsIFrame* aPrevSibling,
|
|
nsFrameList& aFrameList) {
|
|
InsertFrames(aParent, aPrevSibling, aFrameList.FirstChild());
|
|
aFrameList.mFirstChild = nsnull;
|
|
}
|
|
|
|
PRBool ReplaceFrame(nsIFrame* aParent,
|
|
nsIFrame* aOldFrame,
|
|
nsIFrame* aNewFrame);
|
|
|
|
PRBool ReplaceAndDestroyFrame(nsIPresContext* aPresContext,
|
|
nsIFrame* aParent,
|
|
nsIFrame* aOldFrame,
|
|
nsIFrame* aNewFrame);
|
|
|
|
PRBool Split(nsIFrame* aAfterFrame, nsIFrame** aNextFrameResult);
|
|
|
|
nsIFrame* PullFrame(nsIFrame* aParent,
|
|
nsIFrame* aLastChild,
|
|
nsFrameList& aFromList);
|
|
|
|
nsIFrame* FirstChild() const {
|
|
return mFirstChild;
|
|
}
|
|
|
|
nsIFrame* LastChild() const;
|
|
|
|
nsIFrame* FrameAt(PRInt32 aIndex) const;
|
|
|
|
PRBool IsEmpty() const {
|
|
return nsnull == mFirstChild;
|
|
}
|
|
|
|
PRBool NotEmpty() const {
|
|
return nsnull != mFirstChild;
|
|
}
|
|
|
|
PRBool ContainsFrame(const nsIFrame* aFrame) const;
|
|
|
|
PRInt32 GetLength() const;
|
|
|
|
nsIFrame* GetPrevSiblingFor(nsIFrame* aFrame) const;
|
|
|
|
#ifdef IBMBIDI
|
|
/**
|
|
* Return the frame before this frame in visual order (after Bidi reordering)
|
|
*/
|
|
nsIFrame* GetPrevVisualFor(nsIFrame* aFrame) const;
|
|
|
|
/**
|
|
* Return the frame after this frame in visual order (after Bidi reordering)
|
|
*/
|
|
nsIFrame* GetNextVisualFor(nsIFrame* aFrame) const;
|
|
#endif // IBMBIDI
|
|
|
|
void VerifyParent(nsIFrame* aParent) const;
|
|
|
|
#ifdef NS_DEBUG
|
|
void List(nsIPresContext* aPresContext, FILE* out) const;
|
|
#endif
|
|
|
|
protected:
|
|
nsIFrame* mFirstChild;
|
|
};
|
|
|
|
#endif /* nsFrameList_h___ */
|