dom/public/idl/xpath/nsIDOMNSXPathExpression.idl

   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  * Novell, Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Allan Beaufour <allan@beaufour.dk> (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 #include "domstubs.idl"
  40
  41 interface nsIDOMXPathResult;
  42 interface XPathException;
  43
  44 /**
  45  * Interface for Mozilla specific XPathExpression functions.
  46  */
  47 [scriptable, uuid(ce600ca8-e98a-4419-ad61-2f6d0cb0ecc8)]
  48 interface nsIDOMNSXPathExpression : nsISupports
  49 {
  50   /**
  51    * Evaluate the expression with the given context. Similar to
  52    * nsIDOMXPathExpression::evaluate(), except that this takes the context
  53    * position and size too.
  54    *
  55    * @param contextNode       The context node
  56    * @param contextPosition   The context position
  57    * @param contextSize       The context size
  58    * @param type              The needed result type
  59    * @param result            The result
  60    */
  61   nsISupports evaluateWithContext(in nsIDOMNode contextNode,
  62                                   in unsigned long contextPosition,
  63                                   in unsigned long contextSize,
  64                                   in unsigned short type,
  65                                   in nsISupports result)
  66                                     raises(XPathException,
  67                                            DOMException);
  68 };