Add setVoiceSearchSupported to the searchbox API. This will be used to determine whether to show a …

chrome/browser/ui/search/instant_page.h

 // Copyright 2013 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_SEARCH_INSTANT_PAGE_H_
 #define CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_
 
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/strings/string16.h"
+#include "chrome/browser/ui/search/search_model_observer.h"
 #include "chrome/common/instant_types.h"
 #include "chrome/common/omnibox_focus_state.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/common/page_transition_types.h"
 
 class GURL;
 
 namespace content {
 struct FrameNavigateParams;
 struct LoadCommittedDetails;
 class WebContents;
 }
 
 namespace gfx {
 class Rect;
 }
 
 // InstantPage is used to exchange messages with a page that implements the
 // Instant/Embedded Search API (http://dev.chromium.org/embeddedsearch).
 // InstantPage is not used directly but via one of its derived classes:
 // InstantOverlay, InstantNTP and InstantTab.
-class InstantPage : public content::WebContentsObserver {
+class InstantPage : public content::WebContentsObserver,
+                    public SearchModelObserver {
  public:
   // InstantPage calls its delegate in response to messages received from the
   // page. Each method is called with the |contents| corresponding to the page
   // we are observing.
   class Delegate {
    public:
     // Called when a RenderView is created, so that state can be initialized.
     virtual void InstantPageRenderViewCreated(
         const content::WebContents* contents) = 0;
 
@@ skipping 10 matching lines @@
     virtual void InstantPageAboutToNavigateMainFrame(
         const content::WebContents* contents,
         const GURL& url) = 0;
 
     // Called when the page has suggestions. Usually in response to Update(),
     // SendAutocompleteResults() or UpOrDownKeyPressed().
     virtual void SetSuggestions(
         const content::WebContents* contents,
         const std::vector<InstantSuggestion>& suggestions) = 0;
 
+    // Called upon determination of whether the page supports voice search.
+    virtual void SetVoiceSearchSupported(const content::WebContents* contents,
+                                         bool supported) = 0;
+
     // Called when the page wants to be shown. Usually in response to Update()
     // or SendAutocompleteResults().
     virtual void ShowInstantOverlay(const content::WebContents* contents,
                                     int height,
                                     InstantSizeUnits units) = 0;
 
     // Called when the page shows suggestions for logging purposes, regardless
     // of whether the page is processing the call.
     virtual void LogDropdownShown() = 0;
 
@@ skipping 121 matching lines @@
   // Tells the page about new Most Visited data.
   void SendMostVisitedItems(
       const std::vector<InstantMostVisitedItem>& items);
 
   // Tells the page to toggle voice search.
   void ToggleVoiceSearch();
 
  protected:
   InstantPage(Delegate* delegate, const std::string& instant_url);
 
-  // Sets |contents| as the page to communicate with. |contents| may be NULL,
-  // which effectively stops all communication.
-  void SetContents(content::WebContents* contents);
+  // Sets |web_contents| as the page to communicate with. |web_contents| may be
+  // NULL, which effectively stops all communication.
+  void SetContents(content::WebContents* web_contents);
 
   Delegate* delegate() const { return delegate_; }
 
   // These functions are called before processing messages received from the
   // page. By default, all messages are handled, but any derived classes may
   // choose to ignore some or all of the received messages by overriding these
   // methods.
   virtual bool ShouldProcessRenderViewCreated();
   virtual bool ShouldProcessRenderViewGone();
   virtual bool ShouldProcessAboutToNavigateMainFrame();
   virtual bool ShouldProcessSetSuggestions();
+  virtual bool ShouldProcessSetVoiceSearchSupported();
   virtual bool ShouldProcessShowInstantOverlay();
   virtual bool ShouldProcessFocusOmnibox();
   virtual bool ShouldProcessNavigateToURL();
   virtual bool ShouldProcessDeleteMostVisitedItem();
   virtual bool ShouldProcessUndoMostVisitedDeletion();
   virtual bool ShouldProcessUndoAllMostVisitedDeletions();
 
  private:
   FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
                            DispatchRequestToDeleteMostVisitedItem);
@@ skipping 25 matching lines @@
   virtual void DidNavigateMainFrame(
       const content::LoadCommittedDetails& details,
       const content::FrameNavigateParams& params) OVERRIDE;
   virtual void DidFailProvisionalLoad(
       int64 frame_id,
       bool is_main_frame,
       const GURL& validated_url,
       int error_code,
       const string16& error_description,
       content::RenderViewHost* render_view_host) OVERRIDE;
+  // Overridden from SearchModelObserver:
+  virtual void ModelChanged(const SearchModel::State& old_state,
+                            const SearchModel::State& new_state) OVERRIDE;
+
+  // Helper to look up the SearchModel for this page.
+  SearchModel* GetSearchModel();
 
   void OnSetSuggestions(int page_id,
                         const std::vector<InstantSuggestion>& suggestions);
+  void OnSetVoiceSearchSupported(int page_id, bool supported);
   void OnInstantSupportDetermined(int page_id, bool supports_instant);
   void OnShowInstantOverlay(int page_id,
                             int height,
                             InstantSizeUnits units);
   void OnFocusOmnibox(int page_id, OmniboxFocusState state);
   void OnSearchBoxNavigate(int page_id,
                            const GURL& url,
                            content::PageTransition transition,
                            WindowOpenDisposition disposition,
                            bool is_search_type);
   void OnDeleteMostVisitedItem(int page_id, const GURL& url);
   void OnUndoMostVisitedDeletion(int page_id, const GURL& url);
   void OnUndoAllMostVisitedDeletions(int page_id);
 
   Delegate* const delegate_;
   const std::string instant_url_;
   bool supports_instant_;
   bool instant_support_determined_;
 
   DISALLOW_COPY_AND_ASSIGN(InstantPage);
 };
 
 #endif  // CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_