Linux Mac OSX Windows

Implemented by


  
[scriptable, uuid(a22ad7b0-ca86-11d1-a9a4-00805f8a7ac4)]
interface nsIPref : nsISupports

Constants


        
const long ePrefInvalid = 0

        
const long ePrefLocked = 1

        
const long ePrefUserset = 2

        
const long ePrefConfig = 4

        
const long ePrefRemote = 8

        
const long ePrefLilocal = 16

        
const long ePrefString = 32

        
const long ePrefInt = 64

        
const long ePrefBool = 128

        
const long ePrefValuetypeMask = 224

Attributes


        
readonly attribute string root

Methods


        
void addObserver(in string aDomain, in nsIObserver aObserver, in boolean aHoldWeak)

        
void ClearUserPref(in string aPrefName)

        
string CopyCharPref(in string pref)

        
string CopyDefaultCharPref(in string pref)

        
wstring CopyDefaultUnicharPref(in string pref)

        
wstring CopyUnicharPref(in string pref)

        
void DeleteBranch(in string aStartingAt)
 EnumerateChildren

 Call back function "callback" with every preference string
 having prefix "parent". Pass "data" to "callback" when calling.
 
 @param parent A string representation of a prefix of preferences
 @param callback A function to call back for each matching preference
 @param data A piece of data to pass on to the callback
[noscript] void EnumerateChildren(in string parent, in PrefEnumerationFunc callback, in voidPtr data)

        
boolean GetBoolPref(in string aPrefName)

        
nsIPrefBranch getBranch(in string aPrefRoot)

        
string GetCharPref(in string aPrefName)

        
void getChildList(in string aStartingAt, out unsigned long aCount, [array, size_is(aCount), retval] out string aChildArray)

        
void getComplexValue(in string aPrefName, in nsIIDRef aType, [iid_is(aType), retval] out nsQIResult aValue)

        
boolean GetDefaultBoolPref(in string pref)

        
nsIPrefBranch getDefaultBranch(in string aPrefRoot)

        
long GetDefaultIntPref(in string pref)

        
wstring getDefaultLocalizedUnicharPref(in string pref)

        
nsIFileSpec GetFilePref(in string pref)

        
nsILocalFile getFileXPref(in string pref)

        
long GetIntPref(in string aPrefName)

        
wstring getLocalizedUnicharPref(in string pref)

        
long GetPrefType(in string aPrefName)

        
void lockPref(in string aPrefName)

        
boolean PrefIsLocked(in string aPrefName)

        
void readUserPrefs(in nsIFile aFile)

        
[noscript] void RegisterCallback(in string domain, in PrefChangedFunc callback, in voidPtr closure)

        
void removeObserver(in string aDomain, in nsIObserver aObserver)

        
void resetBranch(in string aStartingAt)

        
void ResetPrefs()

        
void ResetUserPrefs()

        
void savePrefFile(in nsIFile aFile)

        
void SetBoolPref(in string aPrefName, in long aValue)

        
void SetCharPref(in string aPrefName, in string aValue)

        
void setComplexValue(in string aPrefName, in nsIIDRef aType, in nsISupports aValue)

        
void SetDefaultBoolPref(in string pref, in boolean value)

        
void SetDefaultCharPref(in string pref, in string value)

        
void SetDefaultIntPref(in string pref, in long value)

        
void SetDefaultUnicharPref(in string pref, in wstring value)

        
void SetFilePref(in string pref, in nsIFileSpec value, in boolean setDefault)

        
void setFileXPref(in string pref, in nsILocalFile value)

        
void SetIntPref(in string aPrefName, in long aValue)

        
void SetUnicharPref(in string pref, in wstring value)

        
void unlockPref(in string aPrefName)

        
[noscript] void UnregisterCallback(in string domain, in PrefChangedFunc callback, in voidPtr closure)