Back to index

lightning-sunbird  0.9+nobinonly
nsIPrefService.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; 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  *   Alec Flett <alecf@netscape.com>
00024  *   Brian Nesse <bnesse@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsISupports.idl"
00041 #include "nsIPrefBranch.idl"
00042 
00043 interface nsIFile;
00044 
00057 [scriptable, uuid(decb9cc7-c08f-4ea5-be91-a8fc637ce2d2)]
00058 interface nsIPrefService : nsISupports
00059 {
00075   void readUserPrefs(in nsIFile aFile);
00076 
00083   void resetPrefs();
00084 
00091   void resetUserPrefs();
00092 
00108   void savePrefFile(in nsIFile aFile);
00109 
00110 
00129   nsIPrefBranch getBranch(in string aPrefRoot);
00130 
00154   nsIPrefBranch getDefaultBranch(in string aPrefRoot);
00155 
00156 };
00157 
00158 %{C++
00159 
00160 #define NS_PREFSERVICE_CID                             \
00161   { /* {1cd91b88-1dd2-11b2-92e1-ed22ed298000} */       \
00162     0x1cd91b88,                                        \
00163     0x1dd2,                                            \
00164     0x11b2,                                            \
00165     { 0x92, 0xe1, 0xed, 0x22, 0xed, 0x29, 0x80, 0x00 } \
00166   }
00167 
00168 #define NS_PREFSERVICE_CONTRACTID "@mozilla.org/preferences-service;1"
00169 #define NS_PREFSERVICE_CLASSNAME "Preferences Server"
00170 
00174 #define NS_PREFSERVICE_READ_TOPIC_ID "prefservice:before-read-userprefs"
00175 
00180 #define NS_PREFSERVICE_RESET_TOPIC_ID "prefservice:before-reset"
00181 
00182 %}