WebKit2: Implement TextChecker on Windows
[WebKit-https.git] / Source / WebKit2 / UIProcess / win / WebTextCheckerClient.h
1 /*
2  * Copyright (C) 2011 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 WebTextCheckerClient_h
27 #define WebTextCheckerClient_h
28
29 #include "APIClient.h"
30 #include "WKTextChecker.h"
31 #include <WebCore/TextCheckerClient.h>
32 #include <wtf/Forward.h>
33 #include <wtf/Vector.h>
34
35 namespace WebKit {
36
37 class WebPageProxy;
38
39 class WebTextCheckerClient : public APIClient<WKTextCheckerClient> {
40 public:
41     bool continuousSpellCheckingAllowed();
42     bool continuousSpellCheckingEnabled();
43     void setContinuousSpellCheckingEnabled(bool);
44     bool grammarCheckingEnabled();
45     void setGrammarCheckingEnabled(bool);
46     uint64_t uniqueSpellDocumentTag(WebPageProxy*);
47     void closeSpellDocumentWithTag(uint64_t);
48     void checkSpellingOfString(uint64_t tag, const String& text, int32_t& misspellingLocation, int32_t& misspellingLength);
49     void checkGrammarOfString(uint64_t tag, const String& text, Vector<WebCore::GrammarDetail>&, int32_t& badGrammarLocation, int32_t& badGrammarLength);
50     bool spellingUIIsShowing();
51     void toggleSpellingUIIsShowing();
52     void updateSpellingUIWithMisspelledWord(uint64_t tag, const String& misspelledWord);
53     void updateSpellingUIWithGrammarString(uint64_t tag, const String& badGrammarPhrase, const WebCore::GrammarDetail&);
54     void guessesForWord(uint64_t tag, const String& word, Vector<String>& guesses);
55     void learnWord(uint64_t tag, const String& word);
56     void ignoreWord(uint64_t tag, const String& word);
57 };
58
59 } // namespace WebKit
60
61 #endif // WebTextCheckerClient_h