Back to index

lightning-sunbird  0.9+nobinonly
nsIDOMXPathResult.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Peter Van der Beken <peterv@netscape.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00043 #include "domstubs.idl"
00044 
00045 interface XPathException;
00046 
00047 [scriptable, uuid(75506f84-b504-11d5-a7f2-ca108ab8b6fc)]
00048 interface nsIDOMXPathResult : nsISupports
00049 {
00050   // XPathResultType
00051   const unsigned short      ANY_TYPE                       = 0;
00052   const unsigned short      NUMBER_TYPE                    = 1;
00053   const unsigned short      STRING_TYPE                    = 2;
00054   const unsigned short      BOOLEAN_TYPE                   = 3;
00055   const unsigned short      UNORDERED_NODE_ITERATOR_TYPE   = 4;
00056   const unsigned short      ORDERED_NODE_ITERATOR_TYPE     = 5;
00057   const unsigned short      UNORDERED_NODE_SNAPSHOT_TYPE   = 6;
00058   const unsigned short      ORDERED_NODE_SNAPSHOT_TYPE     = 7;
00059   const unsigned short      ANY_UNORDERED_NODE_TYPE        = 8;
00060   const unsigned short      FIRST_ORDERED_NODE_TYPE        = 9;
00061 
00062   readonly attribute unsigned short   resultType;
00063   readonly attribute double           numberValue;
00064                                       // raises(XPathException) on retrieval
00065 
00066   readonly attribute DOMString        stringValue;
00067                                       // raises(XPathException) on retrieval
00068 
00069   readonly attribute boolean          booleanValue;
00070                                       // raises(XPathException) on retrieval
00071 
00072   readonly attribute nsIDOMNode       singleNodeValue;
00073                                       // raises(XPathException) on retrieval
00074 
00075   readonly attribute boolean          invalidIteratorState;
00076   readonly attribute unsigned long    snapshotLength;
00077                                       // raises(XPathException) on retrieval
00078 
00079   nsIDOMNode               iterateNext()
00080                                       raises(XPathException, 
00081                                              DOMException);
00082   nsIDOMNode               snapshotItem(in unsigned long index)
00083                                       raises(XPathException);
00084 };