Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsISecurityPref Interface Reference

Interface for accessing preferences, bypassing the usual security check on preferences starting with "capability". More...

import "nsISecurityPref.idl";

Inheritance diagram for nsISecurityPref:
Inheritance graph
[legend]
Collaboration diagram for nsISecurityPref:
Collaboration graph
[legend]

List of all members.

Public Member Functions

boolean securityGetBoolPref (in string pref)
 Called to get the state of a "capability" boolean preference.
void securitySetBoolPref (in string pref, in boolean value)
 Called to set the state of a "capability" boolean preference.
string securityGetCharPref (in string pref)
 Called to get the state of a "capability" string preference.
void securitySetCharPref (in string pref, in string value)
 Called to set the state of a "capability" string preference.
long securityGetIntPref (in string pref)
 Called to get the state of a "capability" integer preference.
void securitySetIntPref (in string pref, in long value)
 Called to set the state of a "capability" integer preference.
void securityClearUserPref (in string pref_name)
 Called to clear a user set value from a "capability" preference.

Detailed Description

Interface for accessing preferences, bypassing the usual security check on preferences starting with "capability".

This interface is used by nsScriptSecurityManager which needs unchecked access to security prefs. PLEASE do not call this interface from any other file, as this would be insecure.

THIS INTERFACE SHOULD NEVER BE MADE SCRIPTABLE

See also:
nsIPrefBranch

Definition at line 53 of file nsISecurityPref.idl.


Member Function Documentation

Called to clear a user set value from a "capability" preference.

This will, in effect, reset the value to the default value. If no default value exists the preference will cease to exist.

Parameters:
pref_nameThe preference to be cleared.
Note:
This method does nothing if this object is a default branch.
Returns:
NS_OK The user preference was successfully cleared.
Other The preference does not exist or have a user set value.

Called to get the state of a "capability" boolean preference.

Parameters:
prefThe boolean preference to get the state of.
Returns:
boolean The value of the requested boolean preference.
See also:
securitySetBoolPref

Called to get the state of a "capability" string preference.

Parameters:
prefThe string preference to retrieve.
Returns:
string The value of the requested string preference.
See also:
securitySetCharPref

Called to get the state of a "capability" integer preference.

Parameters:
prefThe integer preference to get the value of.
Returns:
long The value of the requested integer preference.
See also:
securitySetIntPref

Called to set the state of a "capability" boolean preference.

Parameters:
prefThe boolean preference to set the state of.
valueThe boolean value to set the preference to.
Returns:
NS_OK The value was successfully set.
Other The value was not set or is the wrong type.
See also:
securityGetBoolPref

Called to set the state of a "capability" string preference.

Parameters:
prefThe string preference to set.
valueThe string value to set the preference to.
Returns:
NS_OK The value was successfully set.
Other The value was not set or is the wrong type.
See also:
securityGetCharPref

Called to set the state of a "capability" integer preference.

Parameters:
prefThe integer preference to set the value of.
valueThe integer value to set the preference to.
Returns:
NS_OK The value was successfully set.
Other The value was not set or is the wrong type.
See also:
securityGetIntPref

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