Preferences System:preferences

From MDC

Contents 1 Overview 2 XUL Syntax 3 Methods 4 Fields

[edit] Overview

<preferences> is a container for <preference> elements. It's supposed to be a child of <prefpane> element.

<preferences> element should contain one or more <preference> elements.

Note: it's not clear which of the following methods and properties are public.

[edit] XUL Syntax

<preferences>
  <preference id="pref_one" name="extensions.myextension.one" type="bool"/>
  <preference id="pref_two" name="extensions.myextension.two" type="string"/>
    ... etc ...
</preferences>

[edit] Methods

void fireChangedEvent(in DOMElement preference); 

Creates and dispatches a changed (non-bubbling) event to the specified preference element. Also executes code specified in onchanged attribute of the element. See also the description of change event of <preference>.

void observe(in nsISupports aSubject, in string aTopic, in wstring aData); 

nsIObserver method used internally to react to changes to preferences listed as children of this element.

[edit] Fields

attribute nsIPrefService service; 

The preferences service.

attribute nsIPrefBranch rootBranch; 

The root prefs branch.

attribute nsIPrefBranch defaultBranch; 

The root branch of the tree with default values.

attribute nsIPrefBranch2 rootBranchInternal; 

The root prefs branch (nsIPrefBranch2).