ui/app_list/search_box_model.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_APP_LIST_SEARCH_BOX_MODEL_H_
   6 #define UI_APP_LIST_SEARCH_BOX_MODEL_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/observer_list.h"
  10 #include "base/strings/string16.h"
  11 #include "ui/app_list/app_list_export.h"
  12 #include "ui/gfx/image/image_skia.h"
  13 #include "ui/gfx/selection_model.h"
  14
  15 namespace app_list {
  16
  17 class SearchBoxModelObserver;
  18
  19 // SearchBoxModel consisits of an icon, a hint text, a user text and a selection
  20 // model. The icon is rendered to the side of the query editor. The hint text
  21 // is used as query edit control's placeholder text and displayed when there is
  22 // no user text in the control. The selection model and the text represents the
  23 // text, cursor position and selected text in edit control.
  24 class APP_LIST_EXPORT SearchBoxModel {
  25  public:
  26   // The properties of the button.
  27   struct APP_LIST_EXPORT ButtonProperty {
  28     ButtonProperty(const gfx::ImageSkia& icon, const base::string16& tooltip);
  29     ~ButtonProperty();
  30
  31     gfx::ImageSkia icon;
  32     base::string16 tooltip;
  33   };
  34
  35   SearchBoxModel();
  36   ~SearchBoxModel();
  37
  38   // Sets/gets the icon on the left side of edit box.
  39   void SetIcon(const gfx::ImageSkia& icon);
  40   const gfx::ImageSkia& icon() const { return icon_; }
  41
  42   // Sets/gets the properties for the button of speech recognition.
  43   void SetSpeechRecognitionButton(scoped_ptr<ButtonProperty> speech_button);
  44   const ButtonProperty* speech_button() const { return speech_button_.get(); }
  45
  46   // Sets/gets the hint text to display when there is in input.
  47   void SetHintText(const base::string16& hint_text);
  48   const base::string16& hint_text() const { return hint_text_; }
  49
  50   // Sets/gets the selection model for the search box's Textfield.
  51   void SetSelectionModel(const gfx::SelectionModel& sel);
  52   const gfx::SelectionModel& selection_model() const {
  53     return selection_model_;
  54   }
  55
  56   // Sets/gets the text for the search box's Textfield.
  57   void SetText(const base::string16& text);
  58   const base::string16& text() const { return text_; }
  59
  60   void AddObserver(SearchBoxModelObserver* observer);
  61   void RemoveObserver(SearchBoxModelObserver* observer);
  62
  63  private:
  64   gfx::ImageSkia icon_;
  65   scoped_ptr<ButtonProperty> speech_button_;
  66   base::string16 hint_text_;
  67   gfx::SelectionModel selection_model_;
  68   base::string16 text_;
  69
  70   ObserverList<SearchBoxModelObserver> observers_;
  71
  72   DISALLOW_COPY_AND_ASSIGN(SearchBoxModel);
  73 };
  74
  75 }  // namespace app_list
  76
  77 #endif  // UI_APP_LIST_SEARCH_BOX_MODEL_H_