WebCore:
[WebKit-https.git] / WebCore / kwq / DOMRange.h
1 /*
2  * Copyright (C) 2004 Apple Computer, 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 //=========================================================================
27 //=========================================================================
28 //=========================================================================
29
30 // Important Note:
31 // Though this file appears as an exported header from WebKit, the
32 // version you should edit is in WebCore. The WebKit version is copied
33 // to WebKit during the build process.
34
35 //=========================================================================
36 //=========================================================================
37 //=========================================================================
38
39 #import "DOMCore.h"
40
41 extern NSString * const DOMRangeException;
42
43 enum {
44     //
45     // DOM range exception codes
46     //
47     DOM_BAD_BOUNDARYPOINTS_ERR        = 1,
48     DOM_INVALID_NODE_TYPE_ERR         = 2,
49 };
50
51 enum {
52     //
53     // DOM Range comparison codes
54     //
55     DOM_START_TO_START                = 0,
56     DOM_START_TO_END                  = 1,
57     DOM_END_TO_END                    = 2,
58     DOM_END_TO_START                  = 3,
59 };
60
61 @interface DOMRange : DOMObject
62 - (DOMNode *)startContainer;
63 - (long)startOffset;
64 - (DOMNode *)endContainer;
65 - (long)endOffset;
66 - (BOOL)collapsed;
67 - (DOMNode *)commonAncestorContainer;
68 - (void)setStart:(DOMNode *)refNode :(long)offset;
69 - (void)setEnd:(DOMNode *)refNode :(long)offset;
70 - (void)setStartBefore:(DOMNode *)refNode;
71 - (void)setStartAfter:(DOMNode *)refNode;
72 - (void)setEndBefore:(DOMNode *)refNode;
73 - (void)setEndAfter:(DOMNode *)refNode;
74 - (void)collapse:(BOOL)toStart;
75 - (void)selectNode:(DOMNode *)refNode;
76 - (void)selectNodeContents:(DOMNode *)refNode;
77 - (short)compareBoundaryPoints:(unsigned short)how :(DOMRange *)sourceRange;
78 - (void)deleteContents;
79 - (DOMDocumentFragment *)extractContents;
80 - (DOMDocumentFragment *)cloneContents;
81 - (void)insertNode:(DOMNode *)newNode;
82 - (void)surroundContents:(DOMNode *)newParent;
83 - (DOMRange *)cloneRange;
84 - (NSString *)toString;
85 - (void)detach;
86 @end
87
88 @protocol DOMDocumentRange
89 - (DOMRange *)createRange;
90 @end