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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
// Copyright 2013 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 COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_CLIENT_H_
#define COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_CLIENT_H_
#include <memory>
#include "components/omnibox/browser/autocomplete_provider_client.h"
#include "components/omnibox/browser/omnibox_navigation_observer.h"
#include "components/omnibox/common/omnibox_focus_state.h"
#include "ui/base/window_open_disposition.h"
class AutocompleteResult;
class GURL;
class SessionID;
class TemplateURL;
class TemplateURLService;
struct AutocompleteMatch;
struct OmniboxLog;
namespace bookmarks {
class BookmarkModel;
}
namespace gfx {
class Image;
}
using BitmapFetchedCallback =
base::RepeatingCallback<void(int result_index, const SkBitmap& bitmap)>;
using FaviconFetchedCallback =
base::OnceCallback<void(const gfx::Image& favicon)>;
// Interface that allows the omnibox component to interact with its embedder
// (e.g., getting information about the current page, retrieving objects
// associated with the current tab, or performing operations that rely on such
// objects under the hood).
class OmniboxClient {
public:
virtual ~OmniboxClient() {}
// Returns an AutocompleteProviderClient specific to the embedder context.
virtual std::unique_ptr<AutocompleteProviderClient>
CreateAutocompleteProviderClient() = 0;
// Returns an OmniboxNavigationObserver specific to the embedder context. May
// return null if the embedder has no need to observe omnibox navigations.
virtual std::unique_ptr<OmniboxNavigationObserver>
CreateOmniboxNavigationObserver(const base::string16& text,
const AutocompleteMatch& match,
const AutocompleteMatch& alternate_nav_match);
// Returns whether there is any associated current page. For example, during
// startup or shutdown, the omnibox may exist but have no attached page.
virtual bool CurrentPageExists() const;
// Returns the URL of the current page.
virtual const GURL& GetURL() const;
// Returns the title of the current page.
virtual const base::string16& GetTitle() const;
// Returns the favicon of the current page.
virtual gfx::Image GetFavicon() const;
// Returns true if the current page is a New Tab Page rendered by Instant.
virtual bool IsInstantNTP() const;
// Returns true if the committed entry is a search results page.
virtual bool IsSearchResultsPage() const;
// Returns whether the current page is loading.
virtual bool IsLoading() const;
// Returns whether paste-and-go functionality is enabled.
virtual bool IsPasteAndGoEnabled() const;
// Returns whether |url| corresponds to the new tab page.
virtual bool IsNewTabPage(const GURL& url) const;
// Returns whether |url| corresponds to the user's home page.
virtual bool IsHomePage(const GURL& url) const;
// Returns false if Default Search is disabled by a policy.
virtual bool IsDefaultSearchProviderEnabled() const;
// Returns the session ID of the current page.
virtual const SessionID& GetSessionID() const = 0;
virtual bookmarks::BookmarkModel* GetBookmarkModel();
virtual TemplateURLService* GetTemplateURLService();
virtual const AutocompleteSchemeClassifier& GetSchemeClassifier() const = 0;
virtual AutocompleteClassifier* GetAutocompleteClassifier();
// Returns the icon corresponding to |match| if match is an extension match
// and an empty icon otherwise.
virtual gfx::Image GetIconIfExtensionMatch(
const AutocompleteMatch& match) const;
// Returns the given |vector_icon_type| with the correct size.
virtual gfx::Image GetSizedIcon(const gfx::VectorIcon& vector_icon_type,
SkColor vector_icon_color) const;
// Returns the given |icon| with the correct size.
virtual gfx::Image GetSizedIcon(const gfx::Image& icon) const;
// Checks whether |template_url| is an extension keyword; if so, asks the
// ExtensionOmniboxEventRouter to process |match| for it and returns true.
// Otherwise returns false. |observer| is the OmniboxNavigationObserver
// that was created by CreateOmniboxNavigationObserver() for |match|; in some
// embedding contexts, processing an extension keyword involves invoking
// action on this observer.
virtual bool ProcessExtensionKeyword(const TemplateURL* template_url,
const AutocompleteMatch& match,
WindowOpenDisposition disposition,
OmniboxNavigationObserver* observer);
// Called to notify clients that the omnibox input state has changed.
virtual void OnInputStateChanged() {}
// Called to notify clients that the omnibox focus state has changed.
virtual void OnFocusChanged(OmniboxFocusState state,
OmniboxFocusChangeReason reason) {}
// Called when the autocomplete result has changed. If the embedder supports
// fetching of bitmaps for URLs (not all embedders do), |on_bitmap_fetched|
// will be called when the bitmap has been fetched.
virtual void OnResultChanged(const AutocompleteResult& result,
bool default_match_changed,
const BitmapFetchedCallback& on_bitmap_fetched) {
}
// These two methods fetch favicons if the embedder supports it. Not all
// embedders do. These methods return the favicon synchronously if possible.
// Otherwise, they return an empty gfx::Image and |on_favicon_fetched| may or
// may not be called asynchronously later. |on_favicon_fetched| will never be
// run synchronously, and will never be run with an empty result.
virtual gfx::Image GetFaviconForPageUrl(
const GURL& page_url,
FaviconFetchedCallback on_favicon_fetched);
virtual gfx::Image GetFaviconForDefaultSearchProvider(
FaviconFetchedCallback on_favicon_fetched);
// Called when the current autocomplete match has changed.
virtual void OnCurrentMatchChanged(const AutocompleteMatch& match) {}
// Called when the text may have changed in the edit.
virtual void OnTextChanged(const AutocompleteMatch& current_match,
bool user_input_in_progress,
const base::string16& user_text,
const AutocompleteResult& result,
bool has_focus) {}
// Called when input has been accepted.
virtual void OnInputAccepted(const AutocompleteMatch& match) {}
// Called when the edit model is being reverted back to its unedited state.
virtual void OnRevert() {}
// Called to notify clients that a URL was opened from the omnibox.
virtual void OnURLOpenedFromOmnibox(OmniboxLog* log) {}
// Called when a bookmark is launched from the omnibox.
virtual void OnBookmarkLaunched() {}
// Discards the state for all pending and transient navigations.
virtual void DiscardNonCommittedNavigations() {}
};
#endif // COMPONENTS_OMNIBOX_BROWSER_OMNIBOX_CLIENT_H_
|
