Skip to main content

Visit Mozilla.org

nsIPrefService

From MDC


The nsIPrefService interface is the main entry point into the back end preferences management library. The preference service is directly responsible for the management of the preferences files and also facilitates access to the preference branch object which allows the direct manipulation of the preferences themselves.

Contents

nsIPrefService is defined in modules/libpref/public/nsIPrefService.idl. It is scriptable and has been frozen since Mozilla 1.8.

Inherits from: nsISupports

[edit] Method overview

void readUserPrefs(in nsIFile aFile);
void resetPrefs();
void resetUserPrefs();
void savePrefFile(in nsIFile aFile);
nsIPrefBranch getBranch(in string aPrefRoot);
nsIPrefBranch getDefaultBranch(in string aPrefRoot);

[edit] Methods

[edit] readUserPrefs()

Called to read in the preferences specified in a user preference file.

Note: If nsnull is passed in for the aFile parameter the default preferences file(s) [prefs.js, user.js] will be read and processed.
  void readUserPrefs(
     in nsIFile aFile
  );
[edit] Parameters
aFile
The file to be read.

[edit] resetPrefs()

Called to completely flush and re-initialize the preferences system. 

  void resetPrefs();

[edit] resetUserPrefs()

Called to reset all preferences with user set values back to the application default values. 

  void resetUserPrefs();

[edit] savePrefFile()

Called to write current preferences state to a file.

Note: If nsnull is passed in for the aFile parameter the preference data is written out to the current preferences file (usually prefs.js.))
  void savePrefFile(
     in nsIFile aFile
  );
[edit] Parameters
aFile
The file to be written.

[edit] getBranch()

Call to get a Preferences "Branch" which accesses user preference data. Using a Set method on this object will always create or set a user preference value. When using a Get method a user set value will be returned if one exists, otherwise a default value will be returned. 

  nsIPrefBranch getBranch(
     in string aPrefRoot
  );
[edit] Parameters
aPrefRoot
The preference "root" on which to base this "branch". For example, if the root "browser.startup." is used, the branch will be able to easily access the preferences "browser.startup.page", "browser.startup.homepage", or "browser.startup.homepage_override" by simply requesting "page", "homepage", or "homepage_override". nsnull or "" may be used to access to the entire preference "tree".
[edit] Return value

Returns nsIPrefBranch - The object representing the requested branch.

[edit] getDefaultBranch()

Call to get a Preferences "Branch" which accesses only the default preference data. Using a Set method on this object will always create or set a default preference value. When using a Get method a default value will always be returned. 

 nsIPrefBranch getDefaultBranch(
    in string aPrefRoot
 );
[edit] Parameters
aPrefRoot
The preference "root" on which to base this "branch". For example, if the root "browser.startup." is used, the branch will be able to easily access the preferences "browser.startup.page", "browser.startup.homepage", or "browser.startup.homepage_override" by simply requesting "page", "homepage", or "homepage_override". nsnull or "" may be used to access to the entire preference "tree". (Note: Few consumers will want to create default branch objects. Many of the branch methods do nothing on a default branch because the operations only make sense when applied to user set preferences.)
[edit] Return value

Returns nsIPrefBranch - The object representing the requested default branch.

Retrieved from "http://developer.mozilla.org/en/docs/nsIPrefService"