xpcom/ds/nsISupportsPrimitives.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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  *   Dan Rosen <dr@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 /* nsISupports wrappers for single primitive pieces of data. */
  40
  41 #include "nsISupports.idl"
  42
  43 /**
  44  * Primitive base interface.
  45  *
  46  * These first three are pointer types and do data copying
  47  * using the nsIMemory. Be careful!
  48  */
  49
  50 [scriptable, uuid(d0d4b136-1dd1-11b2-9371-f0727ef827c0)]
  51 interface nsISupportsPrimitive : nsISupports
  52 {
  53     const unsigned short TYPE_ID                = 1;
  54     const unsigned short TYPE_CSTRING           = 2;
  55     const unsigned short TYPE_STRING            = 3;
  56     const unsigned short TYPE_PRBOOL            = 4;
  57     const unsigned short TYPE_PRUINT8           = 5;
  58     const unsigned short TYPE_PRUINT16          = 6;
  59     const unsigned short TYPE_PRUINT32          = 7;
  60     const unsigned short TYPE_PRUINT64          = 8;
  61     const unsigned short TYPE_PRTIME            = 9;
  62     const unsigned short TYPE_CHAR              = 10;
  63     const unsigned short TYPE_PRINT16           = 11;
  64     const unsigned short TYPE_PRINT32           = 12;
  65     const unsigned short TYPE_PRINT64           = 13;
  66     const unsigned short TYPE_FLOAT             = 14;
  67     const unsigned short TYPE_DOUBLE            = 15;
  68     const unsigned short TYPE_VOID              = 16;
  69     const unsigned short TYPE_INTERFACE_POINTER = 17;
  70
  71     readonly attribute unsigned short type;
  72 };
  73
  74 /**
  75  * Scriptable storage for nsID structures
  76  */
  77
  78 [scriptable, uuid(d18290a0-4a1c-11d3-9890-006008962422)]
  79 interface nsISupportsID : nsISupportsPrimitive
  80 {
  81     attribute nsIDPtr data;
  82     string toString();
  83 };
  84
  85 /**
  86  * Scriptable storage for ASCII strings
  87  */
  88
  89 [scriptable, uuid(d65ff270-4a1c-11d3-9890-006008962422)]
  90 interface nsISupportsCString : nsISupportsPrimitive
  91 {
  92     attribute ACString data;
  93     string toString();
  94 };
  95
  96 /**
  97  * Scriptable storage for Unicode strings
  98  */
  99
 100 [scriptable, uuid(d79dc970-4a1c-11d3-9890-006008962422)]
 101 interface nsISupportsString : nsISupportsPrimitive
 102 {
 103     attribute AString data;
 104     wstring toString();
 105 };
 106
 107 /**
 108  * The rest are truly primitive and are passed by value
 109  */
 110
 111 /**
 112  * Scriptable storage for booleans
 113  */
 114
 115 [scriptable, uuid(ddc3b490-4a1c-11d3-9890-006008962422)]
 116 interface nsISupportsPRBool : nsISupportsPrimitive
 117 {
 118     attribute PRBool data;
 119     string toString();
 120 };
 121
 122 /**
 123  * Scriptable storage for 8-bit integers
 124  */
 125
 126 [scriptable, uuid(dec2e4e0-4a1c-11d3-9890-006008962422)]
 127 interface nsISupportsPRUint8 : nsISupportsPrimitive
 128 {
 129     attribute PRUint8 data;
 130     string toString();
 131 };
 132
 133 /**
 134  * Scriptable storage for unsigned 16-bit integers
 135  */
 136
 137 [scriptable, uuid(dfacb090-4a1c-11d3-9890-006008962422)]
 138 interface nsISupportsPRUint16 : nsISupportsPrimitive
 139 {
 140     attribute PRUint16 data;
 141     string toString();
 142 };
 143
 144 /**
 145  * Scriptable storage for unsigned 32-bit integers
 146  */
 147
 148 [scriptable, uuid(e01dc470-4a1c-11d3-9890-006008962422)]
 149 interface nsISupportsPRUint32 : nsISupportsPrimitive
 150 {
 151     attribute PRUint32 data;
 152     string toString();
 153 };
 154
 155 /**
 156  * Scriptable storage for 64-bit integers
 157  */
 158
 159 [scriptable, uuid(e13567c0-4a1c-11d3-9890-006008962422)]
 160 interface nsISupportsPRUint64 : nsISupportsPrimitive
 161 {
 162     attribute PRUint64 data;
 163     string toString();
 164 };
 165
 166 /**
 167  * Scriptable storage for NSPR date/time values
 168  */
 169
 170 [scriptable, uuid(e2563630-4a1c-11d3-9890-006008962422)]
 171 interface nsISupportsPRTime : nsISupportsPrimitive
 172 {
 173     attribute PRTime data;
 174     string toString();
 175 };
 176
 177 /**
 178  * Scriptable storage for single character values
 179  * (often used to store an ASCII character)
 180  */
 181
 182 [scriptable, uuid(e2b05e40-4a1c-11d3-9890-006008962422)]
 183 interface nsISupportsChar : nsISupportsPrimitive
 184 {
 185     attribute char data;
 186     string toString();
 187 };
 188
 189 /**
 190  * Scriptable storage for 16-bit integers
 191  */
 192
 193 [scriptable, uuid(e30d94b0-4a1c-11d3-9890-006008962422)]
 194 interface nsISupportsPRInt16 : nsISupportsPrimitive
 195 {
 196     attribute PRInt16 data;
 197     string toString();
 198 };
 199
 200 /**
 201  * Scriptable storage for 32-bit integers
 202  */
 203
 204 [scriptable, uuid(e36c5250-4a1c-11d3-9890-006008962422)]
 205 interface nsISupportsPRInt32 : nsISupportsPrimitive
 206 {
 207     attribute PRInt32 data;
 208     string toString();
 209 };
 210
 211 /**
 212  * Scriptable storage for 64-bit integers
 213  */
 214
 215 [scriptable, uuid(e3cb0ff0-4a1c-11d3-9890-006008962422)]
 216 interface nsISupportsPRInt64 : nsISupportsPrimitive
 217 {
 218     attribute PRInt64 data;
 219     string toString();
 220 };
 221
 222 /**
 223  * Scriptable storage for floating point numbers
 224  */
 225
 226 [scriptable, uuid(abeaa390-4ac0-11d3-baea-00805f8a5dd7)]
 227 interface nsISupportsFloat : nsISupportsPrimitive
 228 {
 229     attribute float data;
 230     string toString();
 231 };
 232
 233 /**
 234  * Scriptable storage for doubles
 235  */
 236
 237 [scriptable, uuid(b32523a0-4ac0-11d3-baea-00805f8a5dd7)]
 238 interface nsISupportsDouble : nsISupportsPrimitive
 239 {
 240     attribute double data;
 241     string toString();
 242 };
 243
 244 /**
 245  * Scriptable storage for generic pointers
 246  */
 247
 248 [scriptable, uuid(464484f0-568d-11d3-baf8-00805f8a5dd7)]
 249 interface nsISupportsVoid : nsISupportsPrimitive
 250 {
 251     [noscript] attribute voidPtr data;
 252     string toString();
 253 };
 254
 255 /**
 256  * Scriptable storage for other XPCOM objects
 257  */
 258
 259 [scriptable, uuid(995ea724-1dd1-11b2-9211-c21bdd3e7ed0)]
 260 interface nsISupportsInterfacePointer : nsISupportsPrimitive
 261 {
 262     attribute nsISupports data;
 263     attribute nsIDPtr dataIID;
 264
 265     string toString();
 266 };
 267
 268