Back to index

lightning-sunbird  0.9+nobinonly
nsIDOMRange.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Vidur Apparao <vidur@netscape.com> (original author)
00024  *   Johnny Stenback <jst@netscape.com>
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 #include "domstubs.idl"
00041 
00051 [scriptable, uuid(a6cf90ce-15b3-11d2-932e-00805f8add32)]
00052 interface nsIDOMRange : nsISupports
00053 {
00054   readonly attribute nsIDOMNode       startContainer;
00055                                         // raises(DOMException) on retrieval
00056 
00057   readonly attribute long             startOffset;
00058                                         // raises(DOMException) on retrieval
00059 
00060   readonly attribute nsIDOMNode       endContainer;
00061                                         // raises(DOMException) on retrieval
00062 
00063   readonly attribute long             endOffset;
00064                                         // raises(DOMException) on retrieval
00065 
00066   readonly attribute boolean          collapsed;
00067                                         // raises(DOMException) on retrieval
00068 
00069   readonly attribute nsIDOMNode       commonAncestorContainer;
00070                                         // raises(DOMException) on retrieval
00071 
00072   void               setStart(in nsIDOMNode refNode, in long offset)
00073                                         raises(RangeException, DOMException);
00074   void               setEnd(in nsIDOMNode refNode, in long offset)
00075                                         raises(RangeException, DOMException);
00076   void               setStartBefore(in nsIDOMNode refNode)
00077                                         raises(RangeException, DOMException);
00078   void               setStartAfter(in nsIDOMNode refNode)
00079                                         raises(RangeException, DOMException);
00080   void               setEndBefore(in nsIDOMNode refNode)
00081                                         raises(RangeException, DOMException);
00082   void               setEndAfter(in nsIDOMNode refNode)
00083                                         raises(RangeException, DOMException);
00084   void               collapse(in boolean toStart)
00085                                         raises(DOMException);
00086   void               selectNode(in nsIDOMNode refNode)
00087                                         raises(RangeException, DOMException);
00088   void               selectNodeContents(in nsIDOMNode refNode)
00089                                         raises(RangeException, DOMException);
00090 
00091   // CompareHow
00092   const unsigned short      START_TO_START                 = 0;
00093   const unsigned short      START_TO_END                   = 1;
00094   const unsigned short      END_TO_END                     = 2;
00095   const unsigned short      END_TO_START                   = 3;
00096 
00097   short              compareBoundaryPoints(in unsigned short how,
00098                                            in nsIDOMRange sourceRange)
00099                                         raises(DOMException);
00100   void               deleteContents()
00101                                         raises(DOMException);
00102   nsIDOMDocumentFragment extractContents()
00103                                         raises(DOMException);
00104   nsIDOMDocumentFragment cloneContents()
00105                                         raises(DOMException);
00106   void               insertNode(in nsIDOMNode newNode)
00107                                         raises(DOMException, RangeException);
00108   void               surroundContents(in nsIDOMNode newParent)
00109                                         raises(DOMException, RangeException);
00110   nsIDOMRange        cloneRange()
00111                                         raises(DOMException);
00112   DOMString          toString()
00113                                         raises(DOMException);
00114   void               detach()
00115                                         raises(DOMException);
00116 };