content/base/public/nsIRange.h

   1 /* -*- Mode: C++; 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 Mozilla.com.
  18  * Portions created by the Initial Developer are Copyright (C) 2006
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *         Boris Zbarsky <bzbarsky@mit.edu> (Original Author)
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsIRange_h___
  39 #define nsIRange_h___
  40
  41 #include "nsISupports.h"
  42 #include "nsCOMPtr.h"
  43 #include "nsINode.h"
  44
  45 // IID for the nsIRange interface
  46 #define NS_IRANGE_IID \
  47 { 0x267c8c4e, 0x7c97, 0x4a35, \
  48   { 0xaa, 0x08, 0x55, 0xa5, 0xbe, 0x3a, 0xc5, 0x74 } }
  49
  50 class nsIRange : public nsISupports {
  51 public:
  52   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IRANGE_IID)
  53
  54   nsIRange()
  55     : mRoot(nsnull),
  56       mStartOffset(0),
  57       mEndOffset(0),
  58       mIsPositioned(PR_FALSE),
  59       mIsDetached(PR_FALSE),
  60       mMaySpanAnonymousSubtrees(PR_FALSE)
  61   {
  62   }
  63
  64   nsINode* GetRoot()
  65   {
  66     return mRoot;
  67   }
  68
  69   nsINode* GetStartParent()
  70   {
  71     return mStartParent;
  72   }
  73
  74   nsINode* GetEndParent()
  75   {
  76     return mEndParent;
  77   }
  78
  79   PRInt32 StartOffset()
  80   {
  81     return mStartOffset;
  82   }
  83
  84   PRInt32 EndOffset()
  85   {
  86     return mEndOffset;
  87   }
  88
  89   PRBool IsPositioned()
  90   {
  91     return mIsPositioned;
  92   }
  93
  94   PRBool IsDetached()
  95   {
  96     return mIsDetached;
  97   }
  98
  99   PRBool Collapsed()
 100   {
 101     return mIsPositioned && mStartParent == mEndParent &&
 102            mStartOffset == mEndOffset;
 103   }
 104
 105   void SetMaySpanAnonymousSubtrees(PRBool aMaySpanAnonymousSubtrees)
 106   {
 107     mMaySpanAnonymousSubtrees = aMaySpanAnonymousSubtrees;
 108   }
 109
 110   virtual nsINode* GetCommonAncestor() = 0;
 111
 112   virtual void Reset() = 0;
 113
 114 protected:
 115   nsINode* mRoot;
 116   nsCOMPtr<nsINode> mStartParent;
 117   nsCOMPtr<nsINode> mEndParent;
 118   PRInt32 mStartOffset;
 119   PRInt32 mEndOffset;
 120
 121   PRPackedBool mIsPositioned;
 122   PRPackedBool mIsDetached;
 123   PRPackedBool mMaySpanAnonymousSubtrees;
 124 };
 125
 126 NS_DEFINE_STATIC_IID_ACCESSOR(nsIRange, NS_IRANGE_IID)
 127
 128 #endif /* nsIRange_h___ */