extensions/xpath-generator/nsIXPathGenerator.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is mozilla.org XPath Generator.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Alexander J. Vincent <ajvincent@gmail.com>.
  18  * Portions created by the Initial Developer are Copyright (C) 2007
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "domstubs.idl"
  38 #include "nsIDOMXPathNSResolver.idl"
  39
  40 [scriptable, uuid(341d8cbe-bcb3-4d9a-a5a6-dd4ef72a402d)]
  41 interface nsIXPathGenerator : nsISupports {
  42   /**
  43    * A collection of bitwise flags which modify behavior.
  44    * 0x01000000 and flags greater are reserved for custom implementations.
  45    */
  46
  47   // Ignore ID-type attribute nodes on elements
  48   // and continue to the document or context node.
  49   const unsigned long IGNORE_ID_TYPE_ATTRS          = 0x00000001;
  50
  51   // Return expression containing a single step that uses the descendant axis.
  52   const unsigned long USE_DESCENDANT_AXIS           = 0x00000002;
  53
  54   /**
  55    * Flags to modify parameters for generating the xpath string (default 0)
  56    */
  57   attribute unsigned long searchFlags;
  58
  59   /**
  60    * Namespace resolver corresponding to all generated xpaths.
  61    */
  62   readonly attribute nsIDOMXPathNSResolver resolver;
  63
  64   /**
  65    * Add a namespace URI and prefix to the namespace resolver.
  66    *
  67    * @param namespaceURI     The namespace URI of the namespace.
  68    * @param prefix           The prefix of the namespace.
  69    */
  70   void addNamespace(in DOMString namespaceURI,
  71                     in DOMString prefix);
  72
  73   /**
  74    * Generate a xpath as a string.
  75    *
  76    * @param targetNode  The node our xpath ends at.
  77    * @param contextNode The node our xpath starts from.
  78    *                    If null, use targetNode's owner document.
  79    *
  80    * @return DOMString XPath from the context node to the target node.
  81    */
  82   DOMString generateXPath(in nsIDOMNode targetNode,
  83                           in nsIDOMNode contextNode);
  84 };