third_party/WebKit/Source/web/SpellCheckerClientImpl.h

   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 SpellCheckerClientImpl_h
  32 #define SpellCheckerClientImpl_h
  33
  34 #include "core/page/SpellCheckerClient.h"
  35 #include "platform/heap/Handle.h"
  36 #include "platform/text/TextCheckerClient.h"
  37
  38 namespace blink {
  39
  40 class WebViewImpl;
  41
  42 class SpellCheckerClientImpl final : public SpellCheckerClient, public TextCheckerClient {
  43 public:
  44     explicit SpellCheckerClientImpl(WebViewImpl*);
  45
  46     ~SpellCheckerClientImpl() override;
  47
  48     bool isContinuousSpellCheckingEnabled() override;
  49     void toggleContinuousSpellChecking() override;
  50     bool isGrammarCheckingEnabled() override;
  51     bool shouldEraseMarkersAfterChangeSelection(TextCheckingType) const override;
  52     void checkSpellingOfString(const String&, int* misspellingLocation, int* misspellingLength) override;
  53     void checkGrammarOfString(const String&, Vector<GrammarDetail>&,
  54         int* badGrammarLocation, int* badGrammarLength) override;
  55     String getAutoCorrectSuggestionForMisspelledWord(const String&) override;
  56     void updateSpellingUIWithMisspelledWord(const String&) override;
  57     void showSpellingUI(bool show) override;
  58     bool spellingUIIsShowing() override;
  59     void requestCheckingOfString(PassRefPtrWillBeRawPtr<TextCheckingRequest>) override;
  60
  61     TextCheckerClient& textChecker() override { return *this; }
  62
  63 private:
  64     // Returns whether or not the focused control needs spell-checking.
  65     // Currently, this function just retrieves the focused node and determines
  66     // whether or not it is a <textarea> element or an element whose
  67     // contenteditable attribute is true.
  68     // FIXME: Bug 740540: This code just implements the default behavior
  69     // proposed in this issue. We should also retrieve "spellcheck" attributes
  70     // for text fields and create a flag to over-write the default behavior.
  71     bool shouldSpellcheckByDefault();
  72
  73     WebViewImpl* m_webView;
  74
  75     // This flag is set to false if spell check for this editor is manually
  76     // turned off. The default setting is SpellCheckAutomatic.
  77     enum {
  78         SpellCheckAutomatic,
  79         SpellCheckForcedOn,
  80         SpellCheckForcedOff
  81     } m_spellCheckThisFieldStatus;
  82 };
  83
  84 } // namespace blink
  85
  86 #endif