Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIPref Interface Reference

import "nsIPref.idl";

Inheritance diagram for nsIPref:
Inheritance graph
[legend]
Collaboration diagram for nsIPref:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void readUserPrefs (in nsIFile aFile)
void ResetPrefs ()
void ResetUserPrefs ()
void savePrefFile (in nsIFile aFile)
nsIPrefBranch getBranch (in string aPrefRoot)
nsIPrefBranch getDefaultBranch (in string aPrefRoot)
long GetPrefType (in string aPrefName)
boolean GetBoolPref (in string aPrefName)
void SetBoolPref (in string aPrefName, in long aValue)
string GetCharPref (in string aPrefName)
void SetCharPref (in string aPrefName, in string aValue)
long GetIntPref (in string aPrefName)
void SetIntPref (in string aPrefName, in long aValue)
void getComplexValue (in string aPrefName, in nsIIDRef aType,[iid_is(aType), retval] out nsQIResult aValue)
void setComplexValue (in string aPrefName, in nsIIDRef aType, in nsISupports aValue)
void ClearUserPref (in string aPrefName)
boolean PrefIsLocked (in string aPrefName)
void lockPref (in string aPrefName)
void unlockPref (in string aPrefName)
void resetBranch (in string aStartingAt)
void DeleteBranch (in string aStartingAt)
void getChildList (in string aStartingAt, out unsigned long aCount,[array, size_is(aCount), retval] out string aChildArray)
void addObserver (in string aDomain, in nsIObserver aObserver, in boolean aHoldWeak)
void removeObserver (in string aDomain, in nsIObserver aObserver)
string CopyCharPref (in string pref)
string CopyDefaultCharPref (in string pref)
boolean GetDefaultBoolPref (in string pref)
long GetDefaultIntPref (in string pref)
void SetDefaultBoolPref (in string pref, in boolean value)
void SetDefaultCharPref (in string pref, in string value)
void SetDefaultIntPref (in string pref, in long value)
wstring CopyUnicharPref (in string pref)
wstring CopyDefaultUnicharPref (in string pref)
void SetUnicharPref (in string pref, in wstring value)
void SetDefaultUnicharPref (in string pref, in wstring value)
wstring getLocalizedUnicharPref (in string pref)
wstring getDefaultLocalizedUnicharPref (in string pref)
nsIFileSpec GetFilePref (in string pref)
void SetFilePref (in string pref, in nsIFileSpec value, in boolean setDefault)
nsILocalFile getFileXPref (in string pref)
void setFileXPref (in string pref, in nsILocalFile value)
void RegisterCallback (in string domain, in PrefChangedFunc callback, in voidPtr closure)
void UnregisterCallback (in string domain, in PrefChangedFunc callback, in voidPtr closure)
void EnumerateChildren (in string parent, in PrefEnumerationFunc callback, in voidPtr data)
 EnumerateChildren.

Public Attributes

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 = (ePrefString | ePrefInt | ePrefBool)
readonly attribute string root

Detailed Description

Definition at line 81 of file nsIPref.idl.


Member Function Documentation

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

Here is the caller graph for this function:

Here is the caller graph for this function:

wstring nsIPref::CopyUnicharPref ( in string  pref)

Here is the caller graph for this function:

void nsIPref::DeleteBranch ( in string  aStartingAt)
void nsIPref::EnumerateChildren ( in string  parent,
in PrefEnumerationFunc  callback,
in voidPtr  data 
)

EnumerateChildren.

Call back function "callback" with every preference string having prefix "parent". Pass "data" to "callback" when calling.

Parameters:
parentA string representation of a prefix of preferences
callbackA function to call back for each matching preference
dataA piece of data to pass on to the callback

Here is the caller graph for this function:

Here is the caller graph for this function:

Here is the caller graph for this function:

void nsIPref::getChildList ( in string  aStartingAt,
out unsigned long  aCount,
[array, size_is(aCount), retval] out string  aChildArray 
)
void nsIPref::getComplexValue ( in string  aPrefName,
in nsIIDRef  aType,
[iid_is(aType), retval] out nsQIResult  aValue 
)

Here is the caller graph for this function:

Here is the caller graph for this function:

void nsIPref::lockPref ( in string  aPrefName)
void nsIPref::RegisterCallback ( in string  domain,
in PrefChangedFunc  callback,
in voidPtr  closure 
)

Here is the caller graph for this function:

void nsIPref::removeObserver ( in string  aDomain,
in nsIObserver  aObserver 
)
void nsIPref::resetBranch ( in string  aStartingAt)
void nsIPref::SetBoolPref ( in string  aPrefName,
in long  aValue 
)

Here is the caller graph for this function:

void nsIPref::SetCharPref ( in string  aPrefName,
in string  aValue 
)

Here is the caller graph for this function:

void nsIPref::setComplexValue ( in string  aPrefName,
in nsIIDRef  aType,
in nsISupports  aValue 
)
void nsIPref::SetDefaultUnicharPref ( in string  pref,
in wstring  value 
)
void nsIPref::SetFilePref ( in string  pref,
in nsIFileSpec  value,
in boolean  setDefault 
)
void nsIPref::SetIntPref ( in string  aPrefName,
in long  aValue 
)

Here is the caller graph for this function:

void nsIPref::SetUnicharPref ( in string  pref,
in wstring  value 
)

Here is the caller graph for this function:

void nsIPref::UnregisterCallback ( in string  domain,
in PrefChangedFunc  callback,
in voidPtr  closure 
)

Here is the caller graph for this function:


Member Data Documentation

Definition at line 135 of file nsIPref.idl.

Definition at line 130 of file nsIPref.idl.

Definition at line 134 of file nsIPref.idl.

Definition at line 127 of file nsIPref.idl.

Definition at line 132 of file nsIPref.idl.

Definition at line 128 of file nsIPref.idl.

Definition at line 131 of file nsIPref.idl.

Definition at line 133 of file nsIPref.idl.

Definition at line 129 of file nsIPref.idl.

Definition at line 136 of file nsIPref.idl.

Definition at line 141 of file nsIPref.idl.


The documentation for this interface was generated from the following file: