Logo Search packages:      
Sourcecode: xulrunner version File versions  Download package

nsIPrefBranch Interface Reference

import "nsIPrefBranch.idl";

Inheritance diagram for nsIPrefBranch:

nsISupports nsIPrefBranch2 nsIPrefBranchInternal

List of all members.

Detailed Description

The nsIPrefBranch interface is used to manipulate the preferences data. This object may be obtained from the preferences service (nsIPrefService) and used to get and set default and/or user preferences across the application.

This object is created with a "root" value which describes the base point in the preferences "tree" from which this "branch" stems. Preferences are accessed off of this root by using just the final portion of the preference. For example, if this object is created with the root "browser.startup.", the preferences "browser.startup.page", "browser.startup.homepage", and "browser.startup.homepage_override" can be accessed by simply passing "page", "homepage", or "homepage_override" to the various Get/Set methods.

See also:

Definition at line 61 of file nsIPrefBranch.idl.

Public Member Functions

void clearUserPref (in string aPrefName)
void deleteBranch (in string aStartingAt)
boolean getBoolPref (in string aPrefName)
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)
long getIntPref (in string aPrefName)
long getPrefType (in string aPrefName)
void lockPref (in string aPrefName)
boolean prefHasUserValue (in string aPrefName)
boolean prefIsLocked (in string aPrefName)
void resetBranch (in string aStartingAt)
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 setIntPref (in string aPrefName, in long aValue)
void unlockPref (in string aPrefName)
 NS_IMETHOD_ (nsrefcnt) Release(void)=0
 NS_IMETHOD_ (nsrefcnt) AddRef(void)=0
NS_IMETHOD QueryInterface (REFNSIID aIID, void **aInstancePtr)=0

Public Attributes

const long PREF_BOOL = 128
const long PREF_INT = 64
const long PREF_INVALID = 0
const long PREF_STRING = 32
readonly attribute string root

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

Generated by  Doxygen 1.6.0   Back to index