12bde8e466a4451c7319e3a072d118917957d6554Steve Block/* 22bde8e466a4451c7319e3a072d118917957d6554Steve Block * Copyright (C) 2010 Google Inc. All rights reserved. 32bde8e466a4451c7319e3a072d118917957d6554Steve Block * 42bde8e466a4451c7319e3a072d118917957d6554Steve Block * Redistribution and use in source and binary forms, with or without 52bde8e466a4451c7319e3a072d118917957d6554Steve Block * modification, are permitted provided that the following conditions are 62bde8e466a4451c7319e3a072d118917957d6554Steve Block * met: 72bde8e466a4451c7319e3a072d118917957d6554Steve Block * 82bde8e466a4451c7319e3a072d118917957d6554Steve Block * * Redistributions of source code must retain the above copyright 92bde8e466a4451c7319e3a072d118917957d6554Steve Block * notice, this list of conditions and the following disclaimer. 102bde8e466a4451c7319e3a072d118917957d6554Steve Block * * Redistributions in binary form must reproduce the above 112bde8e466a4451c7319e3a072d118917957d6554Steve Block * copyright notice, this list of conditions and the following disclaimer 122bde8e466a4451c7319e3a072d118917957d6554Steve Block * in the documentation and/or other materials provided with the 132bde8e466a4451c7319e3a072d118917957d6554Steve Block * distribution. 142bde8e466a4451c7319e3a072d118917957d6554Steve Block * * Neither the name of Google Inc. nor the names of its 152bde8e466a4451c7319e3a072d118917957d6554Steve Block * contributors may be used to endorse or promote products derived from 162bde8e466a4451c7319e3a072d118917957d6554Steve Block * this software without specific prior written permission. 172bde8e466a4451c7319e3a072d118917957d6554Steve Block * 182bde8e466a4451c7319e3a072d118917957d6554Steve Block * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 192bde8e466a4451c7319e3a072d118917957d6554Steve Block * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 202bde8e466a4451c7319e3a072d118917957d6554Steve Block * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 212bde8e466a4451c7319e3a072d118917957d6554Steve Block * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 222bde8e466a4451c7319e3a072d118917957d6554Steve Block * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 232bde8e466a4451c7319e3a072d118917957d6554Steve Block * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 242bde8e466a4451c7319e3a072d118917957d6554Steve Block * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 252bde8e466a4451c7319e3a072d118917957d6554Steve Block * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 262bde8e466a4451c7319e3a072d118917957d6554Steve Block * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 272bde8e466a4451c7319e3a072d118917957d6554Steve Block * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 282bde8e466a4451c7319e3a072d118917957d6554Steve Block * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 292bde8e466a4451c7319e3a072d118917957d6554Steve Block */ 302bde8e466a4451c7319e3a072d118917957d6554Steve Block 312bde8e466a4451c7319e3a072d118917957d6554Steve Block#ifndef WebSpellCheckClient_h 322bde8e466a4451c7319e3a072d118917957d6554Steve Block#define WebSpellCheckClient_h 332bde8e466a4451c7319e3a072d118917957d6554Steve Block 342bde8e466a4451c7319e3a072d118917957d6554Steve Block#include "WebString.h" 352daae5fd11344eaa88a0d92b0f6d65f8d2255c00Ben Murdoch#include "WebVector.h" 362bde8e466a4451c7319e3a072d118917957d6554Steve Block 372bde8e466a4451c7319e3a072d118917957d6554Steve Blocknamespace WebKit { 382bde8e466a4451c7319e3a072d118917957d6554Steve Block 392bde8e466a4451c7319e3a072d118917957d6554Steve Blockclass WebString; 402bde8e466a4451c7319e3a072d118917957d6554Steve Blockclass WebTextCheckingCompletion; 412bde8e466a4451c7319e3a072d118917957d6554Steve Block 422bde8e466a4451c7319e3a072d118917957d6554Steve Blockclass WebSpellCheckClient { 432bde8e466a4451c7319e3a072d118917957d6554Steve Blockpublic: 442bde8e466a4451c7319e3a072d118917957d6554Steve Block // The client should perform spell-checking on the given text. If the 452bde8e466a4451c7319e3a072d118917957d6554Steve Block // text contains a misspelled word, then upon return misspelledOffset 462bde8e466a4451c7319e3a072d118917957d6554Steve Block // will point to the start of the misspelled word, and misspelledLength 472bde8e466a4451c7319e3a072d118917957d6554Steve Block // will indicates its length. Otherwise, if there was not a spelling 482daae5fd11344eaa88a0d92b0f6d65f8d2255c00Ben Murdoch // error, then upon return misspelledLength is 0. If optional_suggestions 492daae5fd11344eaa88a0d92b0f6d65f8d2255c00Ben Murdoch // is given, then it will be filled with suggested words (not a cheap step). 502daae5fd11344eaa88a0d92b0f6d65f8d2255c00Ben Murdoch virtual void spellCheck(const WebString& text, 512daae5fd11344eaa88a0d92b0f6d65f8d2255c00Ben Murdoch int& misspelledOffset, 522daae5fd11344eaa88a0d92b0f6d65f8d2255c00Ben Murdoch int& misspelledLength, 532daae5fd11344eaa88a0d92b0f6d65f8d2255c00Ben Murdoch WebVector<WebString>* optionalSuggestions) { } 542bde8e466a4451c7319e3a072d118917957d6554Steve Block // Requests asynchronous spelling and grammar checking, whose result should be 552bde8e466a4451c7319e3a072d118917957d6554Steve Block // returned by passed completion object. 562bde8e466a4451c7319e3a072d118917957d6554Steve Block virtual void requestCheckingOfText(const WebString&, WebTextCheckingCompletion*) { } 572bde8e466a4451c7319e3a072d118917957d6554Steve Block 582bde8e466a4451c7319e3a072d118917957d6554Steve Block // Computes an auto-corrected replacement for a misspelled word. If no 592bde8e466a4451c7319e3a072d118917957d6554Steve Block // replacement is found, then an empty string is returned. 602bde8e466a4451c7319e3a072d118917957d6554Steve Block virtual WebString autoCorrectWord(const WebString& misspelledWord) { return WebString(); } 612bde8e466a4451c7319e3a072d118917957d6554Steve Block 622bde8e466a4451c7319e3a072d118917957d6554Steve Block // Show or hide the spelling UI. 632bde8e466a4451c7319e3a072d118917957d6554Steve Block virtual void showSpellingUI(bool show) { } 642bde8e466a4451c7319e3a072d118917957d6554Steve Block 652bde8e466a4451c7319e3a072d118917957d6554Steve Block // Returns true if the spelling UI is showing. 662bde8e466a4451c7319e3a072d118917957d6554Steve Block virtual bool isShowingSpellingUI() { return false; } 672bde8e466a4451c7319e3a072d118917957d6554Steve Block 682bde8e466a4451c7319e3a072d118917957d6554Steve Block // Update the spelling UI with the given word. 692bde8e466a4451c7319e3a072d118917957d6554Steve Block virtual void updateSpellingUIWithMisspelledWord(const WebString& word) { } 702bde8e466a4451c7319e3a072d118917957d6554Steve Block 712bde8e466a4451c7319e3a072d118917957d6554Steve Blockprotected: 722bde8e466a4451c7319e3a072d118917957d6554Steve Block ~WebSpellCheckClient() { } 732bde8e466a4451c7319e3a072d118917957d6554Steve Block}; 742bde8e466a4451c7319e3a072d118917957d6554Steve Block 752bde8e466a4451c7319e3a072d118917957d6554Steve Block} // namespace WebKit 762bde8e466a4451c7319e3a072d118917957d6554Steve Block 772bde8e466a4451c7319e3a072d118917957d6554Steve Block#endif 78