blob: 7d41236202dfd26324f695093a6e11fa92c51f2c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
// 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.
#ifndef CHROME_BROWSER_TAB_CONTENTS_SPELLING_MENU_OBSERVER_H_
#define CHROME_BROWSER_TAB_CONTENTS_SPELLING_MENU_OBSERVER_H_
#include <vector>
#include "base/compiler_specific.h"
#include "base/memory/scoped_ptr.h"
#include "base/string16.h"
#include "base/timer.h"
#include "chrome/browser/tab_contents/render_view_context_menu_observer.h"
class RenderViewContextMenuProxy;
struct SpellCheckResult;
class SpellingServiceClient;
// An observer that listens to events from the RenderViewContextMenu class and
// shows suggestions from the Spelling ("do you mean") service to a context menu
// while we show it. This class implements two interfaces:
// * RenderViewContextMenuObserver
// This interface is used for adding a menu item and update it while showing.
// * net::URLFetcherDelegate
// This interface is used for sending a JSON_RPC request to the Spelling
// service and retrieving its response.
// These interfaces allow this class to make a JSON-RPC call to the Spelling
// service in the background and update the context menu while showing. The
// following snippet describes how to add this class to the observer list of the
// RenderViewContextMenu class.
//
// void RenderViewContextMenu::InitMenu() {
// spelling_menu_observer_.reset(new SpellingMenuObserver(this));
// if (spelling_menu_observer_.get())
// observers_.AddObserver(spelling_menu_observer.get());
// }
//
class SpellingMenuObserver : public RenderViewContextMenuObserver {
public:
explicit SpellingMenuObserver(RenderViewContextMenuProxy* proxy);
virtual ~SpellingMenuObserver();
// RenderViewContextMenuObserver implementation.
virtual void InitMenu(const content::ContextMenuParams& params) OVERRIDE;
virtual bool IsCommandIdSupported(int command_id) OVERRIDE;
virtual bool IsCommandIdChecked(int command_id) OVERRIDE;
virtual bool IsCommandIdEnabled(int command_id) OVERRIDE;
virtual void ExecuteCommand(int command_id) OVERRIDE;
// A callback function called when the Spelling service finishes checking a
// misspelled word.
void OnTextCheckComplete(
int tag,
bool success,
const string16& text,
const std::vector<SpellCheckResult>& results);
private:
// The callback function for base::RepeatingTimer<SpellingMenuClient>. This
// function updates the "loading..." animation in the context-menu item.
void OnAnimationTimerExpired();
// The interface to add a context-menu item and update it. This class uses
// this interface to avoid accesing context-menu items directly.
RenderViewContextMenuProxy* proxy_;
// Suggested words from the local spellchecker. If the spelling service
// returns a word in this list, we hide the context-menu item to prevent
// showing the same word twice.
std::vector<string16> suggestions_;
// The string used for animation until we receive a response from the Spelling
// service. The current animation just adds periods at the end of this string:
// 'Loading' -> 'Loading.' -> 'Loading..' -> 'Loading...' (-> 'Loading')
string16 loading_message_;
int loading_frame_;
// A flag represending whether a JSON-RPC call to the Spelling service
// finished successfully and its response had a suggestion not included in the
// ones provided by the local spellchecker. When this flag is true, we enable
// the context-menu item so users can choose it.
bool succeeded_;
// The misspelled word. When we choose the "Add to dictionary" item, we add
// this word to the custom-word dictionary.
string16 misspelled_word_;
// The string representing the result of this call. This string is a
// suggestion when this call finished successfully. Otherwise it is error
// text. Until we receive a response from the Spelling service, this string
// stores the input string. (Since the Spelling service sends only misspelled
// words, we replace these misspelled words in the input text with the
// suggested words to create suggestion text.
string16 result_;
// The URLFetcher object used for sending a JSON-RPC request.
scoped_ptr<SpellingServiceClient> client_;
// A timer used for loading animation.
base::RepeatingTimer<SpellingMenuObserver> animation_timer_;
// Flag indicating whether online spelling correction service is enabled. When
// this variable is true and we right-click a misspelled word, we send a
// JSON-RPC request to the service and retrieve suggestions.
bool integrate_spelling_service_;
DISALLOW_COPY_AND_ASSIGN(SpellingMenuObserver);
};
#endif // CHROME_BROWSER_TAB_CONTENTS_SPELLING_MENU_OBSERVER_H_
|
