1 /*

     2  * Copyright (C) 2007 Apple Inc.  All rights reserved.

     3  *

     4  * Redistribution and use in source and binary forms, with or without

     5  * modification, are permitted provided that the following conditions

     6  * are met:

     7  *

     8  * 1.  Redistributions of source code must retain the above copyright

     9  *     notice, this list of conditions and the following disclaimer. 

    10  * 2.  Redistributions in binary form must reproduce the above copyright

    11  *     notice, this list of conditions and the following disclaimer in the

    12  *     documentation and/or other materials provided with the distribution. 

    13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of

    14  *     its contributors may be used to endorse or promote products derived

    15  *     from this software without specific prior written permission. 

    16  *

    17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY

    18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

    19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

    20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY

    21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

    22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

    23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

    24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

    25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

    26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    27  */

    28 

    29 

    30 #ifndef DOMSelection_h

    31 #define DOMSelection_h

    32 

    33 #include "Shared.h"

    34 #include <wtf/Forward.h>

    35 #include <wtf/PassRefPtr.h>

    36 

    37 namespace WebCore {

    38 

    39     class Frame;

    40     class Range;

    41     class Node;

    42     class String;

    43 

    44     typedef int ExceptionCode;

    45 

    46     class DOMSelection : public Shared<DOMSelection> {

    47     public:

    48         DOMSelection(Frame*);

    49 

    50         Frame* frame() const;

    51         void disconnectFrame();

    52 

    53         Node* anchorNode() const;

    54         Node* baseNode() const;

    55         int anchorOffset() const;

    56         int baseOffset() const;

    57         Node* focusNode() const;

    58         Node* extentNode() const;

    59         int focusOffset() const;

    60         int extentOffset() const;

    61         bool isCollapsed() const;

    62         String type() const;

    63         int rangeCount() const;

    64 

    65         void collapse(Node*, int offset, ExceptionCode&);

    66         void collapseToEnd();

    67         void collapseToStart();

    68         void empty();

    69         void setBaseAndExtent(Node* baseNode, int baseOffset, Node* extentNode, int extentOffset, ExceptionCode&);

    70         void setPosition(Node*, int offset, ExceptionCode&);

    71         void setPosition(Node*, ExceptionCode&);

    72         void modify(const String& alter, const String& direction, const String& granularity);

    73         PassRefPtr<Range> getRangeAt(int, ExceptionCode&);

    74         void removeAllRanges();

    75         void addRange(Range*);

    76 

    77         String toString();

    78 

    79     private:

    80         Frame* m_frame;

    81     };

    82 

    83 } // namespace WebCore

    84 

    85 #endif // DOMSelection_h