Implement {Start,Stop}CapturingKeyStrokes for Instant.

chrome/browser/ui/views/omnibox/omnibox_view_views.cc

 // 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.
 
 #include "chrome/browser/ui/views/omnibox/omnibox_view_views.h"
 
 #include "base/logging.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/app/chrome_command_ids.h"
@@ skipping 206 matching lines @@
                                    bool popup_window_mode,
                                    LocationBarView* location_bar)
     : OmniboxView(profile, controller, toolbar_model, command_updater),
       textfield_(NULL),
       popup_window_mode_(popup_window_mode),
       security_level_(ToolbarModel::NONE),
       ime_composing_before_change_(false),
       delete_at_end_pressed_(false),
       location_bar_view_(location_bar),
       ime_candidate_window_open_(false),
-      select_all_on_mouse_release_(false) {
+      select_all_on_mouse_release_(false),
+      visible_caret_color_(SK_ColorBLACK) {
 }
 
 OmniboxViewViews::~OmniboxViewViews() {
 #if defined(OS_CHROMEOS)
   chromeos::input_method::InputMethodManager::GetInstance()->
       RemoveCandidateWindowObserver(this);
 #endif
 
   // Explicitly teardown members which have a reference to us.  Just to be safe
   // we want them to be destroyed before destroying any other internal state.
@@ skipping 123 matching lines @@
     model()->OnControlKeyChanged(false);
     return true;
   }
   return false;
 }
 
 void OmniboxViewViews::HandleMousePressEvent(const ui::MouseEvent& event) {
   select_all_on_mouse_release_ =
       (event.IsOnlyLeftMouseButton() || event.IsOnlyRightMouseButton()) &&
       !textfield_->HasFocus();
+  // Restore caret visibility whenever the user clicks in the the omnibox. This
+  // is not always covered by OnSetFocus() because when clicking while the
+  // omnibox has invisible focus does not trigger a new OnSetFocus() call.
+  model()->SetCaretVisibility(true);
 }
 
 void OmniboxViewViews::HandleMouseDragEvent(const ui::MouseEvent& event) {
   select_all_on_mouse_release_ = false;
 }
 
 void OmniboxViewViews::HandleMouseReleaseEvent(const ui::MouseEvent& event) {
   if ((event.IsOnlyLeftMouseButton() || event.IsOnlyRightMouseButton()) &&
       select_all_on_mouse_release_) {
     // Select all in the reverse direction so as not to scroll the caret
@@ skipping 57 matching lines @@
 std::string OmniboxViewViews::GetClassName() const {
   return kViewClassName;
 }
 
 void OmniboxViewViews::OnBoundsChanged(const gfx::Rect& previous_bounds) {
   if (popup_view_->IsOpen())
     popup_view_->UpdatePopupAppearance();
 }
 
 ////////////////////////////////////////////////////////////////////////////////
-// OmniboxViewViews, AutocopmleteEditView implementation:
+// OmniboxViewViews, OmniboxView implementation:
 
 void OmniboxViewViews::SaveStateToTab(WebContents* tab) {
   DCHECK(tab);
 
   // We don't want to keep the IME status, so force quit the current
   // session here.  It may affect the selection status, so order is
   // also important.
   if (textfield_->IsIMEComposing()) {
     textfield_->GetTextInputClient()->ConfirmCompositionText();
     textfield_->GetInputMethod()->CancelComposition(textfield_);
@@ skipping 108 matching lines @@
   // the text, or in the middle of composition.
   ui::Range sel;
   textfield_->GetSelectedRange(&sel);
   bool no_inline_autocomplete =
       sel.GetMax() < GetTextLength() || textfield_->IsIMEComposing();
 
   model()->StartAutocomplete(!sel.is_empty(), no_inline_autocomplete);
 }
 
 void OmniboxViewViews::SetFocus() {
+  // Restore caret visibility if focused explicitly.

[Peter Kasting, 2012/12/05 00:52:53]

Nit: Add: "We need to do this here because if we already have invisible focus,
the RequestFocus() call below will short-circuit, preventing us from reaching
OmniboxEditModel::OnSetFocus(), which handles restoring visibility when we
didn't previously have focus."

...assuming I got the rationale correct.

Although... is this SetFocus() call called in a superset of the cases where
OnSetFocus() is reached?  Because if so, putting the call in there doesn't
actually buy us anything, so we could take it back out (and then update the
comment above to explain this).

[samarth, 2012/12/05 01:15:51]

Yes, exactly; updated comment.
Unfortunately no--either can happen independently.  For example, if you tab into
the omnibox, OnSetFocus will be called but not SetFocus.  If the omnibox has
invisible focus and you open a second tab, SetFocus will be called but not
OnSetFocus.

+  model()->SetCaretVisibility(true);
   // In views-implementation, the focus is on textfield rather than OmniboxView.
   textfield_->RequestFocus();
 }
 
+void OmniboxViewViews::ApplyCaretVisibility() {
+  if (textfield_->cursor_color() != textfield_->background_color())
+    visible_caret_color_ = textfield_->cursor_color();
+  // Setting the color of the text cursor (caret) to the background color
+  // effectively hides it.
+  textfield_->SetCursorColor(model()->is_caret_visible() ?
+      visible_caret_color_ : textfield_->background_color());
+}
+
 void OmniboxViewViews::OnTemporaryTextMaybeChanged(
     const string16& display_text,
     bool save_original_selection) {
   if (save_original_selection)
     textfield_->GetSelectedRange(&saved_temporary_selection_);
 
   SetWindowTextAndCaretPos(display_text, display_text.length(), false, true);
 }
 
 bool OmniboxViewViews::OnInlineAutocompleteTextMaybeChanged(
@@ skipping 343 matching lines @@
   if (!text.empty()) {
     // Record this paste, so we can do different behavior.
     model()->on_paste();
     // Force a Paste operation to trigger the text_changed code in
     // OnAfterPossibleChange(), even if identical contents are pasted into the
     // text box.
     text_before_change_.clear();
     textfield_->ReplaceSelection(text);
   }
 }