rdf/base/idl/nsIRDFLiteral.idl

   1 /* -*- Mode: C++; 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  *
  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 "nsIRDFNode.idl"
  39
  40 %{C++
  41 #include "nscore.h" // for PRUnichar
  42 %}
  43
  44 [ptr] native const_octet_ptr(const PRUint8);
  45
  46 /**
  47  * A literal node in the graph, whose value is a string.
  48  */
  49 [scriptable, uuid(E0C493D2-9542-11d2-8EB8-00805F29F370)]
  50 interface nsIRDFLiteral : nsIRDFNode {
  51     /**
  52      * The Unicode string value of the literal.
  53      */
  54     readonly attribute wstring Value;
  55
  56     /**
  57      * An unscriptable version used to avoid a string copy. Meant
  58      * for use as a performance optimization.
  59      */
  60     [noscript] void GetValueConst([shared] out wstring aConstValue);
  61 };
  62
  63 /**
  64  * A literal node in the graph, whose value is a date
  65  */
  66 [scriptable, uuid(E13A24E1-C77A-11d2-80BE-006097B76B8E)]
  67 interface nsIRDFDate : nsIRDFNode {
  68     /**
  69      * The date value of the literal
  70      */
  71     readonly attribute long long Value;
  72 };
  73
  74 /**
  75  * A literal node in the graph, whose value is an integer
  76  */
  77 [scriptable, uuid(E13A24E3-C77A-11d2-80BE-006097B76B8E)]
  78 interface nsIRDFInt : nsIRDFNode {
  79     /**
  80      * The integer value of the literal
  81      */
  82     readonly attribute long Value;
  83 };
  84
  85 /**
  86  * A literal node in the graph, whose value is arbitrary
  87  * binary data.
  88  */
  89 [scriptable, uuid(237f85a2-1dd2-11b2-94af-8122582fc45e)]
  90 interface nsIRDFBlob : nsIRDFNode {
  91     /**
  92      * The binary data.
  93      */
  94     [noscript] readonly attribute const_octet_ptr value;
  95
  96     /**
  97      * The data's length.
  98      */
  99     readonly attribute long length;
 100 };