xpcom/ds/nsIPropertyBag2.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is mozilla.org property bag support.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Christian Biesinger <cbiesinger@web.de>.
  18  * Portions created by the Initial Developer are Copyright (C) 2005
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *    Darin Fisher <darin@meer.net>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * 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 /* nsIVariant based Property Bag support. */
  39
  40 #include "nsIPropertyBag.idl"
  41
  42 [scriptable, uuid(625cfd1e-da1e-4417-9ee9-dbc8e0b3fd79)]
  43 interface nsIPropertyBag2 : nsIPropertyBag
  44 {
  45   // Accessing a property as a different type may attempt conversion to the
  46   // requested value
  47
  48   PRInt32     getPropertyAsInt32       (in AString prop);
  49   PRUint32    getPropertyAsUint32      (in AString prop);
  50   PRInt64     getPropertyAsInt64       (in AString prop);
  51   PRUint64    getPropertyAsUint64      (in AString prop);
  52   double      getPropertyAsDouble      (in AString prop);
  53   AString     getPropertyAsAString     (in AString prop);
  54   ACString    getPropertyAsACString    (in AString prop);
  55   AUTF8String getPropertyAsAUTF8String (in AString prop);
  56   boolean     getPropertyAsBool        (in AString prop);
  57
  58   /**
  59    * This method returns null if the value exists, but is null.
  60    */
  61   void        getPropertyAsInterface   (in AString prop,
  62                                         in nsIIDRef iid,
  63                                         [iid_is(iid), retval] out nsQIResult result);
  64
  65   /**
  66    * This method returns null if the value does not exist,
  67    * or exists but is null.
  68    */
  69   nsIVariant  get                      (in AString prop);
  70
  71   /**
  72    * Check for the existence of a key.
  73    */
  74   PRBool      hasKey                   (in AString prop);
  75 };