src/third_party/WebKit/Source/core/editing/Selection.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 // This is based on the W3C standard HTML Editing APIs
  31 // https://dvcs.w3.org/hg/editing/raw-file/tip/editing.html#selection
  32 //
  33 // FIXME: Fix discrepancies from the standard, especially
  34 // * unsigned types where should be unsigned
  35 // * Nullability
  36 // * RemoveRange(Range range) method
  37 // http://crbug.com/391673
  38 [
  39     ImplementedAs=DOMSelection,
  40     WillBeGarbageCollected,
  41 ] interface Selection {
  42     readonly attribute Node anchorNode;
  43     readonly attribute long anchorOffset;
  44     readonly attribute Node focusNode;
  45     readonly attribute long focusOffset;
  46
  47     readonly attribute boolean isCollapsed;
  48     [RaisesException] void collapse(Node? node, optional long offset);
  49     [RaisesException] void collapseToStart();
  50     [RaisesException] void collapseToEnd();
  51
  52     // FIXME: should be: optional long offset = 0  http://crbug.com/258153
  53     // We mark offset as optional, defaulting to 0; this differs from spec.
  54     // http://crbug.com/384966
  55     [RaisesException, TypeChecking=Interface] void extend(Node node, optional long offset);
  56
  57     [RaisesException] void selectAllChildren([Default=Undefined] optional Node node);
  58     [CustomElementCallbacks] void deleteFromDocument();
  59
  60     readonly attribute long rangeCount;
  61     [RaisesException] Range getRangeAt([Default=Undefined] optional long index);
  62     void addRange([Default=Undefined] optional Range range);
  63     void removeAllRanges();
  64
  65     [NotEnumerable] stringifier;
  66
  67     // Firefox extensions
  68     // https://developer.mozilla.org/En/DOM/Selection
  69     //
  70     // FIXME: Add use counters.
  71     boolean containsNode([Default = Undefined] optional Node node, [Default = Undefined] optional boolean allowPartial);
  72
  73     // WebKit extensions
  74     [MeasureAs=SelectionBaseNode] readonly attribute Node baseNode;
  75     [MeasureAs=SelectionBaseOffset] readonly attribute long baseOffset;
  76     [MeasureAs=SelectionExtentNode] readonly attribute Node extentNode;
  77     [MeasureAs=SelectionExtentOffset] 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     [MeasureAs=SelectionType] readonly attribute DOMString type;
  82
  83     [MeasureAs=SelectionModify] void modify([Default=Undefined] optional DOMString alter,
  84                                             [Default=Undefined] optional DOMString direction,
  85                                             [Default=Undefined] optional DOMString granularity);
  86     [MeasureAs=SelectionSetBaseAndExtent, RaisesException] void setBaseAndExtent([Default=Undefined] optional Node baseNode,
  87                                                                                  [Default=Undefined] optional long baseOffset,
  88                                                                                  [Default=Undefined] optional Node extentNode,
  89                                                                                  [Default=Undefined] optional long extentOffset);
  90     [ImplementedAs=collapse, MeasureAs=SelectionSetPosition, RaisesException] void setPosition(Node? node, optional long offset);
  91
  92     // IE extensions
  93     // http://msdn.microsoft.com/en-us/library/ms535869(VS.85).aspx
  94     [MeasureAs=SelectionEmpty] void empty();
  95 };