551336e3144ad96e510a7585af53cb0f72898103
[WebKit-https.git] / Source / WebCore / xml / XPathResult.idl
1 /*
2  * Copyright (C) 2006 Apple Computer, Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 module xpath {
21
22     interface [
23         Conditional=XPATH,
24         CustomMarkFunction
25     ] XPathResult {
26         const unsigned short ANY_TYPE                       = 0;
27         const unsigned short NUMBER_TYPE                    = 1;
28         const unsigned short STRING_TYPE                    = 2;
29         const unsigned short BOOLEAN_TYPE                   = 3;
30         const unsigned short UNORDERED_NODE_ITERATOR_TYPE   = 4;
31         const unsigned short ORDERED_NODE_ITERATOR_TYPE     = 5;
32         const unsigned short UNORDERED_NODE_SNAPSHOT_TYPE   = 6;
33         const unsigned short ORDERED_NODE_SNAPSHOT_TYPE     = 7;
34         const unsigned short ANY_UNORDERED_NODE_TYPE        = 8;
35         const unsigned short FIRST_ORDERED_NODE_TYPE        = 9;
36
37         readonly attribute unsigned short  resultType;
38         readonly attribute double          numberValue
39             getter raises (DOMException);
40             
41         readonly attribute DOMString       stringValue
42             getter raises (DOMException);
43
44         readonly attribute boolean         booleanValue
45             getter raises (DOMException);
46
47         readonly attribute Node            singleNodeValue
48             getter raises (DOMException);
49
50         readonly attribute boolean         invalidIteratorState;
51         readonly attribute unsigned long   snapshotLength
52             getter raises (DOMException);
53             
54         Node iterateNext()
55             raises (DOMException);
56         Node snapshotItem(in [Optional=CallWithDefaultValue] unsigned long index)
57             raises (DOMException);
58     };
59
60 }