Back to index

lightning-sunbird  0.9+nobinonly
nsXBLInsertionPoint.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator client code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Original Author: David W. Hyatt (hyatt@netscape.com)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsXBLInsertionPoint_h__
00040 #define nsXBLInsertionPoint_h__
00041 
00042 #include "nsCOMArray.h"
00043 #include "nsIContent.h"
00044 #include "nsCOMPtr.h"
00045 
00046 class nsXBLInsertionPoint
00047 {
00048 public:
00049   nsXBLInsertionPoint(nsIContent* aParentElement, PRUint32 aIndex, nsIContent* aDefContent);
00050   ~nsXBLInsertionPoint();
00051 
00052   nsrefcnt AddRef()
00053   {
00054     ++mRefCnt;
00055     NS_LOG_ADDREF(this, mRefCnt, "nsXBLInsertionPoint",
00056                   sizeof(nsXBLInsertionPoint));
00057     return mRefCnt;
00058   }
00059 
00060   nsrefcnt Release();
00061 
00062   already_AddRefed<nsIContent> GetInsertionParent();
00063   PRInt32 GetInsertionIndex() { return mIndex; }
00064 
00065   void SetDefaultContent(nsIContent* aDefaultContent) { mDefaultContent = aDefaultContent; }
00066   already_AddRefed<nsIContent> GetDefaultContent();
00067 
00068   void SetDefaultContentTemplate(nsIContent* aDefaultContent) { mDefaultContentTemplate = aDefaultContent; }
00069   already_AddRefed<nsIContent> GetDefaultContentTemplate();
00070 
00071   void AddChild(nsIContent* aChildElement) { mElements.AppendObject(aChildElement); }
00072   void InsertChildAt(PRInt32 aIndex, nsIContent* aChildElement) { mElements.InsertObjectAt(aChildElement, aIndex); }
00073   void RemoveChild(nsIContent* aChildElement) { mElements.RemoveObject(aChildElement); }
00074   
00075   PRInt32 ChildCount() { return mElements.Count(); }
00076 
00077   already_AddRefed<nsIContent> ChildAt(PRUint32 aIndex);
00078 
00079   PRBool Matches(nsIContent* aContent, PRUint32 aIndex);
00080 
00081 protected:
00082   nsAutoRefCnt mRefCnt;
00083   nsIContent* mParentElement;            // This ref is weak.  The parent of the <children> element.
00084   PRInt32 mIndex;                        // The index of this insertion point. -1 is a pseudo-point.
00085   nsCOMArray<nsIContent> mElements;      // An array of elements present at the insertion point.
00086   nsCOMPtr<nsIContent> mDefaultContentTemplate ;           // The template default content that will be cloned if
00087                                                            // the insertion point is empty.
00088   nsCOMPtr<nsIContent> mDefaultContent;  // The cloned default content obtained by cloning mDefaultContentTemplate.
00089 };
00090 
00091 #endif