2001-02-14 22:04:26 +00:00
|
|
|
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Netscape Public
|
|
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
|
|
* except in compliance with the License. You may obtain a copy of
|
|
|
|
* the License at http://www.mozilla.org/NPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS
|
|
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
|
|
* implied. See the License for the specific language governing
|
|
|
|
* rights and limitations under the License.
|
|
|
|
*
|
|
|
|
* The Original Code is Mozilla Communicator client code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is Netscape Communications
|
|
|
|
* Corporation. Portions created by Netscape are
|
|
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
|
|
* Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Alec Flett <alecf@netscape.com>
|
|
|
|
* Brian Nesse <bnesse@netscape.com>
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
|
|
|
[scriptable, uuid(56c35506-f14b-11d3-99d3-ddbfac2ccf65)]
|
|
|
|
interface nsIPrefBranch : nsISupports
|
|
|
|
{
|
2001-03-29 00:48:30 +00:00
|
|
|
const long PREF_INVALID = 0;
|
|
|
|
const long PREF_LOCKED = 1;
|
|
|
|
const long PREF_USER_SET = 2;
|
|
|
|
const long PREF_CONFIG = 4;
|
|
|
|
const long PREF_REMOTE = 8;
|
|
|
|
const long PREF_LI_LOCAL = 16;
|
|
|
|
const long PREF_STRING = 32;
|
|
|
|
const long PREF_INT = 64;
|
|
|
|
const long PREF_BOOL = 128;
|
|
|
|
const long PREF_VALUE_TYPE_MASK = (PREF_STRING | PREF_INT | PREF_BOOL);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* the root of this branch, such as "browser."
|
|
|
|
*/
|
|
|
|
readonly attribute string root;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* standard methods for accessing preferences
|
|
|
|
*/
|
2001-03-22 23:34:41 +00:00
|
|
|
long getPrefType(in string aPrefName);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
2001-03-22 23:34:41 +00:00
|
|
|
boolean getBoolPref(in string aPrefName);
|
|
|
|
void setBoolPref(in string aPrefName, in long aValue);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
2001-03-22 23:34:41 +00:00
|
|
|
string getCharPref(in string aPrefName);
|
|
|
|
void setCharPref(in string aPrefName, in string aValue);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
2001-03-22 23:34:41 +00:00
|
|
|
long getIntPref(in string aPrefName);
|
|
|
|
void setIntPref(in string aPrefName, in long aValue);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* methods for accessing complex preferences (i.e. items beyond the simple bool, char, and int)
|
|
|
|
*/
|
2001-03-22 23:34:41 +00:00
|
|
|
void getComplexValue(in string aPrefName, in nsIIDRef aType, [iid_is(aType), retval] out nsQIResult aValue);
|
|
|
|
void setComplexValue(in string aPrefName, in nsIIDRef aType, in nsISupports aValue);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* methods for preference state manipulation
|
|
|
|
*/
|
2001-03-22 23:34:41 +00:00
|
|
|
void clearUserPref(in string aPrefName);
|
|
|
|
void lockPref(in string aPrefName);
|
|
|
|
boolean prefIsLocked(in string aPrefName);
|
|
|
|
void unlockPref(in string aPrefName);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
* branch-level operations
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* deleteBranch
|
|
|
|
*
|
|
|
|
* removes all preferences starting at the given preference prefix
|
|
|
|
* pass in null or "" to remove this branch
|
|
|
|
*/
|
2001-03-22 23:34:41 +00:00
|
|
|
void deleteBranch(in string aStartingAt);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* getChildList
|
|
|
|
*
|
|
|
|
* Returns an array of strings representing the child preferences of the branch root
|
|
|
|
*
|
|
|
|
* @param startingAt pass in null or "" to enumerate the entire branch
|
|
|
|
* @param count Receives the number of elements in the array.
|
|
|
|
* @param childArray Receives the array of child preferences.
|
|
|
|
*/
|
2001-03-22 23:34:41 +00:00
|
|
|
void getChildList(in string aStartingAt,
|
|
|
|
out unsigned long aCount,
|
|
|
|
[array, size_is(aCount), retval] out string aChildArray);
|
2001-02-14 22:04:26 +00:00
|
|
|
|
|
|
|
/*
|
2001-03-29 00:48:30 +00:00
|
|
|
* resetBranch
|
|
|
|
*
|
|
|
|
* clears all user preferences starting at the given preference prefix
|
|
|
|
* pass in null or "" to clear this branch
|
2001-02-14 22:04:26 +00:00
|
|
|
*/
|
2001-03-29 00:48:30 +00:00
|
|
|
void resetBranch(in string aStartingAt);
|
2001-03-22 23:34:41 +00:00
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
%{C++
|
|
|
|
|
|
|
|
#define NS_PREFBRANCH_CONTRACTID "@mozilla.org/preferencesbranch;1"
|
|
|
|
#define NS_PREFBRANCH_CLASSNAME "Preferences Branch"
|
|
|
|
|
|
|
|
%}
|