1 /* 2 * Copyright (C) 2012 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 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 INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY 14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 15 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 16 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY 17 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 18 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 19 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 22 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23 */ 24 25 #ifndef WebSurroundingText_h 26 #define WebSurroundingText_h 27 28 #include "../platform/WebPrivateOwnPtr.h" 29 #include "../platform/WebString.h" 30 #include "WebNode.h" 31 #include "WebRange.h" 32 33 namespace WebCore { 34 class SurroundingText; 35 } 36 37 namespace blink { 38 39 class WebHitTestResult; 40 class WebNode; 41 class WebRange; 42 struct WebPoint; 43 44 // WebSurroundingText is a Blink API that gives access to the SurroundingText 45 // API. It allows caller to know the text surrounding a point or a range. 46 class WebSurroundingText { 47 public: WebSurroundingText()48 WebSurroundingText() { } ~WebSurroundingText()49 ~WebSurroundingText() { reset(); } 50 51 BLINK_EXPORT bool isNull() const; 52 BLINK_EXPORT void reset(); 53 54 // Initializes the object to get the surrounding text centered in the 55 // position relative to a provided node. 56 // The maximum length of the contents retrieved is defined by maxLength. 57 BLINK_EXPORT void initialize(const WebNode&, const WebPoint&, size_t maxLength); 58 59 // Initializes the object to get the text surrounding a given range. 60 // The maximum length of the contents retrieved is defined by maxLength. 61 // It does not include the text inside the range. 62 BLINK_EXPORT void initialize(const WebRange&, size_t maxLength); 63 64 // Surrounding text content retrieved. 65 BLINK_EXPORT WebString textContent() const; 66 67 // Offset in the text content of the initial hit position (or provided 68 // offset in the node). 69 // This should only be called when WebSurroundingText has been initialized 70 // with a WebPoint. 71 // DEPRECATED: use startOffsetInTextContent() or endOffsetInTextContent(). 72 BLINK_EXPORT size_t hitOffsetInTextContent() const; 73 74 // Start offset of the initial text in the text content. 75 BLINK_EXPORT size_t startOffsetInTextContent() const; 76 77 // End offset of the initial text in the text content. 78 BLINK_EXPORT size_t endOffsetInTextContent() const; 79 80 // Convert start/end positions in the content text string into a WebKit text 81 // range. 82 BLINK_EXPORT WebRange rangeFromContentOffsets(size_t startOffsetInContent, size_t endOffsetInContent); 83 84 protected: 85 WebPrivateOwnPtr<WebCore::SurroundingText> m_private; 86 }; 87 88 } // namespace blink 89 90 #endif 91