Back to index

lightning-sunbird  0.9+nobinonly
nsIDOMNSRange.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 
00042 [scriptable, uuid(a6cf90f2-15b3-11d2-932e-00805f8add32)]
00043 interface nsIDOMNSRange : nsISupports
00044 {
00045   nsIDOMDocumentFragment    createContextualFragment(in DOMString fragment);
00046 
00047   // Is the point contained in the range?
00048   boolean                   isPointInRange(in nsIDOMNode parent,
00049                                            in long offset);
00050 
00051   // comparePoint returns
00052   //   -1 if point is before range,
00053   //    0 if point is in range,
00054   //    1 if point is after range
00055   // Sort of a strcmp for ranges.
00056   short                     comparePoint(in nsIDOMNode parent, in long offset);
00057 
00058   // Does the node intersect the range?
00059   boolean                   intersectsNode(in nsIDOMNode n);
00060 
00061   // HOW does the node intersect the range?  Four possible values:
00062   const unsigned short NODE_BEFORE = 0;
00063   const unsigned short NODE_AFTER = 1;
00064   const unsigned short NODE_BEFORE_AND_AFTER = 2;
00065   const unsigned short NODE_INSIDE = 3;
00066   unsigned short            compareNode(in nsIDOMNode n);
00067 
00068   // now what the %&*!@ is this?
00069   void                      nSDetach();
00070 };