[Search] Implementation of the invisible focus on Windows

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 200 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, AutocompleteEditView 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 19 matching lines @@
 
   // TODO(oshima): Copied from gtk implementation which is
   // slightly different from WIN impl. Find out the correct implementation
   // for views-implementation.
   if (contents) {
     RevertAll();
     const AutocompleteEditState* state = static_cast<AutocompleteEditState*>(
         contents->GetUserData(&kAutocompleteEditStateKey));
     if (state) {
       model()->RestoreState(state->model_state);
+      ApplyFocusVisibility();
 
       // Move the marks for the cursor and the other end of the selection to
       // the previously-saved offsets (but preserve PRIMARY).
       textfield_->SelectSelectionModel(state->view_state.selection_model);
       // We do not carry over the current edit history to another tab.
       // TODO(oshima): consider saving/restoring edit history.
       textfield_->ClearEditHistory();
     }
   } else if (visibly_changed_permanent_text) {
     RevertAll();
@@ skipping 69 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() {
+  model()->set_is_focus_visible(true);
+  ApplyFocusVisibility();
   // In views-implementation, the focus is on textfield rather than OmniboxView.
   textfield_->RequestFocus();
 }
+
+void OmniboxViewViews::SetInvisibleFocus() {
+  DLOG(0) << "SetInvisibleFocus";

[Peter Kasting, 2012/12/01 01:48:31]

Don't check this in.

[Mathieu, 2012/12/03 02:29:04]

Done.

+  model()->set_is_focus_visible(false);
+  ApplyFocusVisibility();
+  // In views-implementation, the focus is on textfield rather than OmniboxView.
+  textfield_->RequestFocus();
+}
 
 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(
     const string16& display_text,
     size_t user_text_length) {
   if (display_text == GetText())
     return false;
   ui::Range range(display_text.size(), user_text_length);
   SetTextAndSelectedRange(display_text, range);
   TextChanged();
   return true;
 }
 
 void OmniboxViewViews::OnRevertTemporaryText() {
   textfield_->SelectRange(saved_temporary_selection_);
   TextChanged();
 }
 
 void OmniboxViewViews::OnBeforePossibleChange() {
+  // Since this is called when the user directly clicks on the omnibox
+  // regardless of its focus state, we reset the focus to visible.

[Peter Kasting, 2012/12/01 01:48:31]

This is an odd place to put this comment.  Clicks on the omnibox don't reach
here immediately/directly (unless some IME work changed that), this is instead
called when we're going to change something.  If you want focus visibility reset
when the user clicks, put it in the click handler.

[Mathieu, 2012/12/03 02:29:04]

The comment wasn't explicit enough, my bad. We also use this location in the
call sequence to restore the visibility of the caret when a user enters
something in the omnibox. I thought this would kill two birds with one stone.
What do you think? I've modified the comment to account for both cases.

+  model()->set_is_focus_visible(true);
+  ApplyFocusVisibility();
   // Record our state.
   text_before_change_ = GetText();
   textfield_->GetSelectedRange(&sel_before_change_);
   ime_composing_before_change_ = textfield_->IsIMEComposing();
 }
 
 bool OmniboxViewViews::OnAfterPossibleChange() {
   ui::Range new_sel;
   textfield_->GetSelectedRange(&new_sel);
 
@@ skipping 317 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);
   }
 }
+
+void OmniboxViewViews::ApplyFocusVisibility() {
+  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_focus_visible() ?
+      visible_caret_color_ : textfield_->background_color());
+}