• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef WebRange_h
32 #define WebRange_h
33 
34 #include "WebFrame.h"
35 #include "public/platform/WebCommon.h"
36 #include "public/platform/WebPrivatePtr.h"
37 #include "public/platform/WebVector.h"
38 
39 namespace WebCore { class Range; }
40 
41 namespace blink {
42 
43 struct WebFloatQuad;
44 class WebNode;
45 class WebString;
46 
47 // Provides readonly access to some properties of a DOM range.
48 class WebRange {
49 public:
~WebRange()50     ~WebRange() { reset(); }
51 
WebRange()52     WebRange() { }
WebRange(const WebRange & r)53     WebRange(const WebRange& r) { assign(r); }
54     WebRange& operator=(const WebRange& r)
55     {
56         assign(r);
57         return *this;
58     }
59 
60     BLINK_EXPORT void reset();
61     BLINK_EXPORT void assign(const WebRange&);
62 
isNull()63     bool isNull() const { return m_private.isNull(); }
64 
65     BLINK_EXPORT int startOffset() const;
66     BLINK_EXPORT int endOffset() const;
67     BLINK_EXPORT WebNode startContainer(int& exceptionCode) const;
68     BLINK_EXPORT WebNode endContainer(int& exceptionCode) const;
69 
70     BLINK_EXPORT WebString toHTMLText() const;
71     BLINK_EXPORT WebString toPlainText() const;
72 
73     BLINK_EXPORT WebRange expandedToParagraph() const;
74 
75     BLINK_EXPORT static WebRange fromDocumentRange(WebLocalFrame*, int start, int length);
76 
77     BLINK_EXPORT WebVector<WebFloatQuad> textQuads() const;
78 
79 #if BLINK_IMPLEMENTATION
80     WebRange(const PassRefPtrWillBeRawPtr<WebCore::Range>&);
81     operator PassRefPtrWillBeRawPtr<WebCore::Range>() const;
82 #endif
83 
84 private:
85     WebPrivatePtr<WebCore::Range> m_private;
86 };
87 
88 } // namespace blink
89 
90 #endif
91