ui/app_list/search_result.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_RESULT_H_
   6 #define UI_APP_LIST_SEARCH_RESULT_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/observer_list.h"
  13 #include "base/strings/string16.h"
  14 #include "ui/app_list/app_list_export.h"
  15 #include "ui/gfx/image/image_skia.h"
  16 #include "ui/gfx/range/range.h"
  17
  18 namespace ui {
  19 class MenuModel;
  20 }
  21
  22 namespace app_list {
  23
  24 class SearchResultObserver;
  25
  26 // SearchResult consists of an icon, title text and details text. Title and
  27 // details text can have tagged ranges that are displayed differently from
  28 // default style.
  29 class APP_LIST_EXPORT SearchResult {
  30  public:
  31   // How the result should be displayed.
  32   enum DisplayType {
  33     DISPLAY_LIST,
  34     DISPLAY_TILE,
  35     DISPLAY_RECOMMENDATION,
  36     DISPLAY_NONE,
  37   };
  38
  39   // A tagged range in search result text.
  40   struct APP_LIST_EXPORT Tag {
  41     // Similar to ACMatchClassification::Style, the style values are not
  42     // mutually exclusive.
  43     enum Style {
  44       NONE  = 0,
  45       URL   = 1 << 0,
  46       MATCH = 1 << 1,
  47       DIM   = 1 << 2,
  48     };
  49
  50     Tag(int styles, size_t start, size_t end)
  51         : styles(styles),
  52           range(start, end) {
  53     }
  54
  55     int styles;
  56     gfx::Range range;
  57   };
  58   typedef std::vector<Tag> Tags;
  59
  60   // Data representing an action that can be performed on this search result.
  61   // An action could be represented as an icon set or as a blue button with
  62   // a label. Icon set is chosen if label text is empty. Otherwise, a blue
  63   // button with the label text will be used.
  64   struct APP_LIST_EXPORT Action {
  65     Action(const gfx::ImageSkia& base_image,
  66            const gfx::ImageSkia& hover_image,
  67            const gfx::ImageSkia& pressed_image,
  68            const base::string16& tooltip_text);
  69     Action(const base::string16& label_text,
  70            const base::string16& tooltip_text);
  71     ~Action();
  72
  73     gfx::ImageSkia base_image;
  74     gfx::ImageSkia hover_image;
  75     gfx::ImageSkia pressed_image;
  76
  77     base::string16 tooltip_text;
  78     base::string16 label_text;
  79   };
  80   typedef std::vector<Action> Actions;
  81
  82   SearchResult();
  83   virtual ~SearchResult();
  84
  85   const gfx::ImageSkia& icon() const { return icon_; }
  86   void SetIcon(const gfx::ImageSkia& icon);
  87
  88   const base::string16& title() const { return title_; }
  89   void set_title(const base::string16& title) { title_ = title;}
  90
  91   const Tags& title_tags() const { return title_tags_; }
  92   void set_title_tags(const Tags& tags) { title_tags_ = tags; }
  93
  94   const base::string16& details() const { return details_; }
  95   void set_details(const base::string16& details) { details_ = details; }
  96
  97   const Tags& details_tags() const { return details_tags_; }
  98   void set_details_tags(const Tags& tags) { details_tags_ = tags; }
  99
 100   const std::string& id() const { return id_; }
 101   double relevance() const { return relevance_; }
 102   DisplayType display_type() const { return display_type_; }
 103
 104   const Actions& actions() const {
 105     return actions_;
 106   }
 107   void SetActions(const Actions& sets);
 108
 109   // Whether the result can be automatically selected by a voice query.
 110   // (Non-voice results can still appear in the results list to be manually
 111   // selected.)
 112   bool voice_result() const { return voice_result_; }
 113
 114   bool is_installing() const { return is_installing_; }
 115   void SetIsInstalling(bool is_installing);
 116
 117   int percent_downloaded() const { return percent_downloaded_; }
 118   void SetPercentDownloaded(int percent_downloaded);
 119
 120   // Returns the dimension at which this result's icon should be displayed.
 121   int GetPreferredIconDimension() const;
 122
 123   void NotifyItemInstalled();
 124
 125   void AddObserver(SearchResultObserver* observer);
 126   void RemoveObserver(SearchResultObserver* observer);
 127
 128   // TODO(mukai): Remove this method and really simplify the ownership of
 129   // SearchResult. Ideally, SearchResult will be copyable.
 130   virtual scoped_ptr<SearchResult> Duplicate() = 0;
 131
 132   // Opens the result.
 133   virtual void Open(int event_flags);
 134
 135   // Invokes a custom action on the result. It does nothing by default.
 136   virtual void InvokeAction(int action_index, int event_flags);
 137
 138   // Returns the context menu model for this item, or NULL if there is currently
 139   // no menu for the item (e.g. during install).
 140   // Note the returned menu model is owned by this item.
 141   virtual ui::MenuModel* GetContextMenuModel();
 142
 143  protected:
 144   void set_id(const std::string& id) { id_ = id; }
 145   void set_relevance(double relevance) { relevance_ = relevance; }
 146   void set_display_type(DisplayType display_type) {
 147     display_type_ = display_type;
 148   }
 149   void set_voice_result(bool voice_result) { voice_result_ = voice_result; }
 150
 151  private:
 152   gfx::ImageSkia icon_;
 153
 154   base::string16 title_;
 155   Tags title_tags_;
 156
 157   base::string16 details_;
 158   Tags details_tags_;
 159
 160   std::string id_;
 161   double relevance_;
 162   DisplayType display_type_;
 163
 164   Actions actions_;
 165   bool voice_result_;
 166
 167   bool is_installing_;
 168   int percent_downloaded_;
 169
 170   ObserverList<SearchResultObserver> observers_;
 171
 172   DISALLOW_COPY_AND_ASSIGN(SearchResult);
 173 };
 174
 175 }  // namespace app_list
 176
 177 #endif  // UI_APP_LIST_SEARCH_RESULT_H_