ui/app_list/speech_ui_model.h

   1 // Copyright 2013 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_SPEECH_UI_MODEL_H_
   6 #define UI_APP_LIST_SPEECH_UI_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/app_list/speech_ui_model_observer.h"
  13 #include "ui/gfx/image/image_skia.h"
  14
  15 namespace app_list {
  16
  17 // SpeechUIModel provides the interface to update the UI for speech recognition.
  18 class APP_LIST_EXPORT SpeechUIModel {
  19  public:
  20   // Construct the model, initially in state SPEECH_RECOGNITION_OFF.
  21   SpeechUIModel();
  22   virtual ~SpeechUIModel();
  23
  24   void SetSpeechResult(const base::string16& result, bool is_final);
  25   void UpdateSoundLevel(int16 level);
  26   // Sets the speech recognition state. If |always_show_ui| is true,
  27   // sends the state change to the UI observers regardless of whether
  28   // the |new_state| is different from the old one.
  29   void SetSpeechRecognitionState(SpeechRecognitionState new_state,
  30                                  bool always_show_ui);
  31
  32   void AddObserver(SpeechUIModelObserver* observer);
  33   void RemoveObserver(SpeechUIModelObserver* observer);
  34
  35   const base::string16& result() const { return result_; }
  36   bool is_final() const { return is_final_; }
  37   int16 sound_level() const { return sound_level_; }
  38   SpeechRecognitionState state() const { return state_; }
  39   const gfx::ImageSkia& logo() const { return logo_; }
  40   void set_logo(const gfx::ImageSkia& logo) { logo_ = logo; }
  41
  42  private:
  43   base::string16 result_;
  44   bool is_final_;
  45   int16 sound_level_;
  46   SpeechRecognitionState state_;
  47
  48   // The logo image which the speech UI will show at the top-left.
  49   gfx::ImageSkia logo_;
  50
  51   // The sound level range to compute visible sound-level.
  52   int16 minimum_sound_level_;
  53   int16 maximum_sound_level_;
  54
  55   base::ObserverList<SpeechUIModelObserver> observers_;
  56
  57   DISALLOW_COPY_AND_ASSIGN(SpeechUIModel);
  58 };
  59
  60 }  // namespace app_list
  61
  62 #endif  // UI_APP_LIST_SPEECH_UI_MODEL_H_