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

chrome/browser/instant/instant_controller.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_INSTANT_INSTANT_CONTROLLER_H_
 #define CHROME_BROWSER_INSTANT_INSTANT_CONTROLLER_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/string16.h"
 #include "base/time.h"
 #include "base/timer.h"
 #include "chrome/browser/instant/instant_commit_type.h"
 #include "chrome/browser/instant/instant_model.h"
+#include "chrome/browser/ui/omnibox/omnibox_types.h"
 #include "chrome/common/instant_types.h"
 #include "chrome/common/search_types.h"
 #include "content/public/common/page_transition_types.h"
 #include "googleurl/src/gurl.h"
 #include "ui/gfx/native_widget_types.h"
 #include "ui/gfx/rect.h"
 
 struct AutocompleteMatch;
 class AutocompleteProvider;
 class InstantLoader;
@@ skipping 47 matching lines @@
   // The preview WebContents. May be NULL. InstantController retains ownership.
   content::WebContents* GetPreviewContents() const;
 
   // Returns true if the Instant preview is showing a search results preview.
   bool IsPreviewingSearchResults() const;
 
   // If the preview is showing search results, commits the preview, calling
   // CommitInstant() on the browser, and returns true. Else, returns false.
   bool CommitIfPossible(InstantCommitType type);
 
-  // The omnibox has lost focus. Commit or discard the preview accordingly.
-  void OmniboxLostFocus(gfx::NativeView view_gaining_focus);
-
-  // The omnibox has gained focus. Preload the default search engine, in
-  // anticipation of the user typing a query.
-  void OmniboxGotFocus();
+  // Called to indicate that the omnibox focus state changed with the given
+  // |reason|. If |focus_state| is FOCUS_NONE, |view_gaining_focus| is set to
+  // the view gaining focus.
+  void OmniboxFocusChanged(OmniboxFocusState focus_state,
+                           OmniboxFocusChangeReason reason,
+                           gfx::NativeView view_gaining_focus);
 
   // The search mode in the active tab has changed. Pass the message down to
   // the loader which will notify the renderer. Create |instant_tab_| if the
   // |new_mode| reflects an Instant search results page.
   void SearchModeChanged(const chrome::search::Mode& old_mode,
                          const chrome::search::Mode& new_mode);
 
   // The user switched tabs. Hide the preview. Create |instant_tab_| if the
   // newly active tab is an Instant search results page.
   void ActiveTabChanged();
@@ skipping 43 matching lines @@
   void InstantLoaderRenderViewGone();
 
   // Invoked by InstantLoader when the instant page is about to navigate.
   void InstantLoaderAboutToNavigateMainFrame(const GURL& url);
 
  private:
   FRIEND_TEST_ALL_PREFIXES(InstantTest, OmniboxFocusLoadsInstant);
   FRIEND_TEST_ALL_PREFIXES(InstantTest, NonInstantSearchProvider);
   FRIEND_TEST_ALL_PREFIXES(InstantTest, InstantLoaderRefresh);
 
+  // Helper for OmniboxFocusChanged. Commit or discard the preview.
+  void OmniboxLostFocus(gfx::NativeView view_gaining_focus);
+
   // Creates a new loader if necessary, using the instant_url property of the
   // |template_url| (for example, if the Instant URL has changed since the last
   // time the loader was created). Returns false if the |template_url| doesn't
   // have a valid Instant URL; true otherwise.
   bool ResetLoader(const TemplateURL* template_url,
                    const content::WebContents* active_tab);
 
   // Ensures that the |loader_| uses the default Instant URL, recreating it if
   // necessary, and returns true. Returns false if the Instant URL could not be
   // determined or the active tab is NULL (browser is shutting down).
@@ skipping 70 matching lines @@
   // the user has typed.
   InstantSuggestion last_suggestion_;
 
   // See comments on the getter above.
   content::PageTransition last_transition_type_;
 
   // True if the last match passed to Update() was a search (versus a URL).
   // Used to ensure that the preview page is committable.
   bool last_match_was_search_;
 
-  // True if the omnibox is focused, false otherwise.
-  bool is_omnibox_focused_;
+  // Omnibox focus state.
+  OmniboxFocusState omnibox_focus_state_;
 
   // The search model mode for the active tab.
   chrome::search::Mode search_mode_;
 
   // Current omnibox bounds.
   gfx::Rect omnibox_bounds_;
 
   // Last bounds passed to the page.
   gfx::Rect last_omnibox_bounds_;
 
@@ skipping 24 matching lines @@
 
   // Whether to allow the preview to show search suggestions. In general, the
   // preview is allowed to show search suggestions whenever |search_mode_| is
   // MODE_SEARCH_SUGGESTIONS, except in those cases where this is false.
   bool allow_preview_to_show_search_suggestions_;
 
   DISALLOW_COPY_AND_ASSIGN(InstantController);
 };
 
 #endif  // CHROME_BROWSER_INSTANT_INSTANT_CONTROLLER_H_