/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2000
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Vidur Apparao <vidur@netscape.com> (original author)
 *   Johnny Stenback <jst@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "domstubs.idl"

/**
 * The nsIDOMRange interface is an interface to a DOM range object.
 *
 * For more information on this interface please see
 * http://www.w3.org/TR/DOM-Level-2-Traversal-Range/
 */

[scriptable, builtinclass, uuid(a059eea8-fece-4c14-93d3-7f50a944ae43)]
interface nsIDOMRange : nsISupports
{
  readonly attribute nsIDOMNode       startContainer;
  readonly attribute long             startOffset;
  readonly attribute nsIDOMNode       endContainer;
  readonly attribute long             endOffset;
  readonly attribute boolean          collapsed;
  readonly attribute nsIDOMNode       commonAncestorContainer;

  void               setStart(in nsIDOMNode refNode, in long offset);
  void               setEnd(in nsIDOMNode refNode, in long offset);
  void               setStartBefore(in nsIDOMNode refNode);
  void               setStartAfter(in nsIDOMNode refNode);
  void               setEndBefore(in nsIDOMNode refNode);
  void               setEndAfter(in nsIDOMNode refNode);
  void               collapse(in boolean toStart);
  void               selectNode(in nsIDOMNode refNode);
  void               selectNodeContents(in nsIDOMNode refNode);

  // CompareHow
  const unsigned short      START_TO_START                 = 0;
  const unsigned short      START_TO_END                   = 1;
  const unsigned short      END_TO_END                     = 2;
  const unsigned short      END_TO_START                   = 3;

  short              compareBoundaryPoints(in unsigned short how,
                                           in nsIDOMRange sourceRange);
  void               deleteContents();
  nsIDOMDocumentFragment extractContents();
  nsIDOMDocumentFragment cloneContents();
  void               insertNode(in nsIDOMNode newNode);
  void               surroundContents(in nsIDOMNode newParent);
  nsIDOMRange        cloneRange();
  DOMString          toString();
  void               detach();
  
  // This method comes from
  // http://html5.org/specs/dom-parsing.html#extensions-to-the-range-interface
  nsIDOMDocumentFragment    createContextualFragment(in DOMString fragment);

  // This returns true if parent+offset equals either
  // of the boundary points or is between them.
  boolean                   isPointInRange(in nsIDOMNode parent,
                                           in long offset);

  // comparePoint returns
  //   -1 if point is before the start boundary point,
  //    0 if point is either of the boundary points or between them,
  //    1 if point is after the end boundary point.
  // Sort of a strcmp for ranges.
  short                     comparePoint(in nsIDOMNode parent, in long offset);

  // These methods come from 
  // http://dev.w3.org/csswg/cssom-view/#extensions-to-the-range-interface
  nsIDOMClientRectList getClientRects();
  nsIDOMClientRect getBoundingClientRect();
};
