Home | History | Annotate | Download | only in web 
      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 "../platform/WebString.h"
     35 #include "../platform/WebVector.h"
     36 #include "WebTextCheckingType.h"
     37 
     38 namespace WebKit {
     39 
     40 class WebString;
     41 class WebTextCheckingCompletion;
     42 struct WebTextCheckingResult;
     43 
     44 class WebSpellCheckClient {
     45 public:
     46     // The client should perform spell-checking on the given text. If the
     47     // text contains a misspelled word, then upon return misspelledOffset
     48     // will point to the start of the misspelled word, and misspelledLength
     49     // will indicates its length. Otherwise, if there was not a spelling
     50     // error, then upon return misspelledLength is 0. If optional_suggestions
     51     // is given, then it will be filled with suggested words (not a cheap step).
     52     virtual void spellCheck(const WebString& text,
     53                             int& misspelledOffset,
     54                             int& misspelledLength,
     55                             WebVector<WebString>* optionalSuggestions) { }
     56 
     57     // The client should perform spell-checking on the given text. This function will
     58     // enumerate all misspellings at once.
     59     virtual void checkTextOfParagraph(const WebString&,
     60                                       WebTextCheckingTypeMask mask,
     61                                       WebVector<WebTextCheckingResult>* results) { }
     62 
     63     // Requests asynchronous spelling and grammar checking, whose result should be
     64     // returned by passed completion object.
     65     virtual void requestCheckingOfText(const WebString& textToCheck,
     66                                        const WebVector<uint32_t>& markersInText,
     67                                        const WebVector<unsigned>& markerOffsets,
     68                                        WebTextCheckingCompletion* completionCallback) { }
     69 
     70     // Computes an auto-corrected replacement for a misspelled word. If no
     71     // replacement is found, then an empty string is returned.
     72     virtual WebString autoCorrectWord(const WebString& misspelledWord) { return WebString(); }
     73 
     74     // Show or hide the spelling UI.
     75     virtual void showSpellingUI(bool show) { }
     76 
     77     // Returns true if the spelling UI is showing.
     78     virtual bool isShowingSpellingUI() { return false; }
     79 
     80     // Update the spelling UI with the given word.
     81     virtual void updateSpellingUIWithMisspelledWord(const WebString& word) { }
     82 
     83 protected:
     84     ~WebSpellCheckClient() { }
     85 };
     86 
     87 } // namespace WebKit
     88 
     89 #endif
     90