Public Member Functions | Public Attributes

extIPreference Interface Reference

Interface for accessing a single preference. More...

import "extIApplication.idl";

Collaboration diagram for extIPreference:

List of all members.

Public Member Functions

NS_SCRIPTABLE NS_IMETHOD GetName (nsAString &aName)=0
 Interface for accessing a single preference.
NS_SCRIPTABLE NS_IMETHOD GetType (nsAString &aType)=0
 A string representing the type of preference (String, Boolean, or Number).
NS_SCRIPTABLE NS_IMETHOD GetValue (nsIVariant **aValue)=0
 Get/Set the value of the preference.
NS_SCRIPTABLE NS_IMETHOD SetValue (nsIVariant *aValue)=0
NS_SCRIPTABLE NS_IMETHOD GetLocked (PRBool *aLocked)=0
 Get the locked state of the preference.
NS_SCRIPTABLE NS_IMETHOD SetLocked (PRBool aLocked)=0
NS_SCRIPTABLE NS_IMETHOD GetModified (PRBool *aModified)=0
 Check if a preference has been modified by the user, or not.
NS_SCRIPTABLE NS_IMETHOD GetBranch (extIPreferenceBranch **aBranch)=0
 The preference branch that contains this preference.
NS_SCRIPTABLE NS_IMETHOD GetEvents (extIEvents **aEvents)=0
 The events object for this preference.
NS_SCRIPTABLE NS_IMETHOD Reset (void)=0
 Resets a preference back to its default values.
void reset ()
 Resets a preference back to its default values.

Public Attributes

readonly attribute AString name
 The name of the preference.
readonly attribute AString type
 A string representing the type of preference (String, Boolean, or Number).
attribute nsIVariant value
 Get/Set the value of the preference.
attribute boolean locked
 Get the locked state of the preference.
readonly attribute boolean modified
 Check if a preference has been modified by the user, or not.
readonly attribute
extIPreferenceBranch 
branch
 The preference branch that contains this preference.
readonly attribute extIEvents events
 The events object for this preference.

Detailed Description

Interface for accessing a single preference.

The data is not cached. All reads access the current state of the preference.


Member Function Documentation

NS_SCRIPTABLE NS_IMETHOD extIPreference::GetBranch ( extIPreferenceBranch **  aBranch  )  [pure virtual]

The preference branch that contains this preference.

NS_SCRIPTABLE NS_IMETHOD extIPreference::GetEvents ( extIEvents **  aEvents  )  [pure virtual]

The events object for this preference.

supports: "change"

NS_SCRIPTABLE NS_IMETHOD extIPreference::GetLocked ( PRBool aLocked  )  [pure virtual]

Get the locked state of the preference.

Set to a boolean value to (un)lock it.

NS_SCRIPTABLE NS_IMETHOD extIPreference::GetModified ( PRBool aModified  )  [pure virtual]

Check if a preference has been modified by the user, or not.

NS_SCRIPTABLE NS_IMETHOD extIPreference::GetName ( nsAString aName  )  [pure virtual]

Interface for accessing a single preference.

The data is not cached. All reads access the current state of the preference. The name of the preference.

NS_SCRIPTABLE NS_IMETHOD extIPreference::GetType ( nsAString aType  )  [pure virtual]

A string representing the type of preference (String, Boolean, or Number).

NS_SCRIPTABLE NS_IMETHOD extIPreference::GetValue ( nsIVariant **  aValue  )  [pure virtual]

Get/Set the value of the preference.

void extIPreference::reset (  ) 

Resets a preference back to its default values.

NS_SCRIPTABLE NS_IMETHOD extIPreference::Reset ( void   )  [pure virtual]

Resets a preference back to its default values.

NS_SCRIPTABLE NS_IMETHOD extIPreference::SetLocked ( PRBool  aLocked  )  [pure virtual]
NS_SCRIPTABLE NS_IMETHOD extIPreference::SetValue ( nsIVariant aValue  )  [pure virtual]

Member Data Documentation

The preference branch that contains this preference.

readonly attribute extIEvents extIPreference::events

The events object for this preference.

supports: "change"

Get the locked state of the preference.

Set to a boolean value to (un)lock it.

readonly attribute boolean extIPreference::modified

Check if a preference has been modified by the user, or not.

readonly attribute AString extIPreference::name

The name of the preference.

readonly attribute AString extIPreference::type

A string representing the type of preference (String, Boolean, or Number).

Get/Set the value of the preference.


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