1/*
2 * Copyright (C) 2010 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 WebSpellCheckClient_h
32#define WebSpellCheckClient_h
33
34#include "WebString.h"
35#include "WebVector.h"
36
37namespace WebKit {
38
39class WebString;
40class WebTextCheckingCompletion;
41
42class WebSpellCheckClient {
43public:
44    // The client should perform spell-checking on the given text. If the
45    // text contains a misspelled word, then upon return misspelledOffset
46    // will point to the start of the misspelled word, and misspelledLength
47    // will indicates its length. Otherwise, if there was not a spelling
48    // error, then upon return misspelledLength is 0. If optional_suggestions
49    // is given, then it will be filled with suggested words (not a cheap step).
50    virtual void spellCheck(const WebString& text,
51                            int& misspelledOffset,
52                            int& misspelledLength,
53                            WebVector<WebString>* optionalSuggestions) { }
54    // Requests asynchronous spelling and grammar checking, whose result should be
55    // returned by passed completion object.
56    virtual void requestCheckingOfText(const WebString&, WebTextCheckingCompletion*) { }
57
58    // Computes an auto-corrected replacement for a misspelled word. If no
59    // replacement is found, then an empty string is returned.
60    virtual WebString autoCorrectWord(const WebString& misspelledWord) { return WebString(); }
61
62    // Show or hide the spelling UI.
63    virtual void showSpellingUI(bool show) { }
64
65    // Returns true if the spelling UI is showing.
66    virtual bool isShowingSpellingUI() { return false; }
67
68    // Update the spelling UI with the given word.
69    virtual void updateSpellingUIWithMisspelledWord(const WebString& word) { }
70
71protected:
72    ~WebSpellCheckClient() { }
73};
74
75} // namespace WebKit
76
77#endif
78