xpcom/ds/nsIProperties.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 /*
  41  * Simple mapping service interface.
  42  * @status FROZEN
  43  */
  44
  45 [scriptable, uuid(78650582-4e93-4b60-8e85-26ebd3eb14ca)]
  46 interface nsIProperties : nsISupports
  47 {
  48     /**
  49      * Gets a property with a given name.
  50      *
  51      * @return NS_ERROR_FAILURE if a property with that name doesn't exist.
  52      * @return NS_ERROR_NO_INTERFACE if the found property fails to QI to the
  53      * given iid.
  54      */
  55     void get(in string prop, in nsIIDRef iid,
  56              [iid_is(iid),retval] out nsQIResult result);
  57
  58     /**
  59      * Sets a property with a given name to a given value.
  60      */
  61     void set(in string prop, in nsISupports value);
  62
  63     /**
  64      * Returns true if the property with the given name exists.
  65      */
  66     boolean has(in string prop);
  67
  68     /**
  69      * Undefines a property.
  70      * @return NS_ERROR_FAILURE if a property with that name doesn't
  71      * already exist.
  72      */
  73     void undefine(in string prop);
  74
  75     /**
  76      *  Returns an array of the keys.
  77      */
  78     void getKeys(out PRUint32 count, [array, size_is(count), retval] out string keys);
  79 };