xpcom/ds/nsIProperties.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 /*
   9  * Simple mapping service interface.
  10  */
  11
  12 [scriptable, uuid(78650582-4e93-4b60-8e85-26ebd3eb14ca)]
  13 interface nsIProperties : nsISupports
  14 {
  15     /**
  16      * Gets a property with a given name.
  17      *
  18      * @throws NS_ERROR_FAILURE if a property with that name doesn't exist.
  19      * @throws NS_ERROR_NO_INTERFACE if the found property fails to QI to the
  20      * given iid.
  21      */
  22     void get(in string prop, in nsIIDRef iid,
  23              [iid_is(iid),retval] out nsQIResult result);
  24
  25     /**
  26      * Sets a property with a given name to a given value.
  27      */
  28     void set(in string prop, in nsISupports value);
  29
  30     /**
  31      * Returns true if the property with the given name exists.
  32      */
  33     boolean has(in string prop);
  34
  35     /**
  36      * Undefines a property.
  37      * @throws NS_ERROR_FAILURE if a property with that name doesn't
  38      * already exist.
  39      */
  40     void undefine(in string prop);
  41
  42     /**
  43      *  Returns an array of the keys.
  44      */
  45     Array<ACString> getKeys();
  46 };