content/base/public/nsIRangeUtils.h

   1 /* -*- Mode: C++; 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 Mozilla Communicator client code, released
  17  * March 31, 1998.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 1998
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  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 /* A class for range utilities. */
  41
  42 #ifndef nsIRangeUtils_h___
  43 #define nsIRangeUtils_h___
  44
  45 #include "nsISupports.h"
  46
  47 // Forward declarations
  48 class nsIDOMRange;
  49 class nsIDOMNode;
  50 class nsIContent;
  51
  52 // IID for the nsIRangeUtils interface
  53 #define NS_IRANGEUTILS_IID       \
  54 { 0xa6cf9127, 0x15b3, 0x11d2, {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
  55
  56 class nsIRangeUtils : public nsISupports {
  57 public:
  58   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IRANGEUTILS_IID)
  59
  60   NS_IMETHOD_(PRInt32) ComparePoints(nsIDOMNode* aParent1, PRInt32 aOffset1,
  61                                      nsIDOMNode* aParent2, PRInt32 aOffset2) = 0;
  62
  63   NS_IMETHOD CompareNodeToRange(nsIContent* aNode,
  64                                 nsIDOMRange* aRange,
  65                                 PRBool *outNodeBefore,
  66                                 PRBool *outNodeAfter) = 0;
  67 };
  68
  69 NS_DEFINE_STATIC_IID_ACCESSOR(nsIRangeUtils, NS_IRANGEUTILS_IID)
  70
  71 #endif /* nsIRangeUtils_h___ */
  72