Adds the speech recognition button to the app-list searchbox.

ui/app_list/search_box_model.h

 // 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.
 
 #ifndef UI_APP_LIST_SEARCH_BOX_MODEL_H_
 #define UI_APP_LIST_SEARCH_BOX_MODEL_H_
 
 #include "base/basictypes.h"
 #include "base/observer_list.h"
 #include "base/strings/string16.h"
 #include "ui/app_list/app_list_export.h"
 #include "ui/gfx/image/image_skia.h"
 #include "ui/gfx/selection_model.h"
 
 namespace app_list {
 
 class SearchBoxModelObserver;
 
 // SearchBoxModel consisits of an icon, a hint text, a user text and a selection
 // model. The icon is rendered to the side of the query editor. The hint text
 // is used as query edit control's placeholder text and displayed when there is
 // no user text in the control. The selection model and the text represents the
 // text, cursor position and selected text in edit control.
 class APP_LIST_EXPORT SearchBoxModel {
  public:
+  // The properties of the button on the right side of edit box.
+  struct RightButtonProperty {

[xiyuan, 2013/11/12 03:09:25]

nit: Can we use a more specific name? RightButton is vague. Prefer to call this
ToggleButtonProperty and call the RightButton instance below (in SetRightButton
etc) as VoiceRecogButton or something along the line. 

[Jun Mukai, 2013/11/12 19:24:09]

Done.

+    gfx::ImageSkia icon;
+    gfx::ImageSkia toggled_icon;
+    base::string16 tooltip;
+    base::string16 toggled_tooltip;
+
+    RightButtonProperty(const gfx::ImageSkia& icon,
+                        const gfx::ImageSkia& toggled_icon,
+                        const base::string16& tooltip,
+                        const base::string16& toggled_tooltip);
+    ~RightButtonProperty();

[xiyuan, 2013/11/12 03:09:25]

nit: Move ctor and dtor before the member variables.

[Jun Mukai, 2013/11/12 19:24:09]

Done.

+  };
+
   SearchBoxModel();
   ~SearchBoxModel();
 
-  // Sets/gets the icon on side of edit box.
+  // Sets/gets the icon on the left side of edit box.
   void SetIcon(const gfx::ImageSkia& icon);
   const gfx::ImageSkia& icon() const { return icon_; }
 
+  // Sets/gets the properties for the button on the right side of edit box.
+  void SetRightButton(scoped_ptr<RightButtonProperty> right_button_prop);
+  const RightButtonProperty* right_button() const {
+    return right_button_prop_.get();
+  }
+
+  // Sets the right button state.
+  void SetRightButtonState(bool toggled);
+
   // Sets/gets the hint text to display when there is in input.
   void SetHintText(const base::string16& hint_text);
   const base::string16& hint_text() const { return hint_text_; }
 
   // Sets/gets the selection model for the search box's Textfield.
   void SetSelectionModel(const gfx::SelectionModel& sel);
   const gfx::SelectionModel& selection_model() const {
     return selection_model_;
   }
 
   // Sets/gets the text for the search box's Textfield.
   void SetText(const base::string16& text);
   const base::string16& text() const { return text_; }
 
   void AddObserver(SearchBoxModelObserver* observer);
   void RemoveObserver(SearchBoxModelObserver* observer);
 
  private:
   gfx::ImageSkia icon_;
+  scoped_ptr<RightButtonProperty> right_button_prop_;
   base::string16 hint_text_;
   gfx::SelectionModel selection_model_;
   base::string16 text_;
 
   ObserverList<SearchBoxModelObserver> observers_;
 
   DISALLOW_COPY_AND_ASSIGN(SearchBoxModel);
 };
 
 }  // namespace app_list
 
 #endif  // UI_APP_LIST_SEARCH_BOX_MODEL_H_