Back to index

lightning-sunbird  0.9+nobinonly
nsIChromeRegistrySea.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the Mozilla browser.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   pav
00025  *   Blake Ross (blaker@netscape.com)
00026  *   Benjamin Smedberg <bsmedberg@covad.net>
00027  *
00028  * Alternatively, the contents of this file may be used under the terms of
00029  * either of the GNU General Public License Version 2 or later (the "GPL"),
00030  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00031  * in which case the provisions of the GPL or the LGPL are applicable instead
00032  * of those above. If you wish to allow use of your version of this file only
00033  * under the terms of either the GPL or the LGPL, and not to allow others to
00034  * use your version of this file under the terms of the MPL, indicate your
00035  * decision by deleting the provisions above and replace them with the notice
00036  * and other provisions required by the GPL or the LGPL. If you do not delete
00037  * the provisions above, a recipient may use your version of this file under
00038  * the terms of any one of the MPL, the GPL or the LGPL.
00039  *
00040  * ***** END LICENSE BLOCK ***** */
00041 
00042 #include "nsISupports.idl"
00043 #include "nsIChromeRegistry.idl"
00044 
00045 [scriptable, uuid(382370d0-a7cd-47ae-aa4e-af74f5edf652)]
00046 interface nsIChromeRegistrySea : nsIXULChromeRegistry
00047 {
00048   /* Applies a skin or locale to all possible packages */
00049   void selectSkin(in ACString skinName, in boolean useProfile);
00050   void selectLocale(in ACString localeName, in boolean useProfile);
00051   void deselectSkin(in ACString skinName, in boolean useProfile);
00052   void deselectLocale(in ACString localeName, in boolean useProfile);
00053   PRInt32 isSkinSelected(in ACString skinName, in boolean useProfile);
00054   PRInt32 isLocaleSelected(in ACString localeName, in boolean useProfile);
00055  
00056   //Special additional APIs for locales and skin.
00057   void selectLocaleForProfile(in ACString localeName, in wstring profilePath);
00058   void selectSkinForProfile(in ACString skinName, in wstring profilePath);
00059 
00060   /* runtimeProvider == true: don't assert the runtime change */
00061   void setRuntimeProvider(in boolean runtimeProvider); 
00062 
00063   boolean checkThemeVersion(in ACString skinName);
00064   boolean checkLocaleVersion(in ACString localeName);
00065 
00066   /* Apply skin/locale to a specific package */
00067   void selectSkinForPackage(in ACString skinName,
00068                             in wstring packageName,
00069                             in boolean useProfile);
00070   
00071   void selectLocaleForPackage(in ACString localeName,
00072                               in wstring packageName,
00073                               in boolean useProfile);
00074   
00075   void deselectSkinForPackage(in ACString skinName,
00076                               in wstring packageName,
00077                               in boolean useProfile);
00078   
00079   void deselectLocaleForPackage(in ACString localeName,
00080                                 in wstring packageName,
00081                                 in boolean useProfile);
00082   
00083   boolean isSkinSelectedForPackage(in ACString skinName,
00084                                    in wstring packageName,
00085                                    in boolean useProfile);
00086   
00087   boolean isLocaleSelectedForPackage(in ACString localeName,
00088                                      in wstring packageName,
00089                                      in boolean useProfile);
00090 
00091   ACString getSelectedSkin(in ACString packageName);
00092 
00093   /* Installation APIs */
00094   void installSkin(in string baseURL,
00095                    in boolean useProfile,
00096                    in boolean allowScripts);
00097   
00098   void uninstallSkin(in ACString skinName, in boolean useProfile);
00099 
00100   void installLocale(in string baseURL, in boolean useProfile);
00101   void uninstallLocale(in ACString localeName, in boolean useProfile);
00102 
00103   void installPackage(in string baseURL, in boolean useProfile);
00104   void uninstallPackage(in ACString packageName, in boolean useProfile);
00105 
00106   /* Whether or not an addon package can dynamically overlay another package. 
00107      You can use these APIs to effectively disable a chrome add-on without
00108      uninstalling it. */
00109   void setAllowOverlaysForPackage(in wstring packageName, in boolean allowOverlays);
00110 };