diff options
Diffstat (limited to 'chromium/chrome/common/spellcheck_messages.h')
| -rw-r--r-- | chromium/chrome/common/spellcheck_messages.h | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/chromium/chrome/common/spellcheck_messages.h b/chromium/chrome/common/spellcheck_messages.h new file mode 100644 index 00000000000..f4878acf458 --- /dev/null +++ b/chromium/chrome/common/spellcheck_messages.h @@ -0,0 +1,151 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// IPC messages for spellcheck. +// Multiply-included message file, hence no include guard. + +#include "chrome/common/spellcheck_bdict_language.h" +#include "chrome/common/spellcheck_marker.h" +#include "chrome/common/spellcheck_result.h" +#include "ipc/ipc_message_macros.h" +#include "ipc/ipc_platform_file.h" + +#if !defined(ENABLE_SPELLCHECK) +#error "Spellcheck should be enabled" +#endif + +#define IPC_MESSAGE_START SpellCheckMsgStart + +IPC_ENUM_TRAITS(SpellCheckResult::Decoration) + +IPC_STRUCT_TRAITS_BEGIN(SpellCheckResult) + IPC_STRUCT_TRAITS_MEMBER(decoration) + IPC_STRUCT_TRAITS_MEMBER(location) + IPC_STRUCT_TRAITS_MEMBER(length) + IPC_STRUCT_TRAITS_MEMBER(replacement) + IPC_STRUCT_TRAITS_MEMBER(hash) +IPC_STRUCT_TRAITS_END() + +IPC_STRUCT_TRAITS_BEGIN(SpellCheckMarker) + IPC_STRUCT_TRAITS_MEMBER(hash) + IPC_STRUCT_TRAITS_MEMBER(offset) +IPC_STRUCT_TRAITS_END() + +IPC_STRUCT_TRAITS_BEGIN(SpellCheckBDictLanguage) + IPC_STRUCT_TRAITS_MEMBER(file) + IPC_STRUCT_TRAITS_MEMBER(language) +IPC_STRUCT_TRAITS_END() + +// Messages sent from the browser to the renderer. + +IPC_MESSAGE_CONTROL1(SpellCheckMsg_EnableSpellCheck, + bool) + +// Passes some initialization params from the browser to the renderer's +// spellchecker. This can be called directly after startup or in (async) +// response to a RequestDictionary ViewHost message. +IPC_MESSAGE_CONTROL3(SpellCheckMsg_Init, + std::vector<SpellCheckBDictLanguage> /* bdict_languages */, + std::set<std::string> /* custom_dict_words */, + bool /* auto spell correct */) + +// Words have been added and removed in the custom dictionary; update the local +// custom word list. +IPC_MESSAGE_CONTROL2(SpellCheckMsg_CustomDictionaryChanged, + std::set<std::string> /* words_added */, + std::set<std::string> /* words_removed */) + +// Toggle the auto spell correct functionality. +IPC_MESSAGE_CONTROL1(SpellCheckMsg_EnableAutoSpellCorrect, + bool /* enable */) + +// Request a list of all document markers in the renderer for spelling service +// feedback. +IPC_MESSAGE_CONTROL0(SpellCheckMsg_RequestDocumentMarkers) + +// Send a list of document markers in the renderer to the spelling service +// feedback sender. +IPC_MESSAGE_CONTROL1(SpellCheckHostMsg_RespondDocumentMarkers, + std::vector<uint32> /* document marker identifiers */) + +#if !defined(USE_BROWSER_SPELLCHECKER) +// Sends text-check results from the Spelling service when the service finishes +// checking text received by a SpellCheckHostMsg_CallSpellingService message. +// If the service is not available, the 4th parameter should be false and the +// 5th parameter should contain the requested sentence. +IPC_MESSAGE_ROUTED4(SpellCheckMsg_RespondSpellingService, + int /* request identifier given by WebKit */, + bool /* succeeded calling service */, + base::string16 /* sentence */, + std::vector<SpellCheckResult>) +#endif + +#if defined(USE_BROWSER_SPELLCHECKER) +// This message tells the renderer to advance to the next misspelling. It is +// sent when the user clicks the "Find Next" button on the spelling panel. +IPC_MESSAGE_ROUTED0(SpellCheckMsg_AdvanceToNextMisspelling) + +// Sends when NSSpellChecker finishes checking text received by a preceding +// SpellCheckHostMsg_RequestTextCheck message. +IPC_MESSAGE_ROUTED3(SpellCheckMsg_RespondTextCheck, + int /* request identifier given by WebKit */, + base::string16 /* sentence */, + std::vector<SpellCheckResult>) + +IPC_MESSAGE_ROUTED1(SpellCheckMsg_ToggleSpellPanel, + bool) +#endif + +// Messages sent from the renderer to the browser. + +// The renderer has tried to spell check a word, but couldn't because no +// dictionary was available to load. Request that the browser find an +// appropriate dictionary and return it. +IPC_MESSAGE_CONTROL0(SpellCheckHostMsg_RequestDictionary) + +// Tracks spell checking occurrence to collect histogram. +IPC_MESSAGE_ROUTED2(SpellCheckHostMsg_NotifyChecked, + base::string16 /* word */, + bool /* true if checked word is misspelled */) + +#if !defined(USE_BROWSER_SPELLCHECKER) +// Asks the Spelling service to check text. When the service finishes checking +// the input text, it sends a SpellingCheckMsg_RespondSpellingService with +// text-check results. +IPC_MESSAGE_CONTROL4(SpellCheckHostMsg_CallSpellingService, + int /* route_id for response */, + int /* request identifier given by WebKit */, + base::string16 /* sentence */, + std::vector<SpellCheckMarker> /* markers */) +#endif + +#if defined(USE_BROWSER_SPELLCHECKER) +// Tells the browser to display or not display the SpellingPanel +IPC_MESSAGE_ROUTED1(SpellCheckHostMsg_ShowSpellingPanel, + bool /* if true, then show it, otherwise hide it*/) + +// Tells the browser to update the spelling panel with the given word. +IPC_MESSAGE_ROUTED1(SpellCheckHostMsg_UpdateSpellingPanelWithMisspelledWord, + base::string16 /* the word to update the panel with */) + +// TODO(groby): This needs to originate from SpellcheckProvider. +IPC_SYNC_MESSAGE_CONTROL2_1(SpellCheckHostMsg_CheckSpelling, + base::string16 /* word */, + int /* route_id */, + bool /* correct */) + +IPC_SYNC_MESSAGE_CONTROL1_1(SpellCheckHostMsg_FillSuggestionList, + base::string16 /* word */, + std::vector<base::string16> /* suggestions */) + +IPC_MESSAGE_CONTROL4(SpellCheckHostMsg_RequestTextCheck, + int /* route_id for response */, + int /* request identifier given by WebKit */, + base::string16 /* sentence */, + std::vector<SpellCheckMarker> /* markers */) + +IPC_MESSAGE_ROUTED2(SpellCheckHostMsg_ToggleSpellCheck, + bool /* enabled */, + bool /* checked */) +#endif // USE_BROWSER_SPELLCHECKER |