michael@0: /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: 
michael@0: /*
michael@0:  * Simple mapping service interface.
michael@0:  */
michael@0: 
michael@0: [scriptable, uuid(78650582-4e93-4b60-8e85-26ebd3eb14ca)]
michael@0: interface nsIProperties : nsISupports
michael@0: {
michael@0:     /**
michael@0:      * Gets a property with a given name. 
michael@0:      *
michael@0:      * @throws NS_ERROR_FAILURE if a property with that name doesn't exist.
michael@0:      * @throws NS_ERROR_NO_INTERFACE if the found property fails to QI to the 
michael@0:      * given iid.
michael@0:      */
michael@0:     void get(in string prop, in nsIIDRef iid, 
michael@0:              [iid_is(iid),retval] out nsQIResult result);
michael@0: 
michael@0:     /**
michael@0:      * Sets a property with a given name to a given value. 
michael@0:      */
michael@0:     void set(in string prop, in nsISupports value);
michael@0: 
michael@0:     /**
michael@0:      * Returns true if the property with the given name exists.
michael@0:      */
michael@0:     boolean has(in string prop);
michael@0: 
michael@0:     /**
michael@0:      * Undefines a property.
michael@0:      * @throws NS_ERROR_FAILURE if a property with that name doesn't
michael@0:      * already exist.
michael@0:      */
michael@0:     void undefine(in string prop);
michael@0: 
michael@0:     /**
michael@0:      *  Returns an array of the keys.
michael@0:      */
michael@0:     void getKeys(out uint32_t count, [array, size_is(count), retval] out string keys);
michael@0: };