1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 // This file defines the interface class OmniboxView. Each toolkit will
6 // implement the edit view differently, so that code is inherently platform
7 // specific. However, the OmniboxEditModel needs to do some communication with
8 // the view. Since the model is shared between platforms, we need to define an
9 // interface that all view implementations will share.
11 #ifndef CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_H_
12 #define CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_H_
16 #include "base/strings/string16.h"
17 #include "base/strings/string_util.h"
18 #include "base/strings/utf_string_conversions.h"
19 #include "chrome/browser/autocomplete/autocomplete_match.h"
20 #include "chrome/browser/ui/omnibox/omnibox_edit_model.h"
21 #include "content/public/common/url_constants.h"
22 #include "ui/base/window_open_disposition.h"
23 #include "ui/gfx/native_widget_types.h"
27 class OmniboxEditController;
28 class OmniboxViewMacTest;
36 #if defined(TOOLKIT_VIEWS)
37 // TODO(beng): Move all views-related code to a views-specific sub-interface.
47 class DropTargetEvent;
53 virtual ~OmniboxView();
55 // Used by the automation system for getting at the model from the view.
56 OmniboxEditModel* model() { return model_.get(); }
57 const OmniboxEditModel* model() const { return model_.get(); }
59 CommandUpdater* command_updater() { return command_updater_; }
60 const CommandUpdater* command_updater() const { return command_updater_; }
62 // For use when switching tabs, this saves the current state onto the tab so
63 // that it can be restored during a later call to Update().
64 virtual void SaveStateToTab(content::WebContents* tab) = 0;
66 // Called when the window's active tab changes.
67 virtual void OnTabChanged(const content::WebContents* web_contents) = 0;
69 // Called when any relevant state changes other than changing tabs.
70 virtual void Update() = 0;
72 // Asks the browser to load the specified match's |destination_url|, which
73 // is assumed to be one of the popup entries, using the supplied disposition
74 // and transition type. |alternate_nav_url|, if non-empty, contains the
75 // alternate navigation URL for for this match. See comments on
76 // AutocompleteResult::GetAlternateNavURL().
78 // |selected_line| is passed to SendOpenNotification(); see comments there.
80 // This may close the popup.
81 virtual void OpenMatch(const AutocompleteMatch& match,
82 WindowOpenDisposition disposition,
83 const GURL& alternate_nav_url,
84 size_t selected_line);
86 // Returns the current text of the edit control, which could be the
87 // "temporary" text set by the popup, the "permanent" text set by the
88 // browser, or just whatever the user has currently typed.
89 virtual string16 GetText() const = 0;
91 // |true| if the user is in the process of editing the field, or if
92 // the field is empty.
93 bool IsEditingOrEmpty() const;
95 // Returns the resource ID of the icon to show for the current text.
98 // The user text is the text the user has manually keyed in. When present,
99 // this is shown in preference to the permanent text; hitting escape will
100 // revert to the permanent text.
101 void SetUserText(const string16& text);
102 virtual void SetUserText(const string16& text,
103 const string16& display_text,
106 // Sets the window text and the caret position. |notify_text_changed| is true
107 // if the model should be notified of the change.
108 virtual void SetWindowTextAndCaretPos(const string16& text,
111 bool notify_text_changed) = 0;
113 // Sets the edit to forced query mode. Practically speaking, this means that
114 // if the edit is not in forced query mode, its text is set to "?" with the
115 // cursor at the end, and if the edit is in forced query mode (its first
116 // non-whitespace character is '?'), the text after the '?' is selected.
118 // In the future we should display the search engine UI for the default engine
120 virtual void SetForcedQuery() = 0;
122 // Returns true if all text is selected or there is no text at all.
123 virtual bool IsSelectAll() const = 0;
125 // Returns true if the user deleted the suggested text.
126 virtual bool DeleteAtEndPressed() = 0;
128 // Fills |start| and |end| with the indexes of the current selection's bounds.
129 // It is not guaranteed that |*start < *end|, as the selection can be
130 // directed. If there is no selection, |start| and |end| will both be equal
131 // to the current cursor position.
132 virtual void GetSelectionBounds(size_t* start, size_t* end) const = 0;
134 // Selects all the text in the edit. Use this in place of SetSelAll() to
135 // avoid selecting the "phantom newline" at the end of the edit.
136 virtual void SelectAll(bool reversed) = 0;
138 // Re-enables search term replacement on the ToolbarModel, and reverts the
139 // edit and popup back to their unedited state (permanent text showing, popup
140 // closed, no user input in progress).
141 virtual void RevertAll();
143 // Like RevertAll(), but does not touch the search term replacement state.
144 void RevertWithoutResettingSearchTermReplacement();
146 // Updates the autocomplete popup and other state after the text has been
147 // changed by the user.
148 virtual void UpdatePopup() = 0;
150 // Closes the autocomplete popup, if it's open. The name |ClosePopup|
151 // conflicts with the OSX class override as that has a base class that also
152 // defines a method with that name.
153 virtual void CloseOmniboxPopup();
155 // Sets the focus to the autocomplete view.
156 virtual void SetFocus() = 0;
158 // Shows or hides the caret based on whether the model's is_caret_visible() is
160 virtual void ApplyCaretVisibility() = 0;
162 // Called when the temporary text in the model may have changed.
163 // |display_text| is the new text to show; |save_original_selection| is true
164 // when there wasn't previously a temporary text and thus we need to save off
165 // the user's existing selection. |notify_text_changed| is true if the model
166 // should be notified of the change.
167 virtual void OnTemporaryTextMaybeChanged(const string16& display_text,
168 bool save_original_selection,
169 bool notify_text_changed) = 0;
171 // Called when the inline autocomplete text in the model may have changed.
172 // |display_text| is the new text to show; |user_text_length| is the length of
173 // the user input portion of that (so, up to but not including the inline
174 // autocompletion). Returns whether the display text actually changed.
175 virtual bool OnInlineAutocompleteTextMaybeChanged(
176 const string16& display_text, size_t user_text_length) = 0;
178 // Called when the temporary text has been reverted by the user. This will
179 // reset the user's original selection.
180 virtual void OnRevertTemporaryText() = 0;
182 // Checkpoints the current edit state before an operation that might trigger
183 // a new autocomplete run to open or modify the popup. Call this before
184 // user-initiated edit actions that trigger autocomplete, but *not* for
185 // automatic changes to the textfield that should not affect autocomplete.
186 virtual void OnBeforePossibleChange() = 0;
187 // OnAfterPossibleChange() returns true if there was a change that caused it
188 // to call UpdatePopup().
189 virtual bool OnAfterPossibleChange() = 0;
191 // Returns the gfx::NativeView of the edit view.
192 virtual gfx::NativeView GetNativeView() const = 0;
194 // Gets the relative window for the pop up window of OmniboxPopupView. The pop
195 // up window will be shown under the relative window. When an IME is attached
196 // to the rich edit control, the IME window is the relative window. Otherwise,
197 // the top-most window is the relative window.
198 virtual gfx::NativeView GetRelativeWindowForPopup() const = 0;
200 // Shows |input| as gray suggested text after what the user has typed.
201 virtual void SetGrayTextAutocompletion(const string16& input) = 0;
203 // Returns the current gray suggested text.
204 virtual string16 GetGrayTextAutocompletion() const = 0;
206 // Returns the width in pixels needed to display the current text. The
207 // returned value includes margins.
208 virtual int TextWidth() const = 0;
210 // Returns true if the user is composing something in an IME.
211 virtual bool IsImeComposing() const = 0;
213 // Returns true if we know for sure that an IME is showing a popup window,
214 // which may overlap the omnibox's popup window.
215 virtual bool IsImeShowingPopup() const;
217 // Returns true if the view is displaying UI that indicates that query
218 // refinement will take place when the user selects the current match. For
219 // search matches, this will cause the omnibox to search over the existing
220 // corpus (e.g. Images) rather than start a new Web search. This method will
221 // only ever return true on mobile ports.
222 virtual bool IsIndicatingQueryRefinement() const;
224 #if defined(TOOLKIT_VIEWS)
225 virtual int GetMaxEditWidth(int entry_width) const = 0;
227 // Adds the autocomplete edit view to view hierarchy and
228 // returns the views::View of the edit view.
229 virtual views::View* AddToView(views::View* parent) = 0;
231 // Performs the drop of a drag and drop operation on the view.
232 virtual int OnPerformDrop(const ui::DropTargetEvent& event) = 0;
235 // Returns |text| with any leading javascript schemas stripped.
236 static string16 StripJavascriptSchemas(const string16& text);
238 // First, calls StripJavascriptSchemas(). Then automatically collapses
239 // internal whitespace as follows:
240 // * If the only whitespace in |text| is newlines, users are most likely
241 // pasting in URLs split into multiple lines by terminals, email programs,
242 // etc. So all newlines are removed.
243 // * Otherwise, users may be pasting in search data, e.g. street addresses. In
244 // this case, runs of whitespace are collapsed down to single spaces.
245 static string16 SanitizeTextForPaste(const string16& text);
247 // Returns the current clipboard contents as a string that can be pasted in.
248 // In addition to just getting CF_UNICODETEXT out, this can also extract URLs
249 // from bookmarks on the clipboard.
250 static string16 GetClipboardText();
253 OmniboxView(Profile* profile,
254 OmniboxEditController* controller,
255 CommandUpdater* command_updater);
257 // Internally invoked whenever the text changes in some way.
258 virtual void TextChanged();
260 // Disables search term replacement, reverts the omnibox, and selects all.
263 // Return the number of characters in the current buffer. The name
264 // |GetTextLength| can't be used as the Windows override of this class
265 // inherits from a class that defines a method with that name.
266 virtual int GetOmniboxTextLength() const = 0;
268 // Try to parse the current text as a URL and colorize the components.
269 virtual void EmphasizeURLComponents() = 0;
271 OmniboxEditController* controller() { return controller_; }
272 const OmniboxEditController* controller() const { return controller_; }
275 friend class OmniboxViewMacTest;
276 FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, ShowURL);
278 // |model_| can be NULL in tests.
279 scoped_ptr<OmniboxEditModel> model_;
280 OmniboxEditController* controller_;
282 // The object that handles additional command functionality exposed on the
283 // edit, such as invoking the keyword editor.
284 CommandUpdater* command_updater_;
287 #endif // CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_VIEW_H_