dom/public/idl/traversal/nsIDOMNodeFilter.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is this file as it was released on May 1 2001.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Jonas Sicking.
  20  * Portions created by the Initial Developer are Copyright (C) 2001
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Jonas Sicking <sicking@bigfoot.com> (Original Author)
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "domstubs.idl"
  41
  42 [scriptable, function, uuid(e4723748-1dd1-11b2-8ee6-866a532a6237)]
  43 // Introduced in DOM Level 2:
  44 interface nsIDOMNodeFilter : nsISupports
  45 {
  46   // Constants returned by acceptNode
  47   const short               FILTER_ACCEPT                  = 1;
  48   const short               FILTER_REJECT                  = 2;
  49   const short               FILTER_SKIP                    = 3;
  50
  51
  52   // Constants for whatToShow
  53   const unsigned long       SHOW_ALL                       = 0xFFFFFFFF;
  54   const unsigned long       SHOW_ELEMENT                   = 0x00000001;
  55   const unsigned long       SHOW_ATTRIBUTE                 = 0x00000002;
  56   const unsigned long       SHOW_TEXT                      = 0x00000004;
  57   const unsigned long       SHOW_CDATA_SECTION             = 0x00000008;
  58   const unsigned long       SHOW_ENTITY_REFERENCE          = 0x00000010;
  59   const unsigned long       SHOW_ENTITY                    = 0x00000020;
  60   const unsigned long       SHOW_PROCESSING_INSTRUCTION    = 0x00000040;
  61   const unsigned long       SHOW_COMMENT                   = 0x00000080;
  62   const unsigned long       SHOW_DOCUMENT                  = 0x00000100;
  63   const unsigned long       SHOW_DOCUMENT_TYPE             = 0x00000200;
  64   const unsigned long       SHOW_DOCUMENT_FRAGMENT         = 0x00000400;
  65   const unsigned long       SHOW_NOTATION                  = 0x00000800;
  66
  67   short              acceptNode(in nsIDOMNode n);
  68 };