WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

fuelIPreferenceBranch

IID:ce697d40-aa5a-11db-abbd-0800200c9a66
Inherits From:nsISupports

Properties

readonly nsIVariant all

Array of fuelIPreference listing all preferences in this branch.

readonly fuelIEvents events

The events object for the preferences supports: "change"

readonly AString root

The name of the branch root.


Methods

fuelIPreference get ( AString name ) nsIVariant getValue ( AString name , nsIVariant defaultValue ) PRBool has ( AString name ) void reset ( ) void setValue ( AString name , nsIVariant value )

fuelIPreference get ( AString name )

Gets an object representing a preference

Arguments:
name: The name of preference

nsIVariant getValue ( AString name , nsIVariant defaultValue )

Gets the value of a preference. Returns a default value if the preference does not exist.

Arguments:
name: The name of preference
defaultValue: The value to return if preference does not exist

PRBool has ( AString name )

Check to see if a preference exists.

Arguments:
name: The name of preference

void reset ( )

Resets all preferences in a branch back to their default values.


void setValue ( AString name , nsIVariant value )

Sets the value of a storage item with the given name.

Arguments:
name: The name of an item
value: The value to assign to the item

References

This interface is the type of the following properties:

fuelIApplication.prefs, fuelIExtension.prefs, fuelIPreference.branch

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com