Source/WebCore/page/DOMSelection.idl

   1 /*
   2  * Copyright (C) 2007 Apple Inc.  All rights reserved.
   3  * Copyright (C) 2009 Google Inc.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 module window {
  31
  32     // This is based off of Mozilla's Selection interface
  33     // https://developer.mozilla.org/En/DOM/Selection
  34     interface [
  35         JSGenerateIsReachable=ImplFrame,
  36         InterfaceName=Selection
  37     ] DOMSelection {
  38         readonly attribute Node anchorNode;
  39         readonly attribute long anchorOffset;
  40         readonly attribute Node focusNode;
  41         readonly attribute long focusOffset;
  42
  43         readonly attribute boolean isCollapsed;
  44         readonly attribute long rangeCount;
  45
  46         void collapse(in [Optional=DefaultIsUndefined] Node node,
  47                       in [Optional=DefaultIsUndefined] long index)
  48             raises(DOMException);
  49         void collapseToEnd()
  50             raises(DOMException);
  51         void collapseToStart()
  52             raises(DOMException);
  53
  54         void deleteFromDocument();
  55         boolean containsNode(in [Optional=DefaultIsUndefined] Node node,
  56                              in [Optional=DefaultIsUndefined] boolean allowPartial);
  57         void selectAllChildren(in [Optional=DefaultIsUndefined] Node node)
  58             raises(DOMException);
  59
  60         void extend(in [Optional=DefaultIsUndefined] Node node,
  61                     in [Optional=DefaultIsUndefined] long offset)
  62             raises(DOMException);
  63
  64         Range getRangeAt(in [Optional=DefaultIsUndefined] long index)
  65             raises(DOMException);
  66         void removeAllRanges();
  67         void addRange(in [Optional=DefaultIsUndefined] Range range);
  68
  69 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
  70         [NotEnumerable] DOMString toString();
  71 #endif
  72
  73         // WebKit extensions
  74         readonly attribute Node baseNode;
  75         readonly attribute long baseOffset;
  76         readonly attribute Node extentNode;
  77         readonly attribute long extentOffset;
  78
  79         // WebKit's "type" accessor returns "None", "Range" and "Caret"
  80         // IE's type accessor returns "none", "text" and "control"
  81         readonly attribute DOMString type;
  82
  83         void modify(in [Optional=DefaultIsUndefined] DOMString alter,
  84                     in [Optional=DefaultIsUndefined] DOMString direction,
  85                     in [Optional=DefaultIsUndefined] DOMString granularity);
  86         void setBaseAndExtent(in [Optional=DefaultIsUndefined] Node baseNode,
  87                               in [Optional=DefaultIsUndefined] long baseOffset,
  88                               in [Optional=DefaultIsUndefined] Node extentNode,
  89                               in [Optional=DefaultIsUndefined] long extentOffset)
  90             raises(DOMException);
  91         void setPosition(in [Optional=DefaultIsUndefined] Node node,
  92                          in [Optional=DefaultIsUndefined] long offset)
  93             raises(DOMException);
  94
  95         // IE extentions
  96         // http://msdn.microsoft.com/en-us/library/ms535869(VS.85).aspx
  97         void empty();
  98     };
  99
 100 }