Back to index

lightning-sunbird  0.9+nobinonly
nsIXULDocument.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  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039 
00040   An XUL-specific extension to nsIDocument. Includes methods for
00041   setting the root resource of the document content model, a factory
00042   method for constructing the children of a node, etc.
00043 
00044   XXX This should really be called nsIXULDocument.
00045 
00046  */
00047 
00048 #ifndef nsIXULDocument_h___
00049 #define nsIXULDocument_h___
00050 
00051 #include "nsISupports.h"
00052 #include "nsString.h"
00053 
00054 class nsForwardReference;
00055 class nsIAtom;
00056 class nsIDOMElement;
00057 class nsIPrincipal;
00058 class nsIRDFResource;
00059 class nsISupportsArray;
00060 class nsIXULPrototypeDocument;
00061 class nsIXULTemplateBuilder;
00062 class nsIURI;
00063 class nsIContent;
00064 class nsIRDFDataSource;
00065 
00066 // {954F0811-81DC-11d2-B52A-000000000000}
00067 #define NS_IXULDOCUMENT_IID \
00068 { 0x954f0811, 0x81dc, 0x11d2, { 0xb5, 0x2a, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } }
00069 
00074 class nsIXULDocument : public nsISupports
00075 {
00076 public:
00077   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IXULDOCUMENT_IID)
00078 
00079   // The resource-to-element map is a one-to-many mapping of RDF
00080   // resources to content elements.
00081 
00082   
00085   NS_IMETHOD AddElementForID(const nsAString& aID, nsIContent* aElement) = 0;
00086 
00090   NS_IMETHOD RemoveElementForID(const nsAString& aID, nsIContent* aElement) = 0;
00091 
00097   NS_IMETHOD GetElementsForID(const nsAString& aID, nsISupportsArray* aElements) = 0;
00098 
00103   NS_IMETHOD AddForwardReference(nsForwardReference* aForwardReference) = 0;
00104 
00108   NS_IMETHOD ResolveForwardReferences() = 0;
00109 
00113   NS_IMETHOD SetMasterPrototype(nsIXULPrototypeDocument* aDocument) = 0;
00114 
00118   NS_IMETHOD GetMasterPrototype(nsIXULPrototypeDocument** aPrototypeDocument) = 0;
00119 
00123   NS_IMETHOD SetCurrentPrototype(nsIXULPrototypeDocument* aDocument) = 0;
00124 
00128   NS_IMETHOD AddSubtreeToDocument(nsIContent* aElement) = 0;
00129 
00133   NS_IMETHOD RemoveSubtreeFromDocument(nsIContent* aElement) = 0;
00134 
00140   NS_IMETHOD SetTemplateBuilderFor(nsIContent* aContent, nsIXULTemplateBuilder* aBuilder) = 0;
00141 
00146   NS_IMETHOD GetTemplateBuilderFor(nsIContent* aContent, nsIXULTemplateBuilder** aResult) = 0;
00147 
00153   NS_IMETHOD OnPrototypeLoadDone() = 0;
00154 
00158   NS_IMETHOD OnHide() = 0;
00159 };
00160 
00161 // factory functions
00162 nsresult NS_NewXULDocument(nsIXULDocument** result);
00163 
00164 #endif // nsIXULDocument_h___