content/xbl/src/nsXBLInsertionPoint.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Original Author: David W. Hyatt (hyatt@netscape.com)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsXBLInsertionPoint_h__
  40 #define nsXBLInsertionPoint_h__
  41
  42 #include "nsCOMArray.h"
  43 #include "nsIContent.h"
  44 #include "nsCOMPtr.h"
  45 #include "nsCycleCollectionParticipant.h"
  46
  47 class nsXBLInsertionPoint
  48 {
  49 public:
  50   nsXBLInsertionPoint(nsIContent* aParentElement, PRUint32 aIndex, nsIContent* aDefContent);
  51   ~nsXBLInsertionPoint();
  52
  53   nsrefcnt AddRef()
  54   {
  55     ++mRefCnt;
  56     NS_LOG_ADDREF(this, mRefCnt, "nsXBLInsertionPoint",
  57                   sizeof(nsXBLInsertionPoint));
  58     return mRefCnt;
  59   }
  60
  61   nsrefcnt Release();
  62
  63   NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(nsXBLInsertionPoint)
  64
  65   nsIContent* GetInsertionParent();
  66   void ClearInsertionParent() { mParentElement = nsnull; }
  67
  68   PRInt32 GetInsertionIndex() { return mIndex; }
  69
  70   void SetDefaultContent(nsIContent* aDefaultContent) { mDefaultContent = aDefaultContent; }
  71   nsIContent* GetDefaultContent();
  72
  73   void SetDefaultContentTemplate(nsIContent* aDefaultContent) { mDefaultContentTemplate = aDefaultContent; }
  74   nsIContent* GetDefaultContentTemplate();
  75
  76   void AddChild(nsIContent* aChildElement) { mElements.AppendObject(aChildElement); }
  77   void InsertChildAt(PRInt32 aIndex, nsIContent* aChildElement) { mElements.InsertObjectAt(aChildElement, aIndex); }
  78   void RemoveChild(nsIContent* aChildElement) { mElements.RemoveObject(aChildElement); }
  79
  80   PRInt32 ChildCount() { return mElements.Count(); }
  81
  82   nsIContent* ChildAt(PRUint32 aIndex);
  83
  84   PRBool Matches(nsIContent* aContent, PRUint32 aIndex);
  85
  86   // Unbind all the default content in this insertion point.  Used
  87   // when the insertion parent is going away.
  88   void UnbindDefaultContent();
  89
  90 protected:
  91   nsAutoRefCnt mRefCnt;
  92   nsIContent* mParentElement;            // This ref is weak.  The parent of the <children> element.
  93   PRInt32 mIndex;                        // The index of this insertion point. -1 is a pseudo-point.
  94   nsCOMArray<nsIContent> mElements;      // An array of elements present at the insertion point.
  95   nsCOMPtr<nsIContent> mDefaultContentTemplate ;           // The template default content that will be cloned if
  96                                                            // the insertion point is empty.
  97   nsCOMPtr<nsIContent> mDefaultContent;  // The cloned default content obtained by cloning mDefaultContentTemplate.
  98 };
  99
 100 #endif