Back to index

lightning-sunbird  0.9+nobinonly
nsXULContentUtils.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  *   Chris Waterson <waterson@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   A package of routines shared by the XUL content code.
00042 
00043  */
00044 
00045 #ifndef nsXULContentUtils_h__
00046 #define nsXULContentUtils_h__
00047 
00048 #include "nsISupports.h"
00049 
00050 class nsIAtom;
00051 class nsIContent;
00052 class nsIDocument;
00053 class nsIDOMNodeList;
00054 class nsIRDFNode;
00055 class nsCString;
00056 class nsString;
00057 class nsIRDFResource;
00058 class nsIRDFLiteral;
00059 class nsIRDFService;
00060 class nsINameSpaceManager;
00061 class nsIDateTimeFormat;
00062 
00063 class nsXULContentUtils
00064 {
00065 protected:
00066     static nsrefcnt gRefCnt;
00067     static nsIRDFService* gRDF;
00068     static nsIDateTimeFormat* gFormat;
00069 
00070     static PRBool gDisableXULCache;
00071 
00072     static int PR_CALLBACK
00073     DisableXULCacheChangedCallback(const char* aPrefName, void* aClosure);
00074 
00075 public:
00076     static nsresult
00077     Init();
00078 
00079     static nsresult
00080     Finish();
00081 
00082     static nsresult
00083     FindChildByTag(nsIContent *aElement,
00084                    PRInt32 aNameSpaceID,
00085                    nsIAtom* aTag,
00086                    nsIContent **aResult);
00087 
00088     static nsresult
00089     FindChildByResource(nsIContent* aElement,
00090                         nsIRDFResource* aResource,
00091                         nsIContent** aResult);
00092 
00093     static nsresult
00094     GetElementResource(nsIContent* aElement, nsIRDFResource** aResult);
00095 
00096     static nsresult
00097     GetElementRefResource(nsIContent* aElement, nsIRDFResource** aResult);
00098 
00099     static nsresult
00100     GetTextForNode(nsIRDFNode* aNode, nsAString& aResult);
00101 
00107     static nsresult
00108     MakeElementURI(nsIDocument* aDocument, const nsAString& aElementID, nsCString& aURI);
00109 
00110     static nsresult
00111     MakeElementResource(nsIDocument* aDocument, const nsAString& aElementID, nsIRDFResource** aResult);
00112 
00118     static nsresult
00119     MakeElementID(nsIDocument* aDocument, const nsACString& aURI, nsAString& aElementID);
00120 
00121     static nsresult
00122     GetResource(PRInt32 aNameSpaceID, nsIAtom* aAttribute, nsIRDFResource** aResult);
00123 
00124     static nsresult
00125     GetResource(PRInt32 aNameSpaceID, const nsAString& aAttribute, nsIRDFResource** aResult);
00126 
00127     static nsresult
00128     SetCommandUpdater(nsIDocument* aDocument, nsIContent* aElement);
00129     
00130     static nsIRDFService*
00131     RDFService()
00132     {
00133         return gRDF;
00134     }
00135 
00136 #define XUL_RESOURCE(ident, uri) static nsIRDFResource* ident
00137 #define XUL_LITERAL(ident, val)  static nsIRDFLiteral*  ident
00138 #include "nsXULResourceList.h"
00139 #undef XUL_RESOURCE
00140 #undef XUL_LITERAL
00141 };
00142 
00143 
00144 #endif // nsXULContentUtils_h__
00145