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
34namespace API {
35template<> struct ClientTraits<WKTextCheckerClientBase> {
36 typedef std::tuple<WKTextCheckerClientV0> Versions;
37};
38}
39
40namespace WebKit {
41
42class WebPageProxy;
43
44class WebTextCheckerClient : public API::Client<WKTextCheckerClientBase> {
45public:
46 bool continuousSpellCheckingAllowed();
47 bool continuousSpellCheckingEnabled();
48 void setContinuousSpellCheckingEnabled(bool);
49 bool grammarCheckingEnabled();
50 void setGrammarCheckingEnabled(bool);
51 uint64_t uniqueSpellDocumentTag(WebPageProxy*);
52 void closeSpellDocumentWithTag(uint64_t);
53 void checkSpellingOfString(uint64_t tag, const String& text, int32_t& misspellingLocation, int32_t& misspellingLength);
54 void checkGrammarOfString(uint64_t tag, const String& text, Vector<WebCore::GrammarDetail>&, int32_t& badGrammarLocation, int32_t& badGrammarLength);
55 bool spellingUIIsShowing();
56 void toggleSpellingUIIsShowing();
57 void updateSpellingUIWithMisspelledWord(uint64_t tag, const String& misspelledWord);
58 void updateSpellingUIWithGrammarString(uint64_t tag, const String& badGrammarPhrase, const WebCore::GrammarDetail&);
59 void guessesForWord(uint64_t tag, const String& word, Vector<String>& guesses);
60 void learnWord(uint64_t tag, const String& word);
61 void ignoreWord(uint64_t tag, const String& word);
62};
63
64} // namespace WebKit
65
66#endif // WebTextCheckerClient_h
67