Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 /* | 1 /* |
| 2 * Copyright (C) 2012 Google Inc. All rights reserved. | 2 * Copyright (C) 2012 Google Inc. All rights reserved. |
| 3 * | 3 * |
| 4 * Redistribution and use in source and binary forms, with or without | 4 * Redistribution and use in source and binary forms, with or without |
| 5 * modification, are permitted provided that the following conditions | 5 * modification, are permitted provided that the following conditions |
| 6 * are met: | 6 * are met: |
| 7 * 1. Redistributions of source code must retain the above copyright | 7 * 1. Redistributions of source code must retain the above copyright |
| 8 * notice, this list of conditions and the following disclaimer. | 8 * notice, this list of conditions and the following disclaimer. |
| 9 * 2. Redistributions in binary form must reproduce the above copyright | 9 * 2. Redistributions in binary form must reproduce the above copyright |
| 10 * notice, this list of conditions and the following disclaimer in the | 10 * notice, this list of conditions and the following disclaimer in the |
| (...skipping 20 matching lines...) Expand all Loading... | |
| 31 #include "WebRange.h" | 31 #include "WebRange.h" |
| 32 | 32 |
| 33 namespace WebCore { | 33 namespace WebCore { |
| 34 class SurroundingText; | 34 class SurroundingText; |
| 35 } | 35 } |
| 36 | 36 |
| 37 namespace blink { | 37 namespace blink { |
| 38 | 38 |
| 39 class WebHitTestResult; | 39 class WebHitTestResult; |
| 40 class WebNode; | 40 class WebNode; |
| 41 class WebRange; | |
| 41 struct WebPoint; | 42 struct WebPoint; |
| 42 | 43 |
| 44 // WebSurroundingText is a Blink API that gives access to the SurroundingText AP I. | |
|
tkent
2014/06/13 01:15:37
Nit: I recommend to wrap code comments in 80 colum
mlamouri (slow - plz ping)
2014/06/13 10:34:04
Done. I've also changed the rest of the comments i
| |
| 45 // It allows caller to know the text surrounding a point or a range. | |
| 43 class WebSurroundingText { | 46 class WebSurroundingText { |
| 44 public: | 47 public: |
| 45 WebSurroundingText() { } | 48 WebSurroundingText() { } |
| 46 ~WebSurroundingText() { reset(); } | 49 ~WebSurroundingText() { reset(); } |
| 47 | 50 |
| 48 BLINK_EXPORT bool isNull() const; | 51 BLINK_EXPORT bool isNull() const; |
| 49 BLINK_EXPORT void reset(); | 52 BLINK_EXPORT void reset(); |
| 50 | 53 |
| 51 // Initializes the object to get the surrounding text centered in the positi on relative to a provided node. | 54 // Initializes the object to get the surrounding text centered in the positi on relative to a provided node. |
| 52 // The maximum length of the contents retrieved is defined by maxLength. | 55 // The maximum length of the contents retrieved is defined by maxLength. |
| 53 BLINK_EXPORT void initialize(const WebNode&, const WebPoint&, size_t maxLeng th); | 56 BLINK_EXPORT void initialize(const WebNode&, const WebPoint&, size_t maxLeng th); |
| 54 | 57 |
| 58 // Initializes the object to get the text surrounding a given range. | |
| 59 // The maximum length of the contents retrieved is defined by maxLength. It does not include the text inside the range. | |
| 60 BLINK_EXPORT void initialize(const WebRange&, size_t maxLength); | |
| 61 | |
| 55 // Surrounding text content retrieved. | 62 // Surrounding text content retrieved. |
| 56 BLINK_EXPORT WebString textContent() const; | 63 BLINK_EXPORT WebString textContent() const; |
| 57 | 64 |
| 58 // Offset in the text content of the initial hit position (or provided offse t in the node). | 65 // Offset in the text content of the initial hit position (or provided offse t in the node). |
| 66 // This should only be called when WebSurroundingText has been initialized w ith a WebPoint. | |
| 67 // DEPRECATED: use startOffsetInTextContent() or endOffsetInTextContent(). | |
| 59 BLINK_EXPORT size_t hitOffsetInTextContent() const; | 68 BLINK_EXPORT size_t hitOffsetInTextContent() const; |
| 60 | 69 |
| 70 // Start offset of the initial text in the text content. | |
| 71 BLINK_EXPORT size_t startOffsetInTextContent() const; | |
| 72 | |
| 73 // End offset of the initial text in the text content. | |
| 74 BLINK_EXPORT size_t endOffsetInTextContent() const; | |
| 75 | |
| 61 // Convert start/end positions in the content text string into a WebKit text range. | 76 // Convert start/end positions in the content text string into a WebKit text range. |
| 62 BLINK_EXPORT WebRange rangeFromContentOffsets(size_t startOffsetInContent, s ize_t endOffsetInContent); | 77 BLINK_EXPORT WebRange rangeFromContentOffsets(size_t startOffsetInContent, s ize_t endOffsetInContent); |
| 63 | 78 |
| 64 protected: | 79 protected: |
| 65 WebPrivateOwnPtr<WebCore::SurroundingText> m_private; | 80 WebPrivateOwnPtr<WebCore::SurroundingText> m_private; |
| 66 }; | 81 }; |
| 67 | 82 |
| 68 } // namespace blink | 83 } // namespace blink |
| 69 | 84 |
| 70 #endif | 85 #endif |
| OLD | NEW |