Back to index

lightning-sunbird  0.9+nobinonly
nsIRangeUtils.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is Mozilla Communicator client code, released
00017  * March 31, 1998.
00018  *
00019  * The Initial Developer of the Original Code is
00020  * Netscape Communications Corporation.
00021  * Portions created by the Initial Developer are Copyright (C) 1998
00022  * the Initial Developer. All Rights Reserved.
00023  *
00024  * Contributor(s):
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 /* A class for range utilities. */
00041 
00042 #ifndef nsIRangeUtils_h___
00043 #define nsIRangeUtils_h___
00044 
00045 #include "nsISupports.h"
00046 
00047 // Forward declarations
00048 class nsIDOMRange;
00049 class nsIDOMNode;
00050 class nsIContent;
00051 
00052 // IID for the nsIRangeUtils interface
00053 #define NS_IRANGEUTILS_IID       \
00054 { 0xa6cf9127, 0x15b3, 0x11d2, {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
00055 
00056 class nsIRangeUtils : public nsISupports {
00057 public:
00058   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IRANGEUTILS_IID)
00059 
00060   NS_IMETHOD_(PRInt32) ComparePoints(nsIDOMNode* aParent1, PRInt32 aOffset1,
00061                                      nsIDOMNode* aParent2, PRInt32 aOffset2) = 0;
00062                                
00063   NS_IMETHOD_(PRBool) IsNodeIntersectsRange(nsIContent* aNode, nsIDOMRange* aRange) = 0;
00064   
00065   NS_IMETHOD CompareNodeToRange(nsIContent* aNode, 
00066                                 nsIDOMRange* aRange,
00067                                 PRBool *outNodeBefore,
00068                                 PRBool *outNodeAfter) = 0;
00069 };
00070 
00071 #endif /* nsIRangeUtils_h___ */
00072