Back to index

lightning-sunbird  0.9+nobinonly
nsIXBLService.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 /*
00040 
00041   Private interface to the XBL service
00042 
00043 */
00044 
00045 #ifndef nsIXBLService_h__
00046 #define nsIXBLService_h__
00047 
00048 #include "nsISupports.h"
00049 
00050 class nsIContent;
00051 class nsIDocument;
00052 class nsIDOMEventReceiver;
00053 class nsIDOMNodeList;
00054 class nsXBLBinding;
00055 class nsIXBLDocumentInfo;
00056 class nsIURI;
00057 class nsIAtom;
00058 
00059 #define NS_IXBLSERVICE_IID \
00060 { 0x0b2e5289, 0xe7d8, 0x41f8, { 0x85, 0xa2, 0x8a, 0x57, 0x0b, 0x25, 0xf4, 0x95 } }
00061 
00062 class nsIXBLService : public nsISupports
00063 {
00064 public:
00065   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IXBLSERVICE_IID)
00066 
00067   // This function loads a particular XBL file and installs all of the bindings
00068   // onto the element.
00069   NS_IMETHOD LoadBindings(nsIContent* aContent, nsIURI* aURL, PRBool aAugmentFlag,
00070                           nsXBLBinding** aBinding, PRBool* aResolveStyle) = 0;
00071 
00072   // Indicates whether or not a binding is fully loaded.
00073   NS_IMETHOD BindingReady(nsIContent* aBoundElement, nsIURI* aURI, PRBool* aIsReady) = 0;
00074 
00075   // Retrieves our base class (e.g., tells us what type of frame and content node to build)
00076   NS_IMETHOD ResolveTag(nsIContent* aContent, PRInt32* aNameSpaceID, nsIAtom** aResult) = 0;
00077 
00078   // This method checks the hashtable and then calls FetchBindingDocument on a miss.
00079   NS_IMETHOD LoadBindingDocumentInfo(nsIContent* aBoundElement, nsIDocument* aBoundDocument,
00080                                      nsIURI* aBindingURI,
00081                                      PRBool aForceSyncLoad, nsIXBLDocumentInfo** aResult) = 0;
00082 
00083   // Hooks up the global key and DragDrop event handlers to the document root.
00084   NS_IMETHOD AttachGlobalKeyHandler(nsIDOMEventReceiver* aElement)=0;
00085   NS_IMETHOD AttachGlobalDragHandler(nsIDOMEventReceiver* aElement)=0;
00086   
00087 };
00088 
00089 #endif // nsIXBLService_h__