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 HandleFocusIn() because when clicking while the
+  // omnibox has invisible focus does not trigger a new HandleFocusIn() 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
     // into view and shift the contents jarringly.
     SelectAll(true);
   }
   select_all_on_mouse_release_ = false;
 }
 
 void OmniboxViewViews::HandleFocusIn() {
+  // Restore caret visibility whenever the user focuses back into the omnibox.
+  model()->SetCaretVisibility(true);

[Peter Kasting, 2012/12/04 22:55:49]

Now that we've moved this to a function that unconditionally calls the model's
OnSetFocus() function, I think this can in fact be moved to that function, which
is a cross-platform place to do it.

[samarth, 2012/12/04 23:13:32]

Done.

   // TODO(oshima): Get control key state.
   model()->OnSetFocus(false);
   // Don't call controller()->OnSetFocus as this view has already
   // acquired the focus.
 }
 
 void OmniboxViewViews::HandleFocusOut() {
   gfx::NativeView native_view = NULL;
 #if defined(USE_AURA)
   views::Widget* widget = GetWidget();
   if (widget) {
     aura::client::FocusClient* client =
         aura::client::GetFocusClient(widget->GetNativeView());
     if (client)
       native_view = client->GetFocusedWindow();
   }
 #endif
   model()->OnWillKillFocus(native_view);
   // Close the popup.
   CloseOmniboxPopup();
   // Tell the model to reset itself.
+  model()->SetCaretVisibility(true);

[Peter Kasting, 2012/12/04 22:55:49]

Why is this necessary if we set this on HandleFocusIn() (or OnSetFocus())?

[samarth, 2012/12/04 23:13:32]

We'd added it out of paranoia before, but not necessary anymore.

   model()->OnKillFocus();
   controller()->OnKillFocus();
 }
 
 void OmniboxViewViews::SetLocationEntryFocusable(bool focusable) {
   textfield_->set_focusable(focusable);
 }
 
 bool OmniboxViewViews::IsLocationEntryFocusableInRootView() const {
   return textfield_->IsFocusable();
@@ skipping 19 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 112 matching lines @@
       sel.GetMax() < GetTextLength() || textfield_->IsIMEComposing();
 
   model()->StartAutocomplete(!sel.is_empty(), no_inline_autocomplete);
 }
 
 void OmniboxViewViews::SetFocus() {
   // 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 33 matching lines @@
 
   // When the user has deleted text, we don't allow inline autocomplete.  Make
   // sure to not flag cases like selecting part of the text and then pasting
   // (or typing) the prefix of that selection.  (We detect these by making
   // sure the caret, which should be after any insertion, hasn't moved
   // forward of the old selection start.)
   const bool just_deleted_text =
       (text_before_change_.length() > new_text.length()) &&
       (new_sel.start() <= sel_before_change_.GetMin());
 
+  // Restore caret visibility whenever the user enters text or changes selection
+  // in the omnibox.

[Peter Kasting, 2012/12/04 22:55:49]

I was hoping to put this in the model's OnAfterPossibleChange function, since
that's a cross-platform place to do it.

[samarth, 2012/12/04 23:13:32]

Done.

+  if (text_changed || selection_differs)
+    model()->SetCaretVisibility(true);
+
   const bool something_changed = model()->OnAfterPossibleChange(
       text_before_change_, new_text, new_sel.start(), new_sel.end(),
       selection_differs, text_changed, just_deleted_text,
       !textfield_->IsIMEComposing());
 
   // If only selection was changed, we don't need to call model()'s
   // OnChanged() method, which is called in TextChanged().
   // But we still need to call EmphasizeURLComponents() to make sure the text
   // attributes are updated correctly.
   if (something_changed && text_changed)
@@ skipping 290 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);
   }
 }