Home | History | Annotate | Download | only in page
      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 [OmitConstructor] DOMSelection {
     35         readonly attribute Node anchorNode;
     36         readonly attribute long anchorOffset;
     37         readonly attribute Node focusNode;
     38         readonly attribute long focusOffset;
     39 
     40         readonly attribute boolean isCollapsed;
     41         readonly attribute long rangeCount;
     42 
     43         void collapse(in Node node, in long index)
     44             raises(DOMException);
     45         void collapseToEnd()
     46             raises(DOMException);
     47         void collapseToStart()
     48             raises(DOMException);
     49 
     50         void deleteFromDocument();
     51         boolean containsNode(in Node node, in boolean allowPartial);
     52         void selectAllChildren(in Node node)
     53             raises(DOMException);
     54 
     55         void extend(in Node node, in long offset)
     56             raises(DOMException);
     57 
     58         Range getRangeAt(in long index)
     59             raises(DOMException);
     60         void removeAllRanges();
     61         void addRange(in Range range);
     62 
     63 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
     64         [DontEnum] DOMString toString();
     65 #endif
     66 
     67         // WebKit extensions
     68         readonly attribute Node baseNode;
     69         readonly attribute long baseOffset;
     70         readonly attribute Node extentNode;
     71         readonly attribute long extentOffset;
     72 
     73         // WebKit's "type" accessor returns "None", "Range" and "Caret"
     74         // IE's type accessor returns "none", "text" and "control"
     75         readonly attribute DOMString type;
     76 
     77         void modify(in DOMString alter, in DOMString direction, in DOMString granularity);
     78         void setBaseAndExtent(in Node baseNode, in long baseOffset, in Node extentNode, in long extentOffset)
     79             raises(DOMException);
     80         void setPosition(in Node node, in long offset)
     81             raises(DOMException);
     82 
     83         // IE extentions
     84         // http://msdn.microsoft.com/en-us/library/ms535869(VS.85).aspx
     85         void empty();
     86     };
     87 
     88 }
     89