third_party/WebKit/public/web/mac/WebSubstringUtil.h

   1 /*
   2  * Copyright (C) 2011 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 WebSubstringUtil_h
  32 #define WebSubstringUtil_h
  33
  34 #include "../../platform/WebCommon.h"
  35 #include "public/web/WebFrame.h"
  36
  37 #if __OBJC__
  38 @class NSAttributedString;
  39 #else
  40 class NSAttributedString;
  41 #endif
  42
  43 namespace blink {
  44
  45 class WebView;
  46 struct WebPoint;
  47
  48 class WebSubstringUtil {
  49 public:
  50     // Returns an autoreleased NSAttributedString that is the word under
  51     // the given point, or nil on error.
  52     // Upon return, |baselinePoint| is set to the left baseline point in
  53     // AppKit coordinates.
  54     BLINK_EXPORT static NSAttributedString* attributedWordAtPoint(WebView*,
  55         WebPoint,
  56         WebPoint& baselinePoint);
  57
  58     // Returns an autoreleased NSAttributedString that is a substring of the
  59     // Frame at the given range, or nil on error.
  60     BLINK_EXPORT static NSAttributedString* attributedSubstringInRange(WebLocalFrame*,
  61         size_t location,
  62         size_t length);
  63
  64     // Returns an autoreleased NSAttributedString that is a substring of the
  65     // Frame at the given range, or nil on error.
  66     // It also gets the baseline point for the given range for showing
  67     // dictionary lookup bubble.
  68     BLINK_EXPORT static NSAttributedString* attributedSubstringInRange(WebLocalFrame*,
  69         size_t location,
  70         size_t length,
  71         WebPoint* baselinePoint);
  72 };
  73
  74 } // namespace blink
  75
  76 #endif