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) 2000
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Peter Van der Beken <peterv@netscape.com> (original author)
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 /**
40 * Corresponds to http://www.w3.org/TR/2002/WD-DOM-Level-3-XPath-20020208
41 */
42
43 #include "domstubs.idl"
44
45 interface XPathException;
46
47 [scriptable, uuid(75506f84-b504-11d5-a7f2-ca108ab8b6fc)]
48 interface nsIDOMXPathResult : nsISupports
49 {
50 // XPathResultType
51 const unsigned short ANY_TYPE = 0;
52 const unsigned short NUMBER_TYPE = 1;
53 const unsigned short STRING_TYPE = 2;
54 const unsigned short BOOLEAN_TYPE = 3;
55 const unsigned short UNORDERED_NODE_ITERATOR_TYPE = 4;
56 const unsigned short ORDERED_NODE_ITERATOR_TYPE = 5;
57 const unsigned short UNORDERED_NODE_SNAPSHOT_TYPE = 6;
58 const unsigned short ORDERED_NODE_SNAPSHOT_TYPE = 7;
59 const unsigned short ANY_UNORDERED_NODE_TYPE = 8;
60 const unsigned short FIRST_ORDERED_NODE_TYPE = 9;
61
62 readonly attribute unsigned short resultType;
63 readonly attribute double numberValue;
64 // raises(XPathException) on retrieval
65
66 readonly attribute DOMString stringValue;
67 // raises(XPathException) on retrieval
68
69 readonly attribute boolean booleanValue;
70 // raises(XPathException) on retrieval
71
72 readonly attribute nsIDOMNode singleNodeValue;
73 // raises(XPathException) on retrieval
74
75 readonly attribute boolean invalidIteratorState;
76 readonly attribute unsigned long snapshotLength;
77 // raises(XPathException) on retrieval
78
79 nsIDOMNode iterateNext()
80 raises(XPathException,
81 DOMException);
82 nsIDOMNode snapshotItem(in unsigned long index)
83 raises(XPathException);
84 };