Source/WebKit2/UIProcess/TextChecker.h

   1 /*
   2  * Copyright (C) 2010 Apple 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''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef TextChecker_h
  27 #define TextChecker_h
  28
  29 #include <WebCore/EditorClient.h>
  30 #include <WebCore/TextCheckerClient.h>
  31
  32 namespace WebKit {
  33
  34 class WebPageProxy;
  35 struct TextCheckerState;
  36
  37 class TextChecker {
  38 public:
  39     static const TextCheckerState& state();
  40     static bool isContinuousSpellCheckingAllowed();
  41
  42     static void setContinuousSpellCheckingEnabled(bool);
  43     static void setGrammarCheckingEnabled(bool);
  44
  45 #if PLATFORM(MAC)
  46     static void setAutomaticSpellingCorrectionEnabled(bool);
  47     static void setAutomaticQuoteSubstitutionEnabled(bool);
  48     static void setAutomaticDashSubstitutionEnabled(bool);
  49     static void setAutomaticLinkDetectionEnabled(bool);
  50     static void setAutomaticTextReplacementEnabled(bool);
  51
  52     static bool isSmartInsertDeleteEnabled();
  53     static void setSmartInsertDeleteEnabled(bool);
  54
  55     static bool substitutionsPanelIsShowing();
  56     static void toggleSubstitutionsPanelIsShowing();
  57 #endif
  58
  59     static void continuousSpellCheckingEnabledStateChanged(bool);
  60     static void grammarCheckingEnabledStateChanged(bool);
  61     static int64_t uniqueSpellDocumentTag(WebPageProxy*);
  62     static void closeSpellDocumentWithTag(int64_t);
  63 #if USE(UNIFIED_TEXT_CHECKING)
  64     static Vector<WebCore::TextCheckingResult> checkTextOfParagraph(int64_t spellDocumentTag, const UChar* text, int length, uint64_t checkingTypes);
  65 #endif
  66     static void checkSpellingOfString(int64_t spellDocumentTag, const UChar* text, uint32_t length, int32_t& misspellingLocation, int32_t& misspellingLength);
  67     static void checkGrammarOfString(int64_t spellDocumentTag, const UChar* text, uint32_t length, Vector<WebCore::GrammarDetail>&, int32_t& badGrammarLocation, int32_t& badGrammarLength);
  68     static bool spellingUIIsShowing();
  69     static void toggleSpellingUIIsShowing();
  70     static void updateSpellingUIWithMisspelledWord(int64_t spellDocumentTag, const String& misspelledWord);
  71     static void updateSpellingUIWithGrammarString(int64_t spellDocumentTag, const String& badGrammarPhrase, const WebCore::GrammarDetail&);
  72     static void getGuessesForWord(int64_t spellDocumentTag, const String& word, const String& context, Vector<String>& guesses);
  73     static void learnWord(int64_t spellDocumentTag, const String& word);
  74     static void ignoreWord(int64_t spellDocumentTag, const String& word);
  75 };
  76
  77 } // namespace WebKit
  78
  79 #endif // TextChecker_h