Instant API: tell page whether the browser is capturing key strokes.

chrome/browser/ui/omnibox/omnibox_edit_model.h

 // Copyright 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.
 
 #ifndef CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_
 #define CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/string16.h"
 #include "base/time.h"
 #include "chrome/browser/autocomplete/autocomplete_controller_delegate.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
+#include "chrome/common/instant_types.h"
 #include "chrome/common/metrics/proto/omnibox_event.pb.h"
 #include "content/public/common/page_transition_types.h"
 #include "googleurl/src/gurl.h"
 #include "ui/gfx/native_widget_types.h"
 #include "webkit/glue/window_open_disposition.h"
 
 class AutocompleteController;
 class AutocompleteResult;
 struct InstantSuggestion;
 class OmniboxEditController;
@@ skipping 185 matching lines @@
   // Returns the current autocomplete result.  This logic should in the future
   // live in AutocompleteController but resides here for now.  This method is
   // used by AutomationProvider::AutocompleteEditGetMatches.
   const AutocompleteResult& result() const;
 
   // Called when the view is gaining focus.  |control_down| is whether the
   // control key is down (at the time we're gaining focus).
   void OnSetFocus(bool control_down);
 
   // Sets the visibility of the caret in the omnibox, if it has focus. The
-  // visibility of the caret is reset to visible if any of the following
-  // happens:
-  // - User starts typing in the omnibox
-  // - User clicks in the omnibox
-  // - Omnibox loses and then regains focus
-  // - SetFocus() is explicitly called again
+  // visibility of the caret is reset to visible if either
+  //   - The user starts typing, or
+  //   - We explicitly focus the omnibox again.
+  // The latter case must be handled in three separate places--OnSetFocus(),
+  // OmniboxView::SetFocus(), and the mouse handlers in OmniboxView. See
+  // accompanying comments for why each of these is necessary.
+  //
   // Caret visibility is tracked per-tab and updates automatically upon
   // switching tabs.
   void SetCaretVisibility(bool visible);
 
   // Sent before |OnKillFocus| and before the popup is closed.
   void OnWillKillFocus(gfx::NativeView view_gaining_focus);
 
   // Called when the view is losing focus.  Resets some state.
   void OnKillFocus();
 
@@ skipping 164 matching lines @@
   // current page is the user's home page.
   metrics::OmniboxEventProto::PageClassification ClassifyPage(
       const GURL& gurl) const;
 
   // Sets |match| and |alternate_nav_url| based on classifying |text|.
   // |alternate_nav_url| may be NULL.
   void ClassifyStringForPasteAndGo(const string16& text,
                                    AutocompleteMatch* match,
                                    GURL* alternate_nav_url) const;
 
+  // Helper for SetCaretVisibility. |reason| is the reason for change that is
+  // passed down to InstantController when we notify it of focus state changes.

[Peter Kasting, 2012/12/07 23:22:03]

Nit: How about:

Actually changes the current caret visibility.  When the new visibility doesn't
match the old, we notify the InstantController about the change and pass
|reason| to it.

[samarth, 2012/12/08 00:55:47]

Done.

+  void SetCaretVisibilityInternal(bool visible,
+                                  OmniboxFocusChangeReason reason);
+
   scoped_ptr<AutocompleteController> autocomplete_controller_;
 
   OmniboxView* view_;
 
   OmniboxPopupModel* popup_;
 
   OmniboxEditController* controller_;
 
   // Whether the edit has focus.
   bool has_focus_;
@@ skipping 101 matching lines @@
   // an exact keyword match.  If this is true then keyword mode will be
   // triggered automatically if the input is "<keyword> <search string>".  We
   // allow this when CreatedKeywordSearchByInsertingSpaceInMiddle() is true.
   // This has no effect if we're already in keyword mode.
   bool allow_exact_keyword_match_;
 
   DISALLOW_COPY_AND_ASSIGN(OmniboxEditModel);
 };
 
 #endif  // CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_